Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 1.61 KB

README.md

File metadata and controls

68 lines (46 loc) · 1.61 KB

Introduction

Frost is a personal Discord bot. It handle music, booster roles, snowball fights, and more.

Installation

Ruby version 3.3, a PostgreSQL database, a Lavalink node, and Docker is needed to run the bot.

  1. Install the latest version of Ruby

This should be fairly self-explanatory. See here for instructions.

  1. Install dependencies

Simply do: bundle install.

  1. Create the database in PostgreSQL

You'll need to be using PostgreSQL 14 or higher. If you want an easy solution, Neon is a great choice. Type the following into the PostgreSQL manager:

CREATE ROLE frost WITH LOGIN PASSWORD 'yourpasswordhere';
CREATE DATABASE frigid OWNER frost;
  1. Fill in configuration variables

Change the name of the example.yml file to config.yml and lavalink.yml to application.yml and fill in all the variables.

# Discord related credentials.
Discord:
  OWNER: "YOUR_ID_HERE"
  TOKEN: "Bot TOKEN_HERE"
  CONTRIBUTORS: []

# Information about the Lavalink node.
Lavalink:
  ID: ""
  URL: ""
  TOKEN: ""

# Information about a manga chapter.
Chapter:
  LINK: ""
  CHANNEL: ""
  ELEMENT: ""

# Holds information about houses.
Houses:
  GUILD: ""
  STAFF: []

# Database related credentials.
Postgres:
  URL: "postgres://URI_HERE"

Many of these variables are undocumented because the bot is meant for personal use.

  1. Run the bot

Either build the Dockerfile, or do: bundle exec ruby --yjit core.rb.

ToS and Privacy Policy

I'm required to have one of these. No private information is stored.