Skip to content

Latest commit

 

History

History
34 lines (29 loc) · 3.8 KB

README.md

File metadata and controls

34 lines (29 loc) · 3.8 KB

FIONA

Foundation's Intelligence for Operational Navigation Applications


Verifies users having wikidot account, for granting member role. Verifies by first calling ScpperDB API, then falls back on calling Wikidot AJAX if not found, as Wikidot is very slow. Wikidot AJAX calling modified from Resure/wikidot-ajax

Usage

The bot accepts the form of JSON and environment variables for config and always uses environment variables if provided.

Config parameters Required or not Values Default Description
CMD_PREFIX Optional String #/ The prefix for using the commands of the bot
DIS_TOKEN Required String empty string The token for logging into your bot account
DIS_ADMINS Optional String or String[] null The admin role id(s) for your server, users are required to have the specified role(s) to use administrative commands
DIS_VERIFY_TYPE Optional String null Verification methods. Possible values: reaction for adding specific reaction to a specific message or wikidotname for checking against username. Leave blank for disabling verification.
DIS_VERIFY_CHAN Optional String null Discord channel where the verify message(s) are put if DIS_VERIFY_TYPE is enabled.
DIS_VERIFY_MSG Optional String null The message id to react to if DIS_VERIFY_TYPE is reaction.
DIS_VERIFY_REACT Optional String null The reaction id/distinguisher to add to message if DIS_VERIFY_TYPE is reaction.
DIS_MEM_ROLE Optional String null The role id to add to member if DIS_VERIFY_TYPE is enabled.
DIS_BAN Optional String[] [] Malicious user ids that you are informed of, but hasn't joined your server yet. Use this option to auto-ban them once they join your server.
DIS_CHANMOD Optional Record<String, String[]> {} The key for channel id corresponds to an array of channel mods' role ids.
DIS_CROM_BLKCHAN Optional String[] [] Channel ids that inline CROM does not serve.
DIS_LOG_TYPE Optional String null Message deletion logging type. Possible values: channel for sending logs to a specified channel or dm for sending to a user's private dm. Leave blank for disabling logging.
DIS_LOG_GUILD Optional String null Discord server of which the deleted message(s) are logged if DIS_LOG_TYPE is enabled.
DIS_LOG_CHAN Optional String null Discord server channel/user id where the deleted message(s) logs are put if DIS_LOG_TYPE is enabled.
SCP_CHECK_TYPE Optional String exists Method for checking for user information on ScpperDB if DIS_VERIFY_TYPE is wikidotname. Possible values: exists to check if any user of the provided username exists or member to check if any user of the provided username is a member of provided site.
SCP_SITE Optional String cn The site for checking site activity for verification, should be site initial (branch tag).

All config parameters can be provided in the form of environment variables by adding "FIO_" in front of the parameter name, e.g. "FIO_CMD_PREFIX".