oakatsume/arithmetica-bot

Discord Bot for counting. Allows arithmetic expressions.

Arithmetica-Bot

Discord Bot for counting. Allows arithmetic expressions.

---

❓ What does it do?

Your average counting bot. Except you can count with arithmetic expressions!

---

📡 Invite the bot

_{The link above will invite a bot hosted by me that uses the latest version of this repo.
Alternatively you can host the bot yourself. Instructions below ⏬}

---

⭐ Features

• Set a counting channel via slash commands
• Count normally (1, 2, 3, 4)
• Count with arithmetic expressions (5^0, sqrt(4), i^2+4, log(10000, 10))
• Slash commands
• Arithmetic is toggleable
• Multi-language support (Can be set on every Discord server individually)
  • English (Peer reviewed ✅)
  • German (Peer reviewed ✅)
  • French (Peer reviewed ✅)
  • Spanish
  • Japanese
  • Chinese
  • Russian
• Easy to set up
  • Set the channel and you're good to go (/set-channel)
  • Optionally, set server language (/set-language)
  • Optionally, disable arithmetic (/toggle-arithmetic)
• Easy to self-host
  • No external database needed
  • Easy configuration system
  • Install instructions provided below
• Admin only commands
• Prevent persons from counting multiple times in a row
• Configurable timeout for losers (Planned)

---

💠 Feature requests & Issues

Feature request or discovered a bug? Please open an Issue here on GitHub.

---

🔧 Setup

0. Open up your favourite terminal (and navigate somewhere you want to download the repository to).
   
   
1. Make sure you have NodeJS installed (>= v20.0.0). Test by entering
   $ node -v
   If this returns a version number, NodeJS is installed. If not, get NodeJS here.
   
   
2. Clone the repository and navigate to it. If you have Git installed, type
   $ git clone https://github.com/NullDev/Discord-RoleShop.git && cd Discord-RoleShop
   If not, download it here and extract the ZIP file.
   Then navigate to the folder.
   
   
3. Install all dependencies by typing
   $ npm install
   
   
4. Copy config/config.template.js and paste it as config/config.custom.js
   
   
5. Configure it in your favourite editor by editing config/config.custom.js. OR use npm run generate-config
   
   
6. Start it in development mode by running
   $ npm start
   or start in production mode
   $ npm run start:prod
   
   

---

🔩 Configuration

Once the config has been copied like described in Step 4, it can be changed to your needs:

Config Key	Description	Data Type	Default value
discord: bot_token	Auth Token of the Discord bot. Can be created here.	String	N/A

---