rustorio 0.0.2

The first game written _and played_ entirely in Rust. Not just do you play by writing Rust code, the rules of the game are enforced by the Rust compiler! If you can write the program so it compiles and doesn't panic, you win!
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

# Rustorio

The first game written _and played_ entirely in Rust. Not just do you play by
writing Rust code, the rules of the game are enforced by the Rust compiler! If
you can write the program so it compiles and doesn't panic, you win!

## How to play

1. Install [Rust](https://www.rust-lang.org/tools/install). Specifically it's
   important to have the entire rustup toolchain and cargo, all of which you get
   automatically by following the instructions in the link.
2. Install `rustorio` by running `cargo install rustorio`.
3. Set up a new Rustorio project by running `rustorio setup <path>`, where
   `<path>` is the directory you want to create the project in (defaults to
   '.').
4. Under `src/bin/tutorial/` you will find a tutorial save. You can start by
   playing that one.
5. To play other game modes, run `rustorio new-game` and specify a game mode.
   Use `rustorio new-game --help` to see all available game modes.
6. Playing the game consists of filling out the `user_main` function in the
   `main.rs` file in the save game folder created for you.
7. Run with `rustorio play <save name>`. This will compile and run your save. If
   it compiles and completes without panicking, you win! It'll then tell you how
   many ticks it took you to win.

## Rules

The rules are enforced by the compiler. Only thing I'd say is to not remove the
`#![deny(unsafe_code)]` at the top of the `main.rs` file, as using unsafe code
can bypass most of what the compiler enforces. If you think you've found a way
to cheat the game that isn't caught by the compiler, please file an issue! Part
of my interest in this project is whether I can actually rule out all possible
cheating vectors using only the Rust compiler. I haven't found a way to cheat
yet, but I'm sure others will be more creative than me!

## Help

Documentation for the Rustorio library can be found
[here](https://albertsgarde.github.io/rustorio/rustorio). A good place to start
is to build a
[furnace](https://albertsgarde.github.io/rustorio/rustorio/buildings/struct.Furnace.html)
and start
[mining](https://albertsgarde.github.io/rustorio/rustorio/fn.mine_iron.html) and
smelting iron. Alternatively, you can work backwards by looking at the
[recipe](https://albertsgarde.github.io/rustorio/rustorio/recipes/struct.PointRecipe.html)
for points to figure out how to get them.