Zeltux

An open-source Discord bot designed to enhance community interaction with a variety of engaging and useful features.

Features

• 🎉 Fun Commands
• 🛠️ Moderation Tools
• 🔧 Utility Functions
• 🎮 Minecraft Integration
• 🌐 And Much More!

Support Server

For any assistance, join our support server:

Commands

ℹ️ Info

• /botinfo
• /help
• /ping
• /roleinfo
• /serverinfo
• /userinfo
• /level
• /leaderboard

🎈 Fun

• /8ball
• /catfact
• /coinflip
• /dadjoke
• /dogfact
• /joke
• /meme
• /pp
• /randomnumber
• /trivia

🔨 Moderation

• /ban
• /clear
• /kick
• /lock
• /nick
• /timeout
• /unban
• /unlock
• /untimeout
• /warn
• /warnings

🪛 Utility

• /calculator
• /define
• /todo
• /translate
• /weather

🪛 Admin

• /giveaway
• /leveladmin
• /welcome
• /guildsettings
• /autorole

🌎 Minecraft

• /achievement
• /addserverstatus
• /bodyavatar
• /fullbody
• /headavatar
• /listserverstatus
• /playerhead
• /removeserverstatus
• /serverstatus
• /skin

Quick Setup

1. Clone the Repository

Clone the repository and navigate to the project folder:

git clone https://github.com/RedolentHalo/Zeltux.git
cd Zeltux

2. Install Dependencies

Ensure you have Node.js installed. Then, install the required dependencies:

npm install

3. Run the Setup Script

In the root of the project, run the following command to set up your configuration:

npm run setup

The script will prompt you to enter your configuration details interactively.

4. Enter Your Configuration Details

The setup.js script will ask for the following details:

• Bot Token: Your bot's token from the Discord Developer Portal.
• Client ID: The client ID of your bot.
• Weather API Key: The API key for the weather service you're using.
• MongoDB Connection String: The connection string for your MongoDB database.

These details will be saved in a config.json file.

5. Run the Bot

Start the bot with the following command:

npm run start

Contributing

Contributions are welcome! Feel free to submit a pull request or open an issue.

Code of Conduct

We strive to maintain a friendly, inclusive, and respectful community. Please follow these guidelines:

• Be Respectful: Treat others with respect. Disagreements are okay, but be civil.
• Be Inclusive: We welcome all contributions and encourage participation from everyone.
• Be Supportive: Help others when they have questions and be open to feedback.

If you experience or witness unacceptable behavior, please report it to the maintainers of this project.

License

This project is licensed under the MIT License. See the LICENSE file for details.

To-Do List

• Server logs system
• Enhance Minecraft integration features
• Suggestions? Feel free to share in the Support Server