aboutsummaryrefslogblamecommitdiff
path: root/readme.md
blob: 8f3da56188af2ded5a151f978e86b9e6982f4d56 (plain) (tree)
1
2
3
4
5
6
7
8
9
10


                               
                                                                                                                                  
 
                                                                          
 
                                                                                                                              

       
                              
                   
                                         
     

   
                                                                                               
 
                                                                                              
 

                                                                                                                          
 
                                                                                                                         
                                                      













                                                                 





                                                                    
                                                                                
                                                                
   
# Minecraft Bedrock Discord Bot

## How to
Launch the bot with `python3 main.py` and you're ready to go, unless dependencies are missing. These are google cloud and discord.

Install the dependencies with `python -m pip install -r requirements.txt`.

A few "dangerous" commands such as `!purge` are restricted to `bot_masters`. You can add botmasters in `config.json`. Example:
```json
{
    "token": "your_bot_token",
    "<guild_id>": {
        "bot_masters": <users_discord_id>
    }
}
```
`guild_id` is the ID of the discord server in the form of a string while user IDs are integers.

You can also use lists, for example: `"bot_masters": [280428276810383370, 99457716614885376]`.

A user added as a botmaster will be able to edit the config via discord with the command `!setvar <var_name> <var_value>`.
`!setvar` also supports lists which can be added like so: `!setvar <var_name> [<index 0>, <index 1>]`.

This bot was built as a fork of [celesteBot](https://github.com/CelesteClassic/celestebot), so a lot of code is recycled.
Feel free to make a pull request or use the code here.

## Container

The discord bot can be ran into a container as well. To build the
container simply run

```sh
podman build -t steve-bot .
```

And to start it

```sh
podman run \
    --volume="./blacklist.json:/app/blacklist.json:rw"\
    --volume="./api_keys.json:/app/api_keys.json:rw"\
    --volume="./config.json:/app/config.json:rw" \
    --volume="./custom_commands.json:/app/custom_commands.json:rw" \
    --volume="./fair.json:/app/fair.json:rw" \
    --volume="./runs_blacklist.json:/app/runs_blacklist.json:rw" \
    --volume="./required_block_states.json:/app/required_block_states.json:rw" \
    --name steve-bot --restart no --replace -it steve-bot:latest
```