Configuration

Configuration

Wiki Utilities is all about configuration. Read below to learn how you can configure your copy of Wiki Utilities.

All configuration options are stored in config.sample.json.

• token: The token of the bot. Get this by following the above instructions.

• prefixes: An array of all the prefixes the bot recognises. Defaults to just wu!.

• lang: The language you want the bot to respond with. Currently supports en, pl, pt-br, and hi.

• owners: An array of all the owners of the bot. Put your Discord ID here, and any others if you want. The owners of the bot bypass all restrictions! Be careful with who you give this to.

• guilds: The object which holds configuration data for each guild. Information on what is required here is below.

• infinite_lengths: What the bot will recognise as "infinite" lengths for block and protect commands.

• user_map A map of user IDs to their wiki usernames. Example of this configuration would be "441164156016787486": "Sidemen19". If this option is disabled or missing an ID, it will display the author's Discord tag, instead of their wiki username in edit summaries and reasons.

• summaries The format summaries and reasons will be in.

  • Supported variables for the formats are:

    • $reason/$summary: The reason provided when using the command.
    • $tag: The message author's Discord tag.
    • $username: The message author's wiki username, if existent in the user map.

  • The string dynamically changes depending on whether the message author's id exists in the user map, so there are two options for each command.

  • There is support for presets, so you can have shorthand reasons, e.g. -r=spam can resolve to Spamming pages. You can also set default reasons with presets.

  • If you are confused, check config.sample.json out.

Wiki Object

• url: The URL to the wiki. Example: https://community.fandom.com
• path: The path to the wiki's api.php file. For example, all Fandom wikis' path is an empty string as the file's located at c.fandom.com/api.php, but wikipedia has /w as their path as their api.php file is located at en.wikipedia.org/w/api.php
• allowed_roles: An array of role IDs, the members of it will be able to take administrative wiki actions. (NOTE: give this only to a trusted role, this is basically giving admin rights to whoever is in this role). Owners of the bot bypass this.
• blacklisted_users: An array of user IDs, this overrides allowed_roles, removing the right from any untrustworthy users.
• defaults
  • allow_user_talk: Whether the bot should block the user from editing their talk page.
  • autoblock: Whether to automatically block the last used IP address, and any subsequent IP addresses they try to login from.
  • reblock: Whether to override an existing block.
• rcgcdw_extension
  • enabled: Whether the extension is enabled or not.
  • channel_ids: An array of all logging channel IDs.
  • mode: compact or embed. Whether your RcGcDw script is running in compact or embed mode.
  • wiki_name: The name of the wiki that the RC script is running for.
  • block_duration: The block duration applied to the block when using the block reaction. As the system is all reaction-based, this isn't modifiable at the time of block.
  • emojis: Any unicode emojis to use when reacting, instead of the default regional indicators.
• credentials (these must be obtained from Special:BotPasswords)
  • username: The username. (it is recommended to use a separate bot account, and give that admin rights, instead of your main account).
  • password: The bot password. Obtain this from Special:Botpasswords.

Next: Extending Wiki Utilities