diff --git a/README.md b/README.md index e72b8df..fdab438 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # minetest-scuttlebutt -minetest scuttlebutt mod \ No newline at end of file +minetest scuttlebutt mod called «scuttlebut» is a WIP mod that allows minetest player to send messages to a scuttlebutt user, given is scuttlebutt `sbkey`. + +## usage +once installed in the mods subdirectory of minetest home (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: + +- json +- socket +- bit32 + +This mod needs an ssb server to work on the same host and owned by the minetest server. The mod talks to the ssb server through the `.ssb/socket` unix domain socket. Thus, this socket must be accessable by the minetest server. The identity used is then the one of the ssb server owned by the minetest unix user. The message to send is optional: if no message is written by the player, then a default message is sent, such as: + +`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