46 lines
980 B
Markdown
46 lines
980 B
Markdown
# rollable
|
|
|
|
Roll and parse dices
|
|
|
|
Works with crystal v1.0.0
|
|
|
|
## Installation
|
|
|
|
[](https://travis-ci.org/Nephos/crystal_rollable)
|
|
|
|
Add this to your application's `shard.yml`:
|
|
|
|
```yaml
|
|
dependencies:
|
|
rollable:
|
|
git: https://git.sceptique.eu/Sceptique/rollable
|
|
branch: master
|
|
```
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
```crystal
|
|
require "rollable"
|
|
Rollable::Roll.parse("2d6+4").test # => Roll 2 dices and add 4 to the sum
|
|
Rollable::Roll.parse("!1d20 + !1d8").test # => Exploding dices
|
|
```
|
|
|
|
|
|
## Development
|
|
|
|
TODO: Write development instructions here
|
|
|
|
## Contributing
|
|
|
|
1. Fork it ( https://git.sceptique.eu/Sceptique/rollable/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
|
|
|
|
- [Sceptique](https://git.sceptique.eu/Sceptique) Arthur Poulet - creator, maintainer
|