WeeKit is a tiny toolkit for writing interactive applications in Rust.
Initially built to support Raspberry Pi and macOS, WeeKit wraps the OpenVG library in a Rust interface, adds higher-level drawing functions on that OpenVG base, and uses platform-specific C libraries and system calls to support interactive touch-, mouse-, and keyboard- based applications.
WeeKit is a side project, a work in progress, and a learning exercise in Rust, so you're likely to find it very incomplete. But feel free to join in the fun!
Copyright 2018 by the WeeKit Authors.
Released under the Apache 2.0 license.
WeeKit is tested with Rust 1.26.2.
The easiest way to get Rust is to install it with rustup.
On Raspberry Pi, WeeKit is developed with Raspbian Stretch Lite. We install it with NOOBS.
On Raspberry Pi, WeeKit requires clang and libjpeg-dev.
Install them with the following:
% sudo apt-get install clang libjpeg-dev -y
You may also need to install git and libssl_dev.
% sudo apt-get install git libssl_dev -y
We use rustup to install Rust.
curl https://sh.rustup.rs -sSf | sh source ~/.profile # sets path in the current shell
On Raspberry Pi, the touchscreen is assumed to be at /dev/input/touchscreen
and the keyboard at /dev/input/keyboard.
To map the 7" touchscreen, create the following file:
$ cat /etc/udev/rules.d/70-touchscreen-raspberrypi.rules
KERNEL=="event*",ATTRS{name}=="FT5406 memory based driver",SYMLINK+="input/touchscreen",MODE="0440"
To map the keyboard, create the following file:
$ cat /etc/udev/rules.d/80-keyboard.rules
KERNEL=="event*",ENV{ID_INPUT_KEYBOARD}=="?*",SYMLINK+="input/keyboard",MODE="0440"
After rebooting, you should find /dev/input/touchscreen and
/dev/input/keyboard.
To build with make, link Makefile.pi with ln -s Makefile.pi Makefile.
On Raspberry Pi, WeeKit applications are built as standalone binaries that include additional platform-specific C code that is built and linked into the application. Originally this code also included the main WeeKit event loop, but now that is fully written in Rust.
On macOS, WeeKit uses the AmanithVG SDK for OpenVG support. Download it into the third-party directory by running third-party/RUNME-MACOS.sh in third-party.
WeeKit on macOS also requires libjpeg.
We build it from source downloaded from the
Independent JPEG Group and currently use
jpegsrc.v9c.tar.gz, available in the files area.
To build with make, link Makefile.macOS with
ln -s Makefile.macOS Makefile.
On macOS, WeeKit applications are built as binaries to be placed in a macOS
application bundle. After the application binary is built (using cargo), a
script constructs the application bundle. Currently this is coordinated by
Makefile.macOS. cargo builds also compile platform-specific helper functions
in C and Objective-C that include a Cocoa main event loop. WeeKit applications
are called from this event loop using exposed functions with C linkage that call
functions of the WeeKit Application trait.
The examples directory contains a few examples. One of the more interesting ones is rocks, a simple Asteroids-style arcade game that runs on macOS and Raspberry Pi.
To build on macOS, make sure that you've made Makefile link to
Makefile.macOS, and then use make rocks to build the rocks application,
which you can then run from the command-line with open Rocks.app.
