Skip to content

settingsGuide.md

Latest commit

 

History

History
76 lines (66 loc) · 5.4 KB

settingsGuide.md

File metadata and controls

76 lines (66 loc) · 5.4 KB

Roomsettings

Creating a settings file

A settings file is a .json file that contains all the settings you want the bot to use as default. The easiest way to set this up is to download the provided settings file at https://github.com/Yemasthui/basicBot/blob/master/standardSettings.json and edit that. Settings you don't want to change can be deleted, the bot will use it's default settings then. Make sure that the last setting isn't followed by a , though! If this is the case, the file won't work. The basic structure is: { "setting1": value1, "setting2": value2, ... "settingX": valueX }

Both standardSettings.json and exampleSettings.json can be used as examples, the settings are described in detail below.

Using your settings file

To use the settings file, it will need to be stored somewhere public. The easiest way to do this is to upload it to dropbox or googledrive, and get a public link for it. In your room description, include at the end (if you use custom plucubed settings, place it above that):

@basicBot=www.mylink.com/settings.json

with your link instead of the example. Follow it by a space or an enter to make sure the bot finds it.

Settings explained

Try to keep numbers integers: no decimals. Strings go between " ", if you want to use " in your string, use ". Booleans are either 'true' or 'false', without the '.

  • "maximumAfk": the amount of minutes a user can be afk for the afkCheck if it's enabled, type: a number
  • "afkRemoval": turn afkCheck on or off, type: boolean
  • "maximumDc": users that disconnected not longer than this amount of minutes ago, can get their spot back, type: a number
  • "bouncerPlus": turn the bouncer+ mode on or off, type: boolean
  • "lockdownEnabled": turn lockdown on or off, lockdown means that only staff can chat, leave it false
    -"lockGuard": turn the lockguard on or off, lockguard makes sure the waitlist isn't locked longer than the maximum allowed time, type: a boolean: true/false
  • "maximumLocktime": maximum time the waitlist can be locked if lockguard is enabled, type: a number
  • "cycleGuard": turn the cycleguard on or off, cycleguard makes sure DJ cycle isn't on longer than the allowed amount of minutes, type: boolean
  • "maximumCycletime": maximum time DJ cycle can be enabled if cyleguard is enabled, type: a number
  • "timeGuard": turn the timeguard on or off, timeguard makes sure songs are not longer than the specified limit, if they are longer they are skipped immediately, type: boolean
  • "maximumSongLength": maximum length of a track if timeguard is enabled, type: a number
  • "autodisable": if enabled, the bot sends out !afkdisable and !joindisable every hour, this disables afkmessages and autojoining on plugdubed, type: boolean
  • "commandCooldown": the cooldown in seconds for commands for users (there will always be a few seconds cooldown to prevent spamming the servers), type: a number
  • "usercommandsEnabled": turn commands for users on or off, type: boolean
  • "lockskipPosition": the position to which !lockskip adds users back to the waitlist, type: a number
  • "lockskipReasons": possible reasons to add to !lockskip, format like this: [ ["reason1", "explanation1"], ["reason2", "explanation2"], ... ["reasonX", "explanationX"] ]
  • "afkpositionCheck": only people below this waitlist position will be checked for afk, type: a number
  • "afkRankCheck": only people below and with this rank will be checked for afk, possible ranks: "user", "residentdj", "bouncer", "manager", "cohost", "host", "ambassador", "admin" eg. "bouncer" will check all grey users, residentdj's and bouncers afk
  • "motdEnabled": Message of the Day, best to be left false and to be enabled and set using the commands, MotD displays a message every X songs. Use it for temporary imporant messages, type: boolean
  • "motdInterval": standard interval for the MotD, every X songs, type: a number
  • "motd": standard MotD, best to set using the !motd command, type: string
  • "filterChat": turns the chatfilter on or off, the filter checks for a range of invalid messages like just . 's, excessive caps, asking for skips, some spam and asking for fans, type: boolean
  • "etaRestriction": enables the restriction on !eta, the restriction means that grey users can only use it once every hour, this would be used to prevent spamming the command, type: boolean
  • "welcome": turn a welcome message for users on or off, type: boolean
  • "opLink": an optional link to a list of OverPlayed songs, leave it null to leave it disabled, type: string
  • "rulesLink": an optional link to a list of rules, leave it null to leave it disabled, type: string
  • "themeLink": an optional link to the room's theme and allowed genres, leave it null to leave it disabled, type: string,
  • "fbLink": an optional link to a Facebook page, leave it null to leave it disabled, type: string,
  • "youtubeLink": an optional link to a youtube, leave it null to leave it disabled, type: string,
  • "website": an optional link to a website, leave it null to leave it disabled, type: string,
  • "intervalMessages": an array of messages displayed every X songs, leave it empty to not have any default messages, format: ["message 1", "message 2", "message 3"]
  • "messageInterval": the interval X for the standard messages, type: a number