spelltest 0.1.2

SPELL TEST Mechanics
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

<img src="https://s3-ap-southeast-1.amazonaws.com/spelltest.com/assets/logo_new.svg" height="52px" alt="SPELL TEST logo">
<br>
SPELL TEST mechanics written in Rust!

## Quick Example
```
use spelltest::*;

fn main() {
    // --- Create a player character ---
    // Character::new(name, health, energy, damage, defense)
    // Set mutable variable because we expect a change to health and energy
    let mut player = Character::new("Pel Nervil", 100, 20, 5, 0);

    // --- Create a dummy enemy ---
    let mut dummy_enemy = Character::new("Player killer", 200, 50, 10, 5);

    // Let's print their attributes
    player.print();
    dummy_enemy.print();

    // Let's do a turn-based combat
    // First, the player attack the enemy
    player.attack(&mut dummy_enemy); // Borrow and use as mutable to apply a change to enemy health
    
    // Let's print enemy attributes again, we expect the enemy health is reduced by the attack from the player
    dummy_enemy.print();

    // It's the enemy turn to attack
    dummy_enemy.attack(&mut player); // Like before, borrow and use as mutable

    // Expecting reduced player health
    player.print();
}
```

See [examples](https://github.com/bidipeppercrap/spelltest.rs/tree/master/examples) for more!

To run the official example, simply clone this repo and run it by using `cargo run --example <folder-name>` (Replace `<folder-name>` with the example folder name).

> To run `basic` example in the `examples` folder, type `cargo run --example basic`