diff --git a/README.md b/README.md index 87ac550..ef903ab 100644 --- a/README.md +++ b/README.md @@ -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 [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. says: Please join me on :` ## further work -Currently this mod can only send messages. Back message polling will be implemented in order to redispatch replies to the minetest players. \ No newline at end of file +Currently this mod can only send messages. Back message polling will be implemented in order to redispatch replies to the minetest players.