Moa-Bot

TUT Moa Bot

---

❓ What does it do?

Discord bot for TUT Server. Math utils and daily integral helpers.

---

💠 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 (>= v22.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/Moa-Bot.git && cd Moa-Bot
   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 OR use npm run generate-config.
   
   
5. Configure it in your favourite editor by editing config/config.custom.js.
   
   
6. [LINUX ONLY]: Install LaTeX dependencies:
   $ sudo ./setup_latex.sh
   
   
7. Start it in development mode by running
   $ npm start
   or start in production mode
   $ npm run start:prod
   or (recommended), use PM2
   $ pm2 start pm2.ecosystem.json
   
   

---

🔩 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
discord: bot_owner_ids	OPTIONAL: Discord IDs of Bot owners	String-Array	[]
discord: wolfram_appid	OPTIONAL: Wolfram Alpha App ID	String	N/A
discord: total_shards	Number of shards to use or "auto" for automatic sharding	number | "auto"	1
ids: guild_id	ID of the main server where special features are enabled	string	N/A
ids: daily_int_channel	ID of the daily integral channel	string	N/A
ids: meme_channel	ID of the meme channel	string	N/A
ids: general_channel	ID of the general channel	string	N/A
ids: daily_int_role	ID of the daily integral role	string	N/A
ids: moabot	ID of the Moa Bot user	string	N/A

---