GameOfGame/README.md

35 lines
1.2 KiB
Markdown

# game_of_game
Game of Game is a framework to develop "AI" (strategies) for simple games such as the prisonner game etc.
## Installation
Install crystal >=1.6.
## Usage
```
crystal build --release src/game/<any_game>.cr
./<any_game>
```
## Development
You can develop 3 types of systems:
- Game in src/game. Usually a loop to test several combinations or randomness. Benchmarking, contests, etc.
- Game rules in src/rules_set. They handle what happen each time a player place a bet and the consequences of the bets of every player.
- Game strategies in src/ai. Most of the time you want to develop your AI (strategies) along with one rule_set but they might be compatible with others, depending on the expected inputs. They behave and have access to the history of the game to take futur bets.
## Contributing
1. Fork it (<https://git.sceptique.eu/Sceptique/game_of_game/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Arthur POULET](https://git.sceptique.eu/Sceptique) - creator and maintainer