Rust Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bakervm
core
docs
examples
hudson
src
std
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
Cargo.lock
Cargo.toml
LICENSE
README.md
bak
hud
logo.png
rustfmt.toml
screenshot.png

README.md

bakerVM Crates.io Build Status Docs.rs dependency status

A virtual machine for building and running retro games

The logo of the bakerVM

Introduction

The bakerVM is a virtual machine that executes bakerVM bytecode.

A builder-like compiler backend for the vm can be found in core/image_builder.rs.

The executable images of the vm are encoded and decoded using MessagePack

NOTE THAT THIS SOFTWARE IS STILL UNDER HEAVY DEVELOPMENT AND IN NO WAY STABLE OR COMPLETE.

A screenshot of the bakerVM

Installation

Install sdl2

On Ubuntu:

sudo apt install libsdl2-dev

On macOS:

brew install sdl2

The toolchain doesn't support Windows yet

Install the toolchain

To get the newest version of the bakerVM toolchain, first you have to install Rust. The Project is currently tracking stable Rust. After you installed Rust and Cargo correctly, install the toolchain using the following command:

cargo install bakervm

If you already installed an older version you have to force the installation:

cargo install bakervm -f

After the installation, you should have the following binaries installed: bakervm and hudson.

hudson is the bakervm toolkit. It is currently only able to compile *.basm files.

hudson compile path/to/source.basm

bakervm is the VM itself. On startup it loads the stock image by default. But you can specify any bakerVM image:

bakervm path/to/my/image/game.img