Server Mod Help Chat Offer help on server mods via a chat bot. Chat is available in the game lobby and in game. When enabled in the lobby, it will greet new players in order tell them about the !topics command. Public chat is disabled by default, except for the host in the lobby. Local Chat Commands - /commands: list local commands - /on: enable public chat - /off: disable public chat Chat Commands - !commands: list commands - !topics: list topics - ?<topic>: print the text associated with the given topic Providing Chat Help This mod attempts to load a file named `<server mod idenfier>/mod_help.json`. The directory name *must* be the same identifier which appears in your `modinfo.json`. Example: `com.wondible.pa.my_awesome_mod/mod_help.json`. Chat Topics The JSON file should contain a `topics` object with simple topic-text pairs. Code: { "topics": { "my awesome mod": "Brief overview", "another topic": "...", "mymod tips": "..." } } All chat topics are merged, so please try to choose topic names which are unlikely to collide with other mods (such as `tips`) Announcements The JSON file may contain an `announcement` string. Announcements occur when a player enters the lobby. The intended use is for mods that can offer additional lobby functionality by shadowing. Please use with restraint. Code: { "announcement": "Extra lobby functionality is available. If you don't see XXXX, refresh the UI (F5 by default).", "topics": {...} } Mod - https://github.com/pamods/server_mod_help_chat - http://wondible.com/pa/server_mod_help_chat_v1.2.1.zip - PAMM Mods with sample support - Extreme Energy Combat - Extremely Efficient Engineers - Finite Metal - Junkyard Wars - No Metal Commander - Puppetmaster - Reclaimable Features Changes ## 1.2.2 - Arbitrary substring match was too zealous for regular commands. Now used only on help topics. e.g. - `:-D` will not run `!commands` by matching `d` (prefix should still be usable `!com`) - `?combat` should still match `extreme energy combat` ## 1.2.1 - Bump build number for titans ## 1.2.0 - Fix issue with jQuery auto-parsing json - Remove legacy support for `server_mod_help.json` ## 1.1.0 - Fix forum url - Removed some cases where the bot accidentally spoke - Extracted post to chat from core chat module - Chatbots can be disabled - Local commands to control public chat: /on /off - Public chat is disabled by default, except for the host in the lobby WIP Thread
Server Mod Help Chat 1.1.0 - Fix forum url - Removed some cases where the bot accidentally spoke - Extracted post to chat from core chat module - Chatbots can be disabled - Local commands to control public chat: /on /off - Public chat is disabled by default, except for the host in the lobby
Server Mod Help Chat 1.2.0 - Fix issue with jQuery auto-parsing json - Remove legacy support for `server_mod_help.json`
This bot doesn't announce itself to players, which means you have to know about it and how to use it, in which case you probably didn't need it in the first place. I'd suggest that every player that joins gets the default list of commands provided to them, in the same way mods like Lobby System Preview announce themselves. Also, when using !topics I get the following: "> commands are: !commands, !topics, joined the lobby."
The bot only defaults to enabled for the game host (for generating messages - only one player should be running it), and only if it found topics to provide. What mods are you trying to use it with? I checked it with Finite Metal. Are you sure you typed !topics and not !commands ?
Server Mod Help Chat 1.2.2 - Arbitrary substring match was too zealous for regular commands. Now used only on help topics. e.g. - `:-D` will not run `!commands` by matching `d` (prefix should still be usable `!com`) - `?combat` should still match `extreme energy combat`
