Skip to main content

Setup

This guide will help you set up and run an example MCTK project. Follow the steps below in order:

1

Install Dependencies

Run the following command to install all necessary dependencies (Debian/Ubuntu):

sudo apt install -y --no-install-recommends \
    g++ \
    libc6-dev \
    libssl-dev \
    libwebkit2gtk-4.0-dev \
    build-essential \
    curl \
    wget \
    libgtk-3-dev \
    patchelf \
    librsvg2-dev \
    pkg-config
2

Install Sway

Install the Sway window manager. On Ubuntu, you can use the following command:

sudo apt install -y sway
3

Run Sway

Start Sway in another terminal or run it in the background using:

sway &
4

Set the WAYLAND_DISPLAY Variable

Set the WAYLAND_DISPLAY environment variable to wayland-1:

export WAYLAND_DISPLAY=wayland-1
5

Clone the Repository

Clone the MCTK repository from GitHub:

git clone https://github.com/mecha-org/mctk.git
6

Navigate to the Kitchen Example

Change your current directory to the examples/kitchen folder:

cd mctk/examples/kitchen
7

Run the Project

Use Cargo to run the example:

cargo run
8

Output

You will be greeted with the following application running in sway. Image