Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.07 KB

File metadata and controls

46 lines (30 loc) · 2.07 KB

Developer documentation

If you want to work Synus' source code yourself, here's a few things to take a look at before booting them up the first time.

I'll try my best to keep these as up-to-date as possible. However, if you do run into any issues regarding anything missing in this file, make sure to notify me!

API keys & tokens

To work properly, Synus requires API keys. Make sure you get your hands on at least one key for each item in this table list before trying to do anything with the bot itself.

API key / token Where? Why?
Bot user token Discord developer console Your bot's gonna need an user to log into Discord.
Set up an user like this.

Bot config

Place a .env file into the root of the project following the values required listed in .env.example

Custom emoji

Synus uses some custom emoji to emphasize their character. You can enter your emoji IDs src/data/emojis.ts

Where to find the emoji ID for custom emoji

You can get the emoji ID by sending \:emoji_name: into any channel that your emoji is accessible in. For example, the input\:ping: will result in <:ping:565320633471467525> in my bot emoji host server.

Finding custom emoji in code

Usually, custom emoji are retrieved via one of two methods.
They're either referenced directly in a string like so

`<:_:${emojis.ping}>`

or fetched directly via the bot user like so

this.client.emojis.resolve('565320633471467525')