Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 3.16 KB

README.md

File metadata and controls

46 lines (36 loc) · 3.16 KB
Raw

Skylink IF

CodeFactor production staging tests documentation

Brining Infinite Flight to Discord. Check out our website. Also, I want to give credit to velocity23 for his Infinite Flight API Typescript library and Kevin Novak for providing the Discord Bot Typescript Template.

Skylink-IF is an Infinite Flight Discord Bot that is actively being developed. How can we make Infinite Flight more fun for you? Put your ideas here: https://forms.gle/NM17sCK82Wn75K337

Setup

  1. Copy example config files.
    • Navigate to the config folder of this project.
    • Copy all files ending in .example.json and remove the .example from the copied file names.
      • Ex: config.example.json should be copied and renamed as config.json.
  2. Obtain a bot token.
    • You'll need to create a new bot in your Discord Developer Portal.
      • See here for detailed instructions.
      • At the end you should have a bot token.
  3. Modify the config file.
    • Open the config/config.json file.
    • You'll need to edit the following values:
      • client.id - Your discord bot's user ID.
      • client.token - Your discord bot's token.
  4. Install packages.
    • Navigate into the downloaded source files and type npm install.
  5. Register commands.
    • In order to use slash commands, they first have to be registered.
    • Type npm run register to register the bot's commands.
      • Run this script any time you change a command name, structure, or add/remove commands.
      • This is so Discord knows what your commands look like.
      • It may take up to an hour for command changes to appear.

Start Scripts

  1. Normal Mode
    • Type npm start.
    • This runs the bot directly with Node and without shards.
    • Use this mode if you don't need sharding.
  2. Dev Mode
    • Type npm start:dev.
    • This runs the bot with ts-node-dev.
    • Use this mode for general development.
    • TypeScript files are compiled automatically as they are changed.