Skip to content

Latest commit

 

History

History
73 lines (55 loc) · 2.87 KB

README.md

File metadata and controls

73 lines (55 loc) · 2.87 KB

Elytro

Elytro is a fun and robust Discord bot that brings a bunch of cool features to your server. Whether you’re running a busy community, hanging out with friends, or looking to add some friendly competition, Elytro has you covered with it's wide range of plugins.

Plugins

Economy

Elytro includes a comprehensive economy system, perfect for adding fun and competitiveness to your server. With this plugin, users can:

  • Earn money through actions like working, begging, digging, and gambling.
  • Spend money in the shop to buy items and enhance their status.
  • Even rob or compete with friends to see who can build the most wealth!

Moderation

Keep your server under control with Elytro's Moderation plugin. Manage members, channels, and messages effortlessly:

  • Warn, kick, or ban members who break the rules.
  • Lock or unlock channels to manage access during important events.
  • Purge messages in bulk to keep chat clean.
  • Use advanced tools to make server moderation easy and effective.

Saluter

Welcome new members and bid farewell to those leaving with the Saluter plugin:

  • Sends customizable messages when a user joins or leaves a server.
  • Helps create a friendly, engaging environment for all members.

Fun

Bring entertainment to your server with the Fun plugin:

  • Minigames like trivia and other challenges.
  • Practical tools like /weather for weather forecasts and /dictionary for quick definitions.
  • Additional commands like /wya and /joke.

Leveling

Boost engagement with the Leveling plugin:

  • Track user activity and award XP for participation.
  • Users can level up by being active in the server.
  • Includes a leaderboard to encourage friendly competition.
  • Generate personalized level cards for each user to showcase their progress.

Installation

Run the following command to clone the repository.

git clone https://github.com/ElytroBot/Elytro

Then install the needed dependencies.

npm install

Environment Variables

To use this bot you must first define some environment variables. First create a .env file and set the following environment variables.

Variable Description
TOKEN Your Discord bot's token.
CONNECTION_STRING The MongoDB connection string for your database.
APPLICATION_ID Your Discord bot's Application ID.
WEATHER_API_KEY Your Weather API key.
RAPID_API_KEY Your Rapid API key.

Run Locally

To run the bot locally use the following command.

npm run dev