skyline-bot
skyline-bot copied to clipboard
This is the bot for the official Skyline Emulator Discord Server
Skyline Bot
We needed a bot for managing our Discord server with specific features. Skyline Bot was created so that we could effectively moderate and help people in an efficient manner and meet the special needs of managing an emulation server with potential for integration with the application in the future.
Outline
Events
These are any events emitted by the Discord API that are visible to the bot, such as:
- Triggering an interaction (
interactionCreate
) - Successful connection with the Discord API (
ready
) - Sending a message (
messageCreate
) - Modification of a guild member (
guildMemberUpdate
)
Filters
These are implemented in the messageCreate
event file. The functions added are run for every message that the bot recieves.
Commands
Skyline Bot uses Discord interactions (slash commands, modals, etc.) to provide users with a simple way of communicating with the bot.
Setup and usage
Step 1: Install Node.js
We use Discord.js for writing the bot, a module that allows the bot to connect with the Discord API through Node.js. Install Node.js to develop or host an instance of Skyline Bot.
Step 2: Installing modules and dependencies
Download the code and extract it to a folder. Run npm i
from inside the project folder to install the necessary modules and dependencies that allow Skyline Bot to run.
Step 3: Starting the bot
To start the bot, run npm run tscw
. This is a script that will allow users to make changes to the code that will be detected and recompiled as they are made.
Step 4: Deploy commands
Anytime a command's data
property is modified or a new command is created, use npm run update
to update the command list.
Notes
- Skyline Bot is written in TypeScript to allow for compile-time error checking. Skyline Bot is also written completely using the ECMAScript standard for added concision and convenience.
- To set command permissions beyond the defaults, you'll need to edit them in server settings.