Skip to content

Latest commit

 

History

History
106 lines (78 loc) · 2.8 KB

INSTALLATION.md

File metadata and controls

106 lines (78 loc) · 2.8 KB
Raw

⚙️ Installation

  • Trying to run Stelle? Here are a few brief steps.
  • I will assume you have the requirements to even get started.

📋 Clone the repo

  • There is not much science on this.... Right?
git clone https://github.com/Ganyu-Studios/stelle-music.git

📋 Install Dependencies

  • There is not much science on this.
cd stelle-music
pnpm i

📋 Database

  • Stelle uses Prisma ORM to manage the database.

When prisma is installed the first time (or update prisma) prisma needs to generate the types to work.

  1. Run pnpm prisma generate to generate the types

This also applies when you make changes in the schema, you need to generate the new types.

Note

You can execute also pnpm prisma db push to synchronize the database.
This needs to be executed when you make changes in the schema (It's not mandatory, but I recommend it.)

📋 Environment Variables

  • Stelle needs some environment variables to work.
  1. Copy the .env.example file. (localed in the root of the project)
  2. Rename the file to: .env.
  3. Fill the required variables. (available variables)

Important

You need to follow the DATABASE_URL example url format.
You can learn more about the prisma url format here

📋 Configuration

  • Stelle has a configuration to save a specific data.
  1. Go to the configuration
  2. Replace the IDs with your IDs.

Example:

guildIds: [
    "123", // Example guild id
    "456", // Another example guild id
    ...
];
  • Don't forget to change the channel ids.
  1. Go to the configuration
  2. Replace the IDs with your IDs.
channels: {
    guildsId: "1234", // Example channel id
    errorsId: "45678", // Another example channel id
}
  • Don't forget to change the user ids.
  1. Go to the configuration
  2. Replace the IDs with your IDs.
developerIds: [
    "1234", // Example user id
    "5678", // Another example user id
    ...
];

📋 Traspile and Run

  • Stelle is made in Typescript but she can runs in Javascript.

Run the bot in Javascript

pnpm clean # Will re-create the dist folder
pnpm start # Will start the bot

Run the bot in Typescript

# Run it!
pnpm dev

🔎 Looking for a lavalink node?

Stelle needs a Lavalink node to play music.
See self hosting a node for more.