@purinton/modify

@purinton/modify

A modern Discord moderation and utility bot built with Node.js, based on the @purinton/discord foundation. It provides advanced moderation using OpenAI, multi-language support, and a modular command/event system for easy customization.

Table of Contents

• Features
• Getting Started
• Configuration
• Running as a Service (systemd)
• Docker
• Customization
  • Commands
  • Events
  • Locales
• Testing
• Support
• License

Features

• Discord.js-based app with ESM support (native ES modules)
• Modular command and event handler architecture for easy extension
• Multi-language/localized responses with JSON locale files
• AI-powered moderation using OpenAI's moderation API (text and image support)
• Environment variable support via dotenv for secure configuration
• Logging and signal handling via @purinton/common
• Ready for deployment with systemd or Docker
• Jest for unit and integration testing
• Database support for log channels and localization (MySQL)
• Easy to add or modify commands, events, and languages

Getting Started

• Clone this project:

  git clone https://github.com/purinton/modify.git
  cd modify
  npm install
  

• Set up your environment:

  • Copy .env.example to .env and fill in your Discord app token, OpenAI key, and database credentials.

• Start the app locally:

  npm start
  # or
  node modify.mjs
  

Configuration

• All configuration is handled via environment variables in the .env file.
• Required variables include your Discord bot token, OpenAI API key, and MySQL database connection info.
• See .env.example for required and optional variables.
• Before running the bot, you must create the required database table.

Database Setup

The bot requires a MySQL table named log_channels for logging moderation events and storing guild locales. This table is not created automatically.

To create the table, import the provided schema.sql file into your MySQL database:

mysql -u <username> -p <database> < schema.sql

Replace <username> and <database> with your MySQL username and database name. You will be prompted for your password.

The schema.sql file contains:

DROP TABLE IF EXISTS `log_channels`;
CREATE TABLE `log_channels` (
  `guild_id` varchar(32) NOT NULL,
  `channel_id` varchar(32) NOT NULL,
  `guild_locale` varchar(12) NOT NULL,
  PRIMARY KEY (`guild_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;

Running as a Service (systemd)

• Copy modify.service to /usr/lib/systemd/system/modify.service.

• Edit the paths and user/group as needed.

• Reload systemd and start the service:

  sudo systemctl daemon-reload
  sudo systemctl enable modify
  sudo systemctl start modify
  sudo systemctl status modify
  

Docker

• Build the Docker image:

  docker build -t modify .
  

• Run the container:

  docker run --env-file .env modify
  

Customization

Commands

• Add new commands in the commands/ directory.
• Each command has a .json definition (for Discord registration/localization) and a .mjs handler (for logic).
• Example: To add a new moderation command, create commands/yourcommand.json and commands/yourcommand.mjs.

Events

• Add or modify event handlers in the events/ directory.
• Each Discord event (e.g., ready, messageCreate, interactionCreate) has its own handler file.
• You can add support for new Discord Gateway events by adding a new handler file.

Locales

• Add or update language files in the locales/ directory.
• Localize command names, descriptions, and app responses.
• All locale files must match the keys in en-US.json for consistency.

Testing

• Run tests with:

  npm test
  

• Add your tests in the tests/ folder or alongside your code.

• Jest is configured for ESM and will automatically find .test.mjs files.

Support

For help, questions, or to chat with the author and community, visit:

Purinton Dev on Discord

License

MIT © 2025 Russell Purinton

Links

• GitHub Repo
• GitHub Org
• GitHub Personal
• Discord