-
Modularity
-
Linux, Windows (read below!) and Android (Termux) support >.<
To work on Windows and Android, you must remove the uvloop dependency from the requrements.txt before installing
-
Open Source, lol
You can use
install.sh/ps1
bash/powershell installation scripts (thanks to @vilander1337) or proceed with manual installation below
sh -c "$(curl -fsSL https://raw.githubusercontent.com/pbmodular/bot/master/install.sh)"
iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/PBModular/bot/master/install.ps1'))
-
Clone repository
git clone https://github.com/PBModular/bot PBModular
-
Install Python packages (and setup venv, if you want)
python -m venv venv source venv/bin/activate pip install -r requirements.txt
-
Copy
config.example.yaml
toconfig.yaml
-
Edit
config.yaml
-
Run it!
python main.py
To run bot automatically at system boot (if you're using systemd and Linux) you can use this example systemd daemon:
[Unit]
Description=Any description of daemon here
After=network.target
[Service]
WorkingDirectory=/path/to/bot/sources
Type=simple
User=cooluser
# If you don't use venv, change python path to /usr/bin/python3 in a command below
ExecStart=/path/to/bot/sources/venv/bin/python3 -u /path/to/bot/sources/main.py
# Restart bot after fail
Restart=always
RestartSec=10
[Install]
WantedBy=multi-user.target
If you wanna add docs in your language contact with @vilander1337 or @SanyaPilot
It should be mentioned that Windows support is not gueranteed at all! Something can break randomly just because we are writing for *nix environment.
- @SanyaPilot (Telegram) - Bot core, wiki
- @CakesTwix (Telegram) - Translations
- @vilander1337 (Telegram) - Nice wiki on gitbook, scripts
Contributions are always welcome!