From 559fa55ded69a828694b26335e7b426f8c99984d Mon Sep 17 00:00:00 2001
From: thom2305 <102167733+thom2305@users.noreply.github.com>
Date: Sat, 22 Mar 2025 16:43:02 -0400
Subject: [PATCH] Create README.md

---
 README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..11e25ea
--- /dev/null
+++ b/README.md
@@ -0,0 +1,70 @@
+# Discord Bot for Error Code Management
+
+This is a Discord bot built using the `discord.py` library that provides functionalities for managing and querying error codes related to a specific service. The bot can respond to commands, check the status of a service, and manage error codes stored in a SQLite database.
+
+## Features
+
+- Query error messages based on error codes.
+- Set and unset the bot's status.
+- Check the status of a service.
+- Uses SQLite for storing error codes and messages.
+- Uses MySQL for managing friend codes.
+
+## Requirements
+
+- Python 3.8 or higher
+- `discord.py` library
+- `python-dotenv` for environment variable management
+- `requests` for making HTTP requests
+- SQLite for database management (for error codes)
+- MySQL connector for managing friend codes
+
+## Installation
+
+1. **Clone the repository** (if applicable):
+   `git clone https://github.com/WiiMart/WiiMartBot.git`
+   `cd WiiMartBot>`
+
+2. **Install the required packages**:
+   `pip install discord.py python-dotenv requests mysql-connector-python`
+
+3. **Create a `.env` file** in the root directory of your project with the following format:
+```
+token=your token here 
+status="Not Set" 
+mqlu=mysqluser 
+mqlp=mysqlpassword 
+mqld=mysqldb 
+mqlu=mysqlurl 
+mqpo=mysqlport
+```
+
+## Usage
+
+1. **Run the bot**:
+`python bot.py`
+
+2. **Commands**:
+- `/status`: Check the current status of the service.
+- `/setstatus <status>`: Set the current status of the bot (requires Admin role).
+- `/unsetstatus`: Unset the current status of the bot (requires Admin role).
+- `/error <error_code>`: Get the error message linked with the specified error code.
+
+## Database Management
+
+The bot uses a SQLite database to store error codes and their corresponding messages. The database is created and populated automatically when the bot starts. 
+
+### Error Codes Format
+
+The error codes are defined in the script and can include:
+- Standalone codes (e.g., `204013`)
+- Ranges (e.g., `204019-204041`), which will be expanded into individual codes.
+- Wildcard codes (e.g., `2056XX`), which can match multiple codes.
+
+## Contributing
+
+If you would like to contribute to this project, please fork the repository and submit a pull request.
+
+## Privacy Notice
+
+This is a private repository and is not to be distributed unless explicit permission from the author or project owner has been given.