Skip to content

Latest commit

 

History

History
81 lines (64 loc) · 3.62 KB

SETUP.md

File metadata and controls

81 lines (64 loc) · 3.62 KB
Raw

Setting up for contributing/running the bot

This assumes you are using VSCode as your IDE. If you have errors or issues, you can ask us for help in the #developer channel in the discord server.

Setup

Discord Bot Account

  1. Create a discord bot account in the Discord Developer Portal.
    • Remember the Application ID & Token. Both are used later in Configuration.
    • If you don't save your Token you will have to reset it for a new one.
  2. Ensure your bot has Privileged Gateway Intents > Server Members Intent enabled.

Environment

  1. Install NvM, then use it to install NodeJS v20.15.0 OR install the nodejs version directly.
  2. Install Python used for multiple dependencies.
  3. Install Visual Studio Installer.
    • Install the Community version.
    • Once downloaded select and install Workloads > Desktop development with C++.
  4. Install Postgres 16 and pgAdmin 4 for interacting with postgres (optional, but helpful).
    • Remember the Port Number and Password. Both are used later in Configuration.
  5. Install Yarn using: npm i -g yarn
  6. Clone the repo: git clone https://github.com/oldschoolgg/oldschoolbot.git

Configuration

  1. Make a .env file from the example: cp .env.example .env
  2. Edit this new .env file:
    • Put your test bot's Application ID into the CLIENT_ID field.
    • Put your test bot's Token into the BOT_TOKEN field.
    • Uncomment and enter the Server ID where you want to Administer your bot from into theTESTING_SERVER_ID field. (Skip if using official test server).
  3. Create 2 databases called "osb_test" and "robochimp_test".
    • Using pgAdmin 4 select Servers > PostgreSQL > Databases > Create > Database....
    • Enter the database name into Database and hit Save.
  4. Change DATABASE_URL and ROBOCHIMP_DATABASE_URL in your .env file with the format postgresql://USER:PASSWORD@HOST:PORT/DATABASE_NAME.
  5. Make a config file from the example: cp src/config.example.ts src/config.ts.
  6. Edit this new config.ts file:
    • Copy your Discord ID into both OWNER_IDS and ADMIN_IDS.
    • Enter the Server ID where you want to Administer your bot from in SupportServer.

Finalizing Setup

  1. Run the following commands in the root of the repo:
    • corepack enable
    • yarn
    • npx prisma db push
    • npx prisma db push --schema ./prisma/robochimp.prisma

Running the bot

  1. Run yarn start or yarn watch.

VSCode settings (Optional)

  1. In VSCode, press CTRL+SHIFT+P, search "Open User Settings JSON"
  2. Add this to the file:
  // Format/fix code automatically
  "editor.formatOnSave": true,
  "editor.formatOnPaste": true,
  "editor.codeActionsOnSave": {
    "quickfix.biome": "explicit",
  },
  // Disable telemetry
  "telemetry.telemetryLevel": "off",
  // Always use \n for EOF
  "files.eol": "\n",

Troubleshooting

  • Check your NodeJS/NPM/Yarn/Postgres versions.
  • Uninstall prettier/eslint vscode plugins.
  • Delete these folders: node_modules, dist.
  • Your IDE may need to be ran with admin privileges.
  • "yarn.psl cannot be loaded because running scripts is disabled on this sytem"
    • run this command in a terminal: Set-ExecutionPolicy Unrestricted
  • If either of the npx prisma commands fail in Finalizing Setup you may need to manually create 2 databases called "osb_test" and "robochimp_test".
  • Restarting your PC after Environment steps may be needed.