diff --git a/Settings.md b/Settings.md new file mode 100644 index 0000000..eb072dc --- /dev/null +++ b/Settings.md @@ -0,0 +1,30 @@ +All settings are changed in `minetest.conf`. If any of these settings +is not set, the default value is used. + +* `irc.server` (string, default `irc.freenode.net`) -- This is the IRC + server the mod connects to. +* `irc.channel` (string, default `##mt-irc-mod`) -- The IRC channel to join. +* `irc.interval` (number, default `2.0`) -- This prevents the server from + flooding. It should be at least `2.0` but can be higher. After four + messages this much time must pass between folowing messages. +* `irc.timeout` (number, default `60.0`) -- Underlying socket timeout in + seconds. This is the time before the system drops an idle connection. +* `irc.nick` (string, default `MT-`) -- Nickname used by the "bot" + for the in-game chat. "" is a random 32 bit number. +* `irc.password` (string, default empty) -- Password to use when connecting + to the server. +* `irc.NSPass` (string, default empty) -- NickServ password. Don't use this + if you use SASL authentication. +* `irc.SASLPass` (string, default empty) -- SASL password, same as nickserv + password. You should use this instead of NickServ authentication if the + server supports it. +* `irc.SASLUser` (string, default `irc.nick`) -- The SASL username. This + should normaly be set to your main NickServ account name. +* `irc.debug` (boolean, default false) -- Whether to output debug information. +* `irc.disable_auto_connect` (boolean, default false) -- If false, the bot is + connected by default. If true, a player with the `irc_admin` privilege has + to use the `/irc_connect` command to connect to the server. +* `irc.disable_auto_join` (boolean, default false) -- If false, players join + the channel automatically upon entering the game. If true, each user must + manually use the `/join` command to join the channel. In any case, the + players may use the `/part` command to opt-out of being in the channel.