Gaming/matrix_chat
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jon Neverland 2017-06-21 21:52:27 +02:00 committed by GitHub
parent 6c9b424bfd
commit c9f921744c
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -2,13 +2,12 @@
# Matrix mod for Minetest
This mod creates a bridge between a [Matrix](https://matrix.org) channel and the in-game chat.
This mod creates a bridge between a [Matrix](https://matrix.org) channel and the in-game chat.
The code is shamelessly based on the [irc](https://github.com/minetest-mods/irc) mod and examples from [lua-matrix](https://github.com/aperezdc/lua-matrix).
## Installing
```bash
cd <Mods directory> && git clone --recursive git@github.com:diggers-mt/minetest-matrix.git
```
@ -34,7 +33,7 @@ luarocks install lua-cjson
export MATRIX_API_HTTP_CLIENT=luasocket
```
You might need to prepend `sudo` to first and second commands
You might need to prepend `sudo` to first and second commands.
You also need to add Matrix to your trusted mods if you haven't disabled mod security.
@ -47,7 +46,7 @@ secure.trusted_mods = matrix
## Settings
* `matrix.user`: Matrix username, for example `@minetestbot@matrix.org`
* `matrix.user`: Matrix username, for example `@minetestbot:matrix.org`
* `matrix.password`: Password for Matrix user
@ -61,4 +60,3 @@ secure.trusted_mods = matrix
## License
See `LICENSE.txt` for details.