forked from projectmoon/tenebrous-dicebot
Version 0.4.0: limit display of large dice pools, basic logging.
This commit is contained in:
parent
5983592eb3
commit
940e83077a
|
@ -167,7 +167,7 @@ checksum = "4785bdd1c96b2a846b2bd7cc02e86b6b3dbf14e7e53446c4f54c92a361040822"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "chronicle-dicebot"
|
name = "chronicle-dicebot"
|
||||||
version = "0.3.0"
|
version = "0.4.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"async-trait",
|
"async-trait",
|
||||||
"dirs",
|
"dirs",
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
[package]
|
[package]
|
||||||
name = "chronicle-dicebot"
|
name = "chronicle-dicebot"
|
||||||
version = "0.3.0"
|
version = "0.4.0"
|
||||||
authors = ["Taylor C. Richberger <taywee@gmx.com>", "projectmoon <projectmoon@agnos.is>"]
|
authors = ["Taylor C. Richberger <taywee@gmx.com>", "projectmoon <projectmoon@agnos.is>"]
|
||||||
edition = "2018"
|
edition = "2018"
|
||||||
license = 'MIT'
|
license = 'MIT'
|
||||||
|
|
36
README.md
36
README.md
|
@ -4,7 +4,9 @@ This is a fork of the
|
||||||
[axfive-matrix-dicebot](https://gitlab.com/Taywee/axfive-matrix-dicebot)
|
[axfive-matrix-dicebot](https://gitlab.com/Taywee/axfive-matrix-dicebot)
|
||||||
with basic support for the Chronicles of Darkness 2E Storytelling
|
with basic support for the Chronicles of Darkness 2E Storytelling
|
||||||
System, with future plans to extend the codebase further to support
|
System, with future plans to extend the codebase further to support
|
||||||
variables and perhaps character sheet management.
|
variables and perhaps character sheet management. It also contains
|
||||||
|
various fixes, uses the Matrix SDK for connectivity, and has a Docker
|
||||||
|
image.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
@ -48,12 +50,9 @@ like this:
|
||||||
|
|
||||||
```ini
|
```ini
|
||||||
[matrix]
|
[matrix]
|
||||||
home_server = 'matrix.org'
|
home_server = https://'matrix.org'
|
||||||
|
username = 'thisismyusername'
|
||||||
[matrix.login]
|
|
||||||
password = 'thisismypassword'
|
password = 'thisismypassword'
|
||||||
type = 'm.login.password'
|
|
||||||
user = 'axfive-dicebot'
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Of course replacing all the necessary fields. Then you can run the
|
Of course replacing all the necessary fields. Then you can run the
|
||||||
|
@ -64,6 +63,28 @@ You can also just run it on the command line with the `dicebot-cmd`
|
||||||
command, which expects you to feed it one of the command expressions
|
command, which expects you to feed it one of the command expressions
|
||||||
as shown above, and will give you the plaintext response.
|
as shown above, and will give you the plaintext response.
|
||||||
|
|
||||||
|
## Docker Image
|
||||||
|
|
||||||
|
The dice bot can run in a minimal Docker image based on [Void
|
||||||
|
Linux](https://voidlinux.org/). To create the Docker image, run
|
||||||
|
`docker build -t chronicle-dicebot .` in the root of the repository.
|
||||||
|
|
||||||
|
A typical docker run command should look something like this:
|
||||||
|
```
|
||||||
|
VERSION="0.3.0"
|
||||||
|
docker run --rm -d --name dicebot \
|
||||||
|
-v /path/to/dicebot-config.toml:/config/dicebot-config.toml:ro \
|
||||||
|
-v /path/to/cache//:/cache \
|
||||||
|
chronicle-dicebot:$VERSION
|
||||||
|
```
|
||||||
|
|
||||||
|
The Docker image requires two volume mounts: the location of the
|
||||||
|
config file, which should be mounted at `/config/dicebot-config.toml`,
|
||||||
|
and a cache directory to store client state after initial sync. That
|
||||||
|
should be mounted at `/cache/`in the container.
|
||||||
|
|
||||||
|
Properly automated docker builds are forthcoming.
|
||||||
|
|
||||||
## Future plans
|
## Future plans
|
||||||
|
|
||||||
The most basic plans are:
|
The most basic plans are:
|
||||||
|
@ -72,4 +93,5 @@ The most basic plans are:
|
||||||
a name to a value (`gnosis = 3`) and then using those in dice rolls.
|
a name to a value (`gnosis = 3`) and then using those in dice rolls.
|
||||||
* 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.
|
||||||
* Robustness fixes if necessary, which will be sent upstream.
|
* Automation of Docker builds.
|
||||||
|
* Use environment variables instead of config file in Docker image.
|
||||||
|
|
Loading…
Reference in New Issue