diff --git a/README.md b/README.md index 2b3b20cebc7877314b7746079f2a8df33e9248e9..0850d040a19d7c963955b52dc4bc315d064f2fb1 100644 --- a/README.md +++ b/README.md @@ -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. -