35 lines
979 B
Markdown
35 lines
979 B
Markdown
|
# tome_matrix
|
||
|
|
||
|
Tomecraft server using mautrix-go
|
||
|
|
||
|
## How to build
|
||
|
Requires Go 1.16
|
||
|
|
||
|
Just run go build
|
||
|
|
||
|
|
||
|
## Running tome_matrix
|
||
|
Create a config.yaml with the following variables:
|
||
|
|
||
|
homeserver: (homeserver_url)
|
||
|
username: (bot_username)
|
||
|
password: (bot_password)
|
||
|
homeserverDomain: (domain name that the matrix homeserver is on i.e. for server matrix.example.com put example.com
|
||
|
|
||
|
Make sure there is a matrix user with the above credentials available.
|
||
|
|
||
|
Run tome_matrix.
|
||
|
|
||
|
## Playing a match
|
||
|
Right now only direct matches are supported.
|
||
|
|
||
|
When the bot firsts logs in, it will create a room named #tomequeue . Join that room to have the bot create a DM with you.
|
||
|
|
||
|
Once the DM is created, you can start a match by sending
|
||
|
direct (username)
|
||
|
to the bot. This will cause it to invite both users to a new room: #tome_(UUID).
|
||
|
|
||
|
The tome_UUID room is the game room; it contains the game state and is public.
|
||
|
|
||
|
To actually play the game, send GameCommands to the DM room you have with the bot.
|