Skip to content

Monadex-Labs/monadeXP-discord-bot

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

MonadeXP Discord Bot

Discord bot for Monadex's official XP campaign
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

Monadex's official XP program will run in three seasons until the mainnet launch. MXP can be earned by actively engaging the community, preforming tasks/quests, contributing to the project, etc. After launch, MXP will be converted to $MDX (Monadex's governance token) at a ratio which will be decided later on. You can learn more about the XP program here.

With the help of the discord bot, users can track their MXP balances, gift MXP to others, check the leaderboard, and use the bank to earn interest. The bot has some admin exclusive commands for allocating MXP or penalising users for suspicious acts.

Built With

  • JavaScript
  • Discord.js
  • npm

Getting Started

Prerequisites

Ensure that you have git and node.js installed and configured on your system.

Installation

Clone the repo and cd into it

git clone https://github.com/monadex-labs/monadexp-discord-bot
cd monadexp-discord-bot

Install the project's dependencies

npm install .

Fill in all the necessary fields in the .env.example and rename it to .env. Then run the following command to start the bot on your server

npm run bot

That's it, you should be ready to go now.

Usage

In any of the Monadex's official discord channels, you can use /help to learn about the bot and the commands accessible to you.

Roadmap

  • Setup repo
  • Add slash commands
    • Add admin commands
    • Add user commands
    • Add a bank system to earn interest on MXP
  • Add a good README.md

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Here's a gateway to Monadex's socials

Linktree