AliceAM

Alice AutoModeration is at your service.
Support Server

What is Alice?

Alice Is an AutoModeration (AM) bot designed for Discord.
It was built with the idea of having a main "Alice" Which anyone at all can invite
But also a bot, which anyone can easily selfhost and add their own plugins to without much difficulty or even modify the bot's code entirely.

Features

AliceAM has a variety of Qualities and Features, some of which include

AutoModeration
A Webgui (WIP)
An API (WIP)
Easily able to add custom commands/plugins
No obfuscation of code
Easy to setup

How do I selfhost Alice?

Step 1. Have/Get a Discord Bot Token.
If you don't have this token, you can get it at The Discord Developer portal by clicking "new application"

Step 2. Clone this repository into a directory of your choosing which we have permission for.

Step 3. Run main.py using Python 3.11 (higher/lower versions of python untested)
You can do this by running the following command in the terminal

python3.11 main.py

Step 4. It will take you through a setup process if this is the first time you've ran the program
It will ask for the following information.

The token you got in step 1
Prefix you want the bot to use (Default is !!)
If you want to use PostgreSQL for data storage or Json files (Postgre Recommended)

Assuming you decide to setup PostgreSQL, It will ask for the following information

Host of the PostgreSQL server
Port of the PostgreSQL server
The username Alice should use to connect to the database
The password associated with the username
The name of the database Alice should use

However, if you do not use Postgre, there is no further setup.
If you are unlucky, you may have to manage file restrictions however as it will default to Json files for memory.

Setting up Data Storage

Alice Has the option of using 2 methods of storage.
Option 1 is through Json files. This is the fallback should PostgreSQL not be setup.
Otherwise, we have Option 2. PostgreSQL.

To setup Option 1 (Json files), Simply tell the setup that you don't want to use PostgreSQL.
It'll do what's left.

To setup Option 2 (PostgreSQL Database), Tell the setup you want to use PostgreSQL
It'll handle asking data from you and setting up the database for you.

Handling setup errors

If for some reason, the setup crashes and you can't make it work, then do this handling.
In a secrets.env file in the root directory
Enter the following details, changing the placeholders with what they should be.

TOKEN=YOUR_TOKEN
DB_HOST=YOUR_HOST_MACHINES_IP_OR_DOMAIN
DB_PORT=YOUR_HOSTS_PORT
DB_USERNAME=YOUR_DB_USERNAME
DB_PASSWORD=YOUR_SECURE_PASSWORD

It is recommended you don't use the root account for the DB username, but I won't stop you.
If you don't intend to use PostgreSQL, then you can choose not to include the DB_HOST, DB_PORT, DB_USERNAME, and DB_PASSWORD fields or leave them as blank

Once that is done, in the root directory, make a file called settings.json
It should look like this

{
    "use_postgre": false,
    "first_start": false,
    "prefix": "!!"
}