README.md

✨ Features

• ⚙️ Fully Customizable: Tailor Majo.exe to your preferences with comprehensive customization options.
• 🌆 Built-in Dashboard: Manage your Majo.exe settings effortlessly through our intuitive dashboard.
• 📝 Easy Configuration: Streamlined configuration process that makes setting up a breeze.
• 💯 150+ Commands: Access over 150 versatile commands to enrich your server's experience.
• 📚 Easy Hosting: Effortlessly host Majo.exe on your servers and keep it online 24/7.

🔗 Invite

Go to this link and add the bot (this requires MANAGE_GUILD permission) to your server.

Or to make it easier, visit our website

🖥️ Hosting

We are hosting Majo.exe on our own servers. Majo.exe will be online 24/7. Invite Majo here!
However, if you want to host Majo.exe yourself, you can do it. Check out our tutorials to learn how to do it.

Important

This project is not for beginners. If you are not familiar with Node.js, Prisma, Discord.js or any other technology used in this project, you should not host Majo.exe yourself!

📝 Tutorials

• 🤖 Bot setup tutorial
• 🔩 Dashboard setup tutorial
• 📝 Database setup tutorial

⚙️ System Requirements

Ensure your setup meets these prerequisites before setting up Majo.exe:

• PostgreSQL 14x or higher
• Node.js 18x or higher
• (Any) Linux x64¹
• ~512MB of RAM (minimum)
• ~3GB of hard drive space (minimum)

Note

1. Debian based distros are recommended, bot can also run on Windows and MacOS but it's not recommended.

🔒 Global .env file

Variable	Description	Required (Bot)	Required (Dashboard)
TOKEN	Discord bot token	✅ Yes	✅ Yes
CLIENT_ID	Discord client ID	✅ Yes	✅ Yes
CLIENT_SECRET	Discord client secret	❌ No	✅ Yes
DATABASE_URL	Main database connection string	✅ Yes	✅ Yes
DATABASE_URL_UNPOOLED	Non-pooling database connection string	❌ No	❌ No
REDIS_URL¹	Redis Cache connection string	❌ No	❌ No
SECRET	Secret string (minimum 32 characters)	❌ No	✅ Yes
NEXTAUTH_URL	NextAuth.js URL (e.g., http://localhost:3000)	❌ No	✅ Yes
NEXT_PUBLIC_URL	Next.js public URL (e.g., http://localhost:3000)	❌ No²	✅ Yes
HOTJAR_ID	Hotjar ID	❌ No	❌ No
DISCORD_SUPPORT_SERVER_ID	Discord support server ID	❌ No	❌ No³
TOPGG_API_KEY	top.gg API key	❌ No	❌ No⁴

Note

1. REDIS_URL enables caching. If you don't want to use Redis caching, leave this variable empty. Majo.exe will use Memory caching instead.
2. NEXT_PUBLIC_URL is required only if you want to also include the dashboard.
3. DISCORD_SUPPORT_SERVER_ID is required only if you want to automatically add users to your own Discord server when they log in to the dashboard. Please note that the bot needs Manage Server permission in the server!\
4. TOPGG_API_KEY is required only if you want to automatically post server count to top.gg.

Warning

There is one global .env file for all projects. Do not create .env file in apps/bot, packages/database or apps/dashboard folders! This can cause problems and potential security issues.

📝 Contributors

• @binary-blazer - Hosting support
• @TsukiyoDevs - Bug fixes, New features, Testing
• @r-kjha - Emoji config support, Bug fixes, New features, Testing
• @Joao-Victor-Liporini - Bug fixes, Command handler improvements, Testing, New features
• @evandev - Bug fixes, Testing
• @krzesl0 - New Features, Bug fixes, Testing
• @_index1337 - Readme tutorials
• @Wafelowski - Translation improvements
• @Sakshyam6966 - New Features, Bug fixes, Testing

💝 Sponsors

These wonderful people and services have helped develop Majo.exe, without them this project would not exist. Thanks goes to these wonderful people!

	Sponsor	Description
	TrestHost	TrestHost is a good and powerful hosting provider providing servers from the USA and Germany. Try us out today!

⛔ Hosting Agreement

By hosting the project, you agree to the following terms:

1. 📜 Attribution:

   • You are not allowed to claim authorship or affiliation with the Majo.exe team.
   • Proper credit must be given to the original author when hosting the project.
   • You are not allowed to use the Majo.exe name or logo in any way that implies affiliation with the Majo.exe team.

2. 💻 Hosting Rights:

   • The bot can be hosted on your server, provided the terms outlined here are respected.

3. 🚧 Modifications:

   • The footer in the Dashboard, such as "Powered by Majo.exe," must not be modified or removed.
   • The /about command must not be modified or removed. This command contains information about the project and its authors.
   • The project's source code must not be modified in any way that would remove or alter the original attribution.
   • The license must be included with any public distribution of the project or its modified source code.

4. 📦 Distribution:

   • You may not distribute the bot or its modified versions without adhering to the terms mentioned in this agreement.
   • Any public release or distribution must include clear attribution to the original author and a link to the original repository or source.

5. ⚖️ Compliance:

   • Failure to comply with these terms may result in a violation of the agreement.
   • Legal action may be taken if these terms are not respected.

⁉️ Issues

If you have any issues with the page please create new issue here. When creating new issue please provide as much information as possible. If you can, please provide logs from console.

We will review your pull request as soon as possible. We might suggest some changes or improvements.

📥 Pull Requests

When submitting a pull request:

• Clone the repository (git clone https://github.com/igorkowalczyk/majo.exe)
• Create a branch off of master and give it a meaningful name (e.g. my-awesome-new-feature).
• Open a pull request on GitHub and describe the feature or fix.

📋 License

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

The cake is a lie 🍰