A good start
makes a difference.
Everything you need to understand Envy’s current bot and get the project running.
Bring Envy to your server
Envy is a TypeScript Discord bot. To run the project, you’ll need Node.js, a Discord application, and PostgreSQL for the persistent economy.
Invite Envy
Use the bot invite link once the project owner configures it. Envy needs the bot and applications.commands scopes.
Set up the database
The economy needs PostgreSQL. The bot stores each server's accounts and reward cooldowns separately.
Publish commands
Register the slash commands with the deployment script. Use a development server ID for faster testing.
Try a command
Run /help to browse the available commands, then try /daily, /work, or /balance in your server.
npm install
npm run db:generate
npm run db:migrate
npm run deploy:commands
npm run devCopy .env.example to .env and fill in your Discord token, application ID, and database URL. Keep secrets private and never commit .env.
Find your way around
Envy uses Discord slash commands, so options and descriptions are built into Discord. Start with /help or browse the command directory .
Every server stands on its own
Balances and reward cooldowns are scoped to a Discord server. Rewards are stored in PostgreSQL; transfers check the sender’s balance and update both members in one database transaction.
The economy currently starts with green coins and default rewards. A dashboard for custom settings is not available yet.
Honest about what ships
Currently available: help, profile, server and user information, balances, daily and weekly rewards, work, payments, and the economy leaderboard.
Shop, inventory, games, progression, moderation, website sign-in, and server configuration are future work. They are not active features yet.