Files
star-kitten/packages/eve-bot/README.md
2025-10-06 23:31:31 -04:00

2.0 KiB

Star Kitten Discord Bot

A Discord bot for EVE Online.

Click this link to use this bot!

Running the Bot

This bot runs on Bun! To install, run one of the following commands.

Linux & MacOS

curl -fsSL https://bun.sh/install | bash

Windows

powershell -c "irm bun.sh/install.ps1 | iex"

Install dependencies.

bun install

star-kitten-lib has not been published, so link to it locally before running this web project.

cd star-kitten-lib
bun link
cd ../web
bun link star-kitten-lib

Download static eve reference data & Hoboleaks archive from EVE Ref.

cd star-kitten-lib
bun get-data

Initialize the sqlite database

cd star-kitten-lib
bun generate-migrations
bun migrate

Drizzle's migrations seems to fail on the first try sometimes, so just grab the .sql from the generation and run those against the kitten.db file to create the tables & indexes.

Run the bot

Run the bot locally.

bun run dev

Environment Variables

Create a .env file in the root directory with the following values:

#General
BASE_URL=http://localhost:3000
DEBUG=true
PORT=3000
NODE_ENV=development
LOG_LEVEL=debug


# EVE - https://developers.eveonline.com/applications
EVE_CLIENT_ID=YOUR_EVE_CLIENT_ID
EVE_CLIENT_SECRET=YOUR_EVE_SECRET
EVE_CALLBACK_URL=http://localhost:3000/auth/callback
ESI_USER_AGENT=ADD_YOUR_USER_AGENT_INFO_HERE

#Discord - https://discord.com/developers/applications
DISCORD_APP_ID=YOUR_APP_ID
DISCORD_CLIENT_SECRET=YOUR_CLIENT_SECRET
DISCORD_PUBLIC_KEY=YOUR_PUBLIC_KEY
DISCORD_BOT_TOKEN=YOUR_BOT_TOKEN

# ID of a test server to have immediate command refreshes
DISCORD_TEST_GUILD_ID=YOUR_TEST_SERVER_ID

# For using Janice's Appraisal API
JANICE_KEY=XXX

# For using Perplexities AI API
PERPLEXITY_API_KEY=XXX