bakervm 0.9.0

A virtual machine for building and running retro games
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

# bakerVM [![Crates.io][crate-image]][crate-link] [![Build Status][travis-image]][travis-link] [![Docs.rs][docs-image]][docs-link]
A virtual machine for building and running retro games

![The logo of the bakerVM][logo]

## Introduction

The bakerVM is a virtual machine that executes bakerVM bytecode.

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

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

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

![A screenshot of the bakerVM][screenshot]

## Installation

### Install sdl2

On Ubuntu:
```shell
sudo apt install libsdl2-dev
```

On macOS:
```shell
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:
```shell
cargo install bakervm
```
If you already installed an older version you have to *force* the installation:
```shell
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 --basm path/to/main.basm
```
`bakervm` is the VM itself. On startup it loads the stock image by default. But you can specify any bakerVM image:
```shell
bakervm path/to/my/image/game.img
```

[crate-image]: https://img.shields.io/crates/v/bakervm.svg
[crate-link]: https://crates.io/crates/bakervm
[travis-image]: https://travis-ci.org/bakervm/bakervm.svg?branch=master
[travis-link]: https://travis-ci.org/bakervm/bakervm
[docs-image]: https://docs.rs/bakervm/badge.svg
[docs-link]: https://docs.rs/bakervm
[screenshot]: https://raw.githubusercontent.com/bakervm/bakervm/master/screenshot.png
[logo]: https://raw.githubusercontent.com/bakervm/bakervm/master/logo.png
[msgpack]: http://msgpack.org