Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 3.28 KB

README.md

File metadata and controls

53 lines (32 loc) · 3.28 KB
Raw

Banner

Discord bot to attend omegaUp contest clarifications easily.

Warning: This bot has been created at an accelerated pace of development to meet the OMI[PS] 2023 deadlines. In the near future, the bot will be refactored and integrated with new Python 3 modules to facilitate future development. Any current issues with the bot will be fixed after the upgrade, unless they are critical bugs that affect the bot's operation.

Requirements

To get started with the bot, make sure you have the following environment variables set up:

  • $OMEGAUP_API_TOKEN: This token is crucial for authenticating with the omegaUp API. If you don't have one yet, you can obtain it by following the instructions here.

  • $HARMONY_TOKEN: This is the Discord token specifically designed for bots, which Harmony will utilize to send messages and execute commands seamlessly.

If you haven't set up these environment variables yet, Harmony will prompt you for them during the initial setup process. You'll also be asked to provide additional information, such as the guild and channel IDs where the bot will communicate and the target contest.

This is just an example of how it looks like: Log Example

Quickstart

Once the bot has been properly configured, it will start listening for incoming clarifications from the specified contest. This will happen automatically every 10 seconds (please note that API Tokens have a limit of 1000 requests per hour, so if the 10-second delay is decreased, the limit may be reached very quickly).

On every Harmony notification will apear some buttons as shown below:

Notification Modal Form Final Message
IMG IMG IMG

In addition, the bot features an /announce slash command. You can use this command to send a public clarification with a specified message about the selected problem.

Slash Command

If you have any questions or concerns about Harmony, please let me know.

License

Apocryphon-X/harmony is licensed under the MIT License. A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications and larger works may be distributed under different terms and without source code. More details can be found in the LICENSE file.