The Wiki page explains the following:
The file is a yaml/yml markdown file which has 3 sections, one for each chat domain:
Each section contains the following structure:
<chat host>:
<room id>:
commands: true/false,
watcher: true/false,
msg_types:
- <role string...>
- ...
privileges:
- <user id...>
- ...
<chat host>
corresponding to these domains are stackexchange.com, meta.stackexchange.com, and stackoverflow.com. Each chat server has independent rate limiting for the chat messages a single user can post. If you’re making a test room into which the SmokeDetector user is going to be posting lots of messages, then please create the room on either meta.stackexchange.com or stackoverflow.com. SmokeDetector currently posts most of it’s messages to the stackexchange.com chat server, which means it’s the one that gets rate-limited the most.debug
: this is what Charcoal HQ or your main room would have set. Rooms with this set will receive startup messages and other debugging information (basically anything that would have previously been done with GlobalVars.charcoal_hq.send_message).all
or site-<site>
: This dictates what sites will have their spam reported to the room. Rooms with all will receive reports from any site, while site-no-<reason>
: This room won’t receive reports with the specified reason (e.g no-all-caps title)metatavern
: A special role created for the Tavern on Meta, currently it just receives messages about blocks (for Town Halls).delay
: Introduces a 5 minute delay for reports; reports won’t be posted if the post has been marked as false positive or deleted within the 5 minute windowDuring development, you probably want to avoid posting a bunch of reports and debug messages to our main rooms. In this case, you can set up a custom rooms.yml file to configure where Smokey will post messages.
Simply create a file named rooms_custom.yml
, and fill it in using the format described above. If you need a spare room to test in, we have one available for your use:
If you don’t want Smokey to post any chat messages, you can simply leave the file blank.