Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 2.81 KB

README.md

File metadata and controls

30 lines (22 loc) · 2.81 KB
Raw

Olympus Community Server Discord Bots

This repo contains the code that powers the sidebar bots in the Olympus community server.

  • The bots track several protocol metrics that are of interest to the community server users, by automatically updating their nickname every 60s.
  • The bots are built with discord.js v14.
  • The protocol metrics calculation is done by using the Treasury Subgraph; an in-house monorepo that leverages wundergraph to abstract away the burden of having to index multiple subgraphs by aggregating its data and removing the need to work with pagination.

Adding the bots to your own server

If you want to add these bots to your own server, you simply need to authorize them using the following links (note that the only permission that these bots need is the one that allows them to modify their own nickname):

Once you have added the bots to your server, you should make sure that they have the proper roles. Since bots will only be visible in those channels to which they have access, you should ensure that their role allows them to join the channels where they should be available (note that since they only have permission to update their nickname, their functionalities are limited and they cannot read the messages, nor interact with the users in those channels).

Creating your own bots

If instead, you would prefer to create your own bots by forking the repo, these are the necessary steps to make them work:

  1. Create the application for your bots
    • Each bot will require its own application.
    • Instructions
    • Go to the OAuth2 > URL Generator tab. Select bot as the application scope, and give it the Change Nickname permission. Follow the auto-generated URL to add the bot to your server.
    • Go to the Bot tab. Generate a token and inform it to its corresponding variable in the .env file.
  2. Similar to what you would do if using Olympus' bots, now that you have added the bots to your server, you need to give them the proper roles to allow them to be visible in the desired channels.