Update readme for Call of Cthulhu, roadmap, and other stuff.
continuous-integration/drone/push Build is passing Details

This commit is contained in:
projectmoon 2020-11-30 20:31:04 +00:00
parent e177da9c25
commit 62203edce8
1 changed files with 15 additions and 8 deletions

View File

@ -5,11 +5,11 @@
_This repository is hosted on [Agnos.is Git][main-repo] and mirrored _This repository is hosted on [Agnos.is Git][main-repo] and mirrored
to [GitHub][github-repo]._ to [GitHub][github-repo]._
This is a fork of the This is a dice rolling bot for facilitating roleplaying games on the
[axfive-matrix-dicebot](https://gitlab.com/Taywee/axfive-matrix-dicebot) Matrix messaging platform. It currently has basic support for the
with basic support for the Chronicles of Darkness 2E Storytelling Chronicles of Darkness 2E Storytelling System and Call of Cthulhu,
System and Call of Cthulhu, with future plans to extend the codebase with plans to extend the codebase further to support other systems and
further to support variables and perhaps character sheet management. character sheet management.
## Features ## Features
@ -20,6 +20,7 @@ following features:
* Rolling dice pools for the Chronicles of Darkness 2E Storytelling * Rolling dice pools for the Chronicles of Darkness 2E Storytelling
System. System.
* Works in encrypted or unencrypted Matrix rooms. * Works in encrypted or unencrypted Matrix rooms.
* Storing variables created by the user.
## Building and Installation ## Building and Installation
@ -213,15 +214,21 @@ commands locally.
The most basic plans are: The most basic plans are:
* To add support for simple per-user variable management, e.g. setting * Resource counting: creation of custom counters that can go up and
a name to a value (`gnosis = 3`) and then using those in dice rolls. down.
This lays the foundation for character sheet integration.
* Perhaps some sort of character sheet integration. But for that, we * Perhaps some sort of character sheet integration. But for that, we
would need a sheet service. would need a sheet service.
* Use environment variables instead of config file in Docker image. * Use environment variables instead of config file in Docker image.
## Credits
This was orignally a fork of the [axfive-matrix-dicebot][axfive], with
support added for Chronicles of Darkness and Call of Cthulhu.
[axfive]: https://gitlab.com/Taywee/axfive-matrix-dicebot
[config-file]: #Configuration-File [config-file]: #Configuration-File
[docker-image]: https://github.com/users/ProjectMoon/packages/container/package/chronicle-dicebot [docker-image]: https://github.com/users/ProjectMoon/packages/container/package/chronicle-dicebot
[dirs]: https://docs.rs/dirs/2.0.2/dirs/ [dirs]: https://docs.rs/dirs/2.0.2/dirs/
[main-repo]: https://git.agnos.is/projectmoon/matrix-dicebot [main-repo]: https://git.agnos.is/projectmoon/matrix-dicebot
[github-repo]: https://github.com/ProjectMoon/matrix-dicebot [github-repo]: https://github.com/ProjectMoon/matrix-dicebot
[roadmap]: https://git.agnos.is/projectmoon/matrix-dicebot/wiki/Roadmap