BleachBot README

Welcome to the BleachBot project. This guide will help you set up, run, and update the bot on your system.

Prerequisites:

1. Node.js: Ensure you have Node.js installed. If not, download and install it from Node.js official website.

2. GitHub Desktop: This tool makes it easy to manage and update the project. If you haven't installed it yet, download and set it up from GitHub Desktop's official website.

Steps to Run the Bot:

1. Downloading the Bot:

1. Open GitHub Desktop.
2. Go to File -> Clone Repository.
3. In the URL section, paste: https://github.com/Trameurs/BleachBot.
4. Choose a local path where you want the bot's files to be saved.
5. Click Clone.

2. Setting up the Bot:

1. Navigate to the bot's local directory (the path you chose during cloning).

2. Open the .env file and set up your bot token and client id (ask the developer).

3. Open a terminal or command prompt in this directory. You can do this by right-clicking inside the folder while holding the Shift key and selecting Open command window here.

4. Run the following command to install the bot's dependencies:

   npm install
   

3. Running the Bot:

1. In the same terminal or command prompt window, start the bot by running:

   npm run dev
   

2. If everything is set up correctly, you should see a message indicating that the bot is online. (last message should be Successfully reloaded X application (/) commands.)

4. Updating the Bot:

To ensure you have the latest version of the bot:

1. Open GitHub Desktop.
2. Select BleachBot from the list of repositories on the left.
3. Click on the Fetch origin button on the top to check for updates.
4. If updates are available, click on the Pull button to download them.
5. Once updated, follow the steps in the "Running the Bot" section to restart it.

Adding New Data to the Bot:

BleachBot is equipped with a rich dataset that powers its features. To expand the capabilities of the bot or to keep it updated, you can add new characters, attacks, weapons, items and quiz questions. Below is a step-by-step guide on how to do so. As soon as you save the file with your new data, it will be available in game.

1. Adding New Characters:

1. Navigate to the characters.json file in your repository inside data.

2. Under the CHARACTERS array, you can add a new character by following the structure:

   {
       "id": 1, // Increment by 1 from the last character
       "name": "Character Name",
       "title": "Character Title",
       "rank": "Rank",
       "form": "Character Form",
       "attacks": [
           "attack_id_1",
           "attack_id_2",
           "attack_id_3",
           "attack_id_4"
       ],
       "power": 1234
   }
   

3. Make sure to also add their attacks under the ATTACK array if they have unique attacks not previously listed.

4. Add an image to your character by naming it by its "id", the image need to be either a "jpg", "png" or "webp" and be saved in the "images" folder.

2. Adding New Items:

1. Navigate to the items.json file.

2. For adding weapons, add a new entry under the WEAPONS array:

   {
     "id": "W3", // Increment the number, keep "W" (as in Weapon)
     "name": "Weapon Name",
     "power": 5678
   }
   

3. For other items, add under the ITEMS array:

   {
     "id": "I3", // Increment the number, keep "I" (as in Items)
     "name": "Item Name",
     "power": 5678
   }
   

3. Adding New Quiz Questions:

1. Navigate to the quiz.json file.

2. Add a new question entry in the format:

   {
     "question": "Your Question Here?",
     "answers": ["Option 1", "Option 2", "Option 3"],
     "correct": "Correct Answer" //The "correct" answer need to be the exact same words as one of "answers"
   }
   

3. Ensure the correct answer exists in the answers array.

You can also modify any character/item/quiz, but don't touch the "id".

4. Saving the new data to GitHub

Once you've added the new data, you can commit your changes (to save it online) using GitHub Desktop:

1. Open GitHub Desktop and navigate to the BleachBot repository.
2. Review your changes and make sure everything looks right.
3. Write a brief summary of your changes in the left sidebar.
4. Click Commit to main (or your relevant branch).
5. Click Push origin to update the remote repository.

If you encounter any issues or have questions, please contact the developer.