README.md

Prism v3 - the final version

---

Welcome to the Prism v3 repository, hosting the code for Prism v3.
Prism is a self-hosted bot, but it also has a public instance hosted by me (invite).

---

🧰 Setup

Before you start the setup process, you need to install the needed requirements.
Please note these commands may change depending on your environment.

You require the following (before being able to continue at all):

• Python 3.9+ (latest is recommended); download it from python.org
• Git; download it from git-scm.com

The following script should setup the base repository:

git clone https://github.com/iiPythonx/Prism-v3
cd Prism-v3
python3 -m pip install -r reqs.txt
mv example_config.json config.json

🔧 Configuration

Before you actually use Prism, you need to configure it.
This process requires both a .env file as well as a config.json file.

To setup the .env, grab your discord bot token, and place it like so:

TOKEN = "YOUR DISCORD BOT TOKEN"

The config.json should look like the following:

{
    "admin": {
        "owner": "Somebody#0001",
    },
    "paths": {
        "db_dir": "db",
        "cmd_path": "prism/cmds"
    },
    "status": {
        "watching": ["Twitch.tv"],
        "playing": ["Minecraft"],
        "enabled": true
    }
}

The following are required:

• admin/owner, which is used in the help command (among other places)
• paths/db_dir, the database folder location
• paths/cmd_path, the command folder location

The rest of the options are up to you to tweak on your own accord.
Launching the bot is as simple as running python3 launch.py

For more configuration, please consult the wiki.

---

👥 Credits

iiPython	DmmD	Emy

📝 License

Prism is listed under the MIT license, more information here.
LICENSE.txt contains the raw license.