NamVr Chat Economy

An open-source (FOSS) alternative to Discord Chat Economy bots in popular servers that has various events to be triggered randomly in your chat, based on confidence scores of chat activity. Events include math equations, unscramble the word, speed clicker, and more!
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

Coming Soon!

(back to top)

Built With

• Discord.js
• Node.js
• Typescript

(back to top)

Getting Started

To get started, you should have node.js & npm installed. (Node.js 16.9.0 or newer is required) To get a local/server copy up and running, follow these simple example steps.

Installation

1. Clone the repository to get started.

   git clone https://github.com/NamVr/Chat-Economy-Bot.git

2. Install NPM packages.

   npm install

3. Initialize your project.

   npm run init

   You have to follow the steps in the init script. Input your token, client_id, owner_id and guild_id. The script will automatically create config.json & database for you. ⚠️ This is a one-time setup!

4. Setup your config.json's settings according to your server variables. Make sure to also get a Wordnik API Key to setup apis >> wordnik in the configuration.

5. You should be all set as of now, start your bot!

   npm start

(back to top)

Usage

Coming Soon!

For more examples, please refer to the Documentation

(back to top)

Contributing

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

If you have a suggestion that would make this project 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

(back to top)

License

Distributed under the Apache-2.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Naman Vrati - @namanvrati - [email protected]

Project Link: https://github.com/NamVr/Chat-Economy-Bot

(back to top)

---