be1
/
minetest-scuttlebutt
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add installation section

This commit is contained in:
Benoît Rouits 2020-05-23 15:21:11 +02:00
parent d0a8e78d33
commit 89bcccaab3
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -2,6 +2,15 @@
Minetest scuttlebutt mod called «scuttlebut» is a WIP mod that allows minetest player to send messages to a scuttlebutt user, given is scuttlebutt `sbkey`.
## installation
Go to the approriate `mods` subdirectory of your minetest game installation. Clone this repo as `scuttlebutt` directory name:
```
git clone https://git.p2p.legal/be1/minetest-scuttlebutt.git scuttlebutt
```
Install an ssb server for the unix user being the same as the minetest server. Configure your minetset server to enable the module as a trusted mod and restart minetest server.
## usage
Once installed in the mods subdirectory of minetest home as `scuttlebutt` subdirectory (see minetest documentation), this mod allow to player who have the `ssb` privilege to send a private message with the command `/ssb <sbkey> [message]` to the scuttlebutt user identified by `sbkey`. This module must be set as a trusted module of minetest because it requires extra Lua modules to work, namely:
@ -14,4 +23,4 @@ This mod needs an ssb server to work on the same host and owned by the minetest
`Minetest bot here. <player> says: Please join me on <hostname>:<port>`
## further work
Currently this mod can only send messages. Back message polling will be implemented in order to redispatch replies to the minetest players.
Currently this mod can only send messages. Back message polling will be implemented in order to redispatch replies to the minetest players.