Skip to content

Commit bc4610a

Browse files
committed
docs(README): README.md got reverted
1 parent 07a7a24 commit bc4610a

File tree

1 file changed

+61
-13
lines changed

1 file changed

+61
-13
lines changed

README.md

+61-13
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,49 @@ More feature coming soon!
4242

4343
### Self-Hosting
4444

45-
> **NOTE**: Python 3.8+ is required to host this bot!
45+
#### Docker
46+
47+
- Install [Docker](https://docs.docker.com/install/) and [Docker-Compose](https://docs.docker.com/compose/install/)
48+
- Create `docker-compose.yaml` file or use the one from [`docker/compose-examples`](./docker/compose-examples):
49+
50+
```yaml
51+
version: "3"
52+
53+
services:
54+
bot:
55+
container_name: zibot
56+
image: ghcr.io/ziro-bot/z3r0:latest
57+
volumes:
58+
- "./data:/app/data"
59+
- "./config.py:/app/config.py"
60+
```
61+
62+
- Then run:
63+
64+
```zsh
65+
docker-compose up -d
66+
67+
# or if you want to use one of the sample yaml file
68+
docker-compose -f docker/compose-examples/basic/docker-compose.yml up -d
69+
```
70+
71+
> Since 3.5.0, ziBot support environment variables, added specifically for Docker
72+
73+
| Env | Json | Description |
74+
|-----|------|-------------|
75+
| ZIBOT\_TOKEN | token | **REQUIRED**. Discord Bot's token, without it you can't run the bot at all. You can get it on https://discord.com/developers/applications |
76+
| ZIBOT\_DB\_URL | sql | **REQUIRED**. The bot's database url. Format: `DB_TYPE://PATH_OR_CREDENTIALS/DB_NAME?PARAM1=value&PARAM2=value`, you can visit [TortoiseORM's documentation](https://tortoise.github.io/databases.html#db-url) to learn more about it |
77+
| ZIBOT\_BOT\_MASTERS | botMasters | Separated by spaces. The bot's master(s), allows listed user(s) to execute master/dev only commands. By default it'll get whoever owns the bot application |
78+
| ZIBOT\_ISSUE\_CHANNEL | issueChannel | Channel that the bot will use to send reported errors |
79+
| ZIBOT\_OPEN\_WEATHER\_TOKEN | openweather | Token for OpenWeatherAPI, only required if you want to use the weather command |
80+
| ZIBOT\_AUTHOR | author | Change the bot's author name (and tag) shown in the info command |
81+
| **CURRENTLY NOT AVAILABLE** | links | Change the links shown in the info command |
82+
| **CURRENTLY NOT AVAILABLE** | TORTOISE\_ORM | Advanced TortoiseORM configuration, you shouldn't touch it if you're not familiar with TortoiseORM |
83+
| ZIBOT\_INTERNAL\_API\_HOST | internalApiHost | The bot's [internal API](https://github.com/ZiRO-Bot/RandomAPI) |
84+
85+
#### Manual
86+
87+
> **NOTE**: Python 3.10+ is required to host this bot!
4688

4789
- Download this repository by executing `git clone https://github.com/ZiRO-Bot/Z3R0.git`
4890
or click "Code" -> "Download ZIP"
@@ -52,10 +94,8 @@ More feature coming soon!
5294
# Windows
5395
py -m pip install poetry
5496
55-
# Linux / MacOS / other Unix-based
97+
# Linux
5698
python3 -m pip install poetry
57-
# or (make sure it's python 3.8+)
58-
python -m pip install poetry
5999
```
60100

61101
- After poetry successfully installed, execute this command to install all required dependencies,
@@ -73,14 +113,14 @@ More feature coming soon!
73113

74114
- Copy and paste (or rename) [`config.py-example`](./config.py-example) to `config.py`
75115
- Edit all the necessary config value (`token`, `botMasters`, and `sql`)
76-
- Run the bot by executing this command, `poetry run python .`
116+
- Run the bot by executing this command, `poetry run bot`
77117
- If everything is setup properly, the bot should be online!
78118

79119
### Development
80120

81121
- Install poetry `pip install poetry` then run `poetry install`
82122
- Run `poetry run pre-commit install`
83-
- To run the bot executing this command, `poetry run python .`
123+
- To run the bot executing this command, `poetry run bot`
84124

85125
## Changelog
86126

@@ -94,20 +134,28 @@ Moved to [CHANGELOG.md](./CHANGELOG.md)
94134
- Channel manager commands
95135
- Reaction Role (With buttons... button role?)
96136
- Starboard
97-
- Docker thingy for easier way to host the bot
98-
- Replace mute with the new timeout feature from Discord
137+
- Slash and ContextMenu commands (80% complete)
138+
- Button-based (or Modal-based?) bot settings
139+
- Setup Tests using dpytest
99140

100141
### Pending Plan
101142

102-
- i18n using gettext (Learning how gettext works)
103-
- Slash command (Waiting for implementation)
143+
- i18n using gettext
144+
Currently still figuring out how to actually implement gettext
145+
- Modals
146+
Too much limitation at the moment, waiting for model input types
104147

105148
### Scrapped Plan
106149

107150
> Plan that unfortunately not possible (atleast for now)
108-
- Music Player (ffmpeg+ytdl vs lavalink?)
109-
- Public/Private commands, allowing other user to use each other's command in a different server.
110-
- Twitch and YouTube notification (Find how to refresh webhook thingy reliably)
151+
- Replace mute with the new timeout feature from Discord
152+
The feature is too limited, maybe I'll add timeout command instead
153+
- Music Player
154+
Not in my top priority, and looking at how aggresive Google is towards music bots... maybe not gonna do it afterall
155+
- Public/Private commands, allowing other user to use each other's command in a different server
156+
Too complicated, might add it after I finally finish the dashboard
157+
- Twitch and YouTube notification
158+
Unreliable most of the time, sometimes return duplicates
111159

112160
## License
113161

0 commit comments

Comments
 (0)