Clearingway listens to a Discord channel for the message /clears <world> <first-name> <last-name>.
When it hears this message, it tries to find the relevant character in the Lodestone. If it finds them, it then parses their fflogs and tries to assign them a few roles:
- A role for the highest current parse they have in any relevant encounter (Gold, Orange, Purple, Blue, Green, Grey)
- A role for every relevant encounter they've cleared ("P1S-Cleared," "P2S-Cleared," "P3S-Cleared," etc.)
- A combo legend role purely for flexing purposes for every ultimate they've cleared (The Legend, The Double Legend, The Triple Legend, The Tetra Legend)
- The role "NA's Comfiest" if they have any relevant encounter clears with a parse between 0 and 0.9
- The role "The Nice Legend" if they have any ultimate clears with a parse between 69.0 and 69.9
- The role "Nice" if they have any relevant clears with a parse between 69.0 and 69.9
- The role "The Comfy Legend" if they have any ultimate clears with a parse between 0 and 0.9
It can be configured with the config.yaml file found in this repository.
Clearingway requires the following environment variables to start:
- DISCORD_TOKEN: You have to create a Discord bot for Clearingway. Once you've done so, you can add the bot token here.
- FFLOGS_CLIENT_ID: The client ID from fflogs.
- FFLOGS_CLIENT_SECRET: The client secret from fflogs.