Installation - Ganyu-Studios/stelle-music GitHub Wiki

• Trying to run Stelle? Here are a few brief steps.
• Also make sure you have the minimum requirements.

git clone https://github.com/Ganyu-Studios/stelle-music.git

# Or if you want to get the latest (and experimental) features (not recommended), use:

git clone https://github.com/Ganyu-Studios/stelle-music.git --branch dev

cd stelle-music
pnpm i

• Stelle needs some environment variables to work.

1. Copy the .env.example file. (located in the root of the project)
2. Rename the file to: .env.
3. Fill the required variables. (available variables)

• Stelle uses Prisma ORM to manage the database.
• And also uses Redis as alternative cache.

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

1. Run pnpm generate to generate the types

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

• 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
    ...
];

• 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

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