forked from TalkTakesTime/Pokemon-Showdown-Bot
-
Notifications
You must be signed in to change notification settings - Fork 5
/
config-example.js
96 lines (80 loc) · 4.29 KB
/
config-example.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
"use strict";
/* Websocket server and port the bot should connect to. Check the 'Request URL'
* of the websocket. If you don't know what that means, just leave this as-is. */
exports.server = "sim3.psim.us";
exports.port = 443;
/* The server ID. This should almost certainly be "showdown", but just in case,
* check where the AJAX call "goes to" when you log in. For example, on the PS server,
* it will say ~~showdown somewhere in the URL, indicating the server ID is "showdown"
* If you don't know what that means, just leave this as-is. */
exports.serverid = "showdown";
/* The name of the bot and password. I recommend setting up the account prior to
* launching node main.js for the first time. Use a strong password if you
* intend for this bot to be a roombot. */
exports.nick = "";
exports.pass = "";
exports.avatar = "";
exports.status = "";
/* The owner(s) of the bot. Owners should be in quotes, separated by commas.
* An owner of this bot has access to all commands defined in commands.js,
* in addition to being the only ones who can access admin commands. */
exports.owners = [""];
/* Rooms that should be joined in quotes, separated by commas. */
exports.rooms = ["exampleRoom", "another room"];
/* Any private rooms that should be joined in quotes, separated by commas.
* The only difference in private rooms are moderation type (you can't warn).
* Groupchats are included as private rooms. If the room fails to exist, the
* bot will just ignore it and move on. */
exports.privaterooms = [""];
/* The character to use to execute commands from commands.js. The command
* character must be made of more than just alphanumeric characters and
* spaces, and you really shouldn't use ! or / because those are normal
* commands. */
exports.commandcharacter = '.';
/* If this is changed to true, config changes can be adjusted on-the-fly.
* It's pretty much useless though (use .reload to dynamically update
* parser and commands), so I would just leave it false.*/
exports.watchconfig = false;
/* Secondary websocket protocols should be defined here. However, I'm told
* Showdown doesn't support these yet, so it's best to leave this empty. */
exports.secprotocols = [];
/* Logs information to the console so you can monitor various things.
* 0 = error, ok, info, debug, recv, send
* 1 = error, ok, info, debug, cmdr, send
* 2 = error, ok, info, debug (recommended for development)
* 3 = error, ok, info (recommended for production)
* 4 = error, ok
* 5 = error */
exports.debuglevel = 3;
/* How fast the bot will attempt to reconnect after a disconnection,
* in seconds. Depending on your Internet speed, setting this too low
* may cause multiple instances of the bot to join, or not join at all. */
exports.timeout = 20;
/* Users here will never be punished by the bot. By default, all
* users with drivers or higher will not be warned. */
exports.whitelist = [];
/* Add a help link for the bot here, e.g. to pastebin to explain commands. */
exports.botguide = "";
/* The repository for the bot. Leave blank if you have no public repository. */
exports.git = "";
/* Turns on moderation capabilities for the bot. THE BOT IS NOT HUMAN AND
* DOES NOT MAKE A PERFECT MODERATOR. If enabled, I encourage roomstaff to
* override the bot if it is being unfair. There is a relatively serious bug
* where rarely on disconnects, two instances of the bot will rejoin a room, so
* it doubly counts chat input and advances punishments accordingly. Use with caution.
*
* Spamming/flooding is considered to be users who send 6 lines or more in 6 or fewer seconds.
* CAPS abuse is considered to be a chat line with at least 18 letters in CAPS and with 80% of their total letters being in CAPS.
* Stretching is considered to be using the same character 8 times in a row, or some group of characters 5 times in a row.
* Bold abuse is considered to be a chat line with at least 18 letters in bold OR 80% of their total letters being in bold.
* Punishments are accelerated if a user continues to activate the bot's warnings/mutes. */
exports.allowmute = false;
/* You can customize what punishments are appropriate after repeated offenses here.*/
exports.punishvals =
{
1: "warn",
2: "mute",
3: "hourmute",
4: "hourmute",
5: "roomban"
};