rust-warrior 0.1.1

Game for learning Rust, inspired by Ruby Warrior
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

# rust-warrior

[![Crates.io][crates-badge]][crates]

This game is inspired by [Ruby Warrior][ruby-warrior], which I played many
years ago. This project started as a direct port, but because Ruby is an
interpreted language and allows (encourages?) meta programming... I've
designed `rust-warrior` partly from scratch.

# Set Up

`rust-warrior` ships with two major components: a binary that generates a
new game directory, and a library which contains the main game engine.

To get started, install `rust-warrior`.

```sh
$ cargo install rust-warrior
```

Then run `rust-warrior` and follow the prompts to set up all the
necessary files in a new game directory.

```sh
$ rust-warrior
```

Then navigate to `rustwarrior/<name>` and run the program.

```sh
$ cd rustwarrior/<name>
$ cargo run
```

Docs: https://docs.rs/rust-warrior/

[crates-badge]: https://img.shields.io/crates/v/rust-warrior?style=plastic
[crates]: https://crates.io/crates/rust-warrior
[ruby-warrior]: https://github.com/ryanb/ruby-warrior