ATTENTION: This bot uses the new version of discord.py v1.6+, if you want to use my bot with the old legacy discord.py version check out the legacy branch. This is mostly a german discord chat bot made with discord.py v1.6+.
If you are looking for a python discord bot to host for yourself, you should rather take a look at Red Bot if you want a highly customizable self-hosted python bot. Shinobu is only meant to be run on my own server.

Using pip install discord.py will install the latest discord.py version.

Commands List

Info: Diese Liste gilt für den Standardprefix :

Generic

Forum

Utility

Anime

Fun

Mod

Admin

Run (Docker method)

GitHub Actions erstellt automatisch ein Docker image unter ghcr.io/der-eddy/shinobu_bot (AMD64 und ARM64). Unter docker-compose.examle.yml findet ihr ein Beispiel wie man dieses einsetzt:

version: '3.9'

services:
discord_bot:
    container_name: discord_bot
    image: ghcr.io/der-eddy/shinobu_bot:latest
    restart: always
    volumes:
    - discord_bot_data:/discord_bot/config
    environment:
    DISCORD_TOKEN: 'INSERT BOT TOKEN HERE'
    DISCORD_PREFIX: ':' #OPTIONAL Prefix for all commands, defaults to colon
    DISCORD_BOTSERVERID: '102817255661772800' #OPTIONAL Specifies the main serverid from which the server-/modlog should be taken + some other nito features
    DISCORD_KAWAIICHANNEL: '207909155556687872' #OPTIONAL specified a channel where the :kawaii commands gets this pinned messages
    DISCORD_GREETMSG: '{emoji} Welcome {member} on my server!' #OPTIONAL sends a greet message to new user in the botserverid system channel
    DISCORD_LEAVEMSG: ':sad: {member} left the server' #OPTIONAL sends a leave message to the botserverid system channel

volumes:
discord_bot_data:

Anzumerken ist dass das Docker Image Googles distroless Python 3.7 Basis benutzt, d.h. das nicht mal eine Shell vorinstalliert ist. Ihr könnt natürlich auch euer eigenes Docker Image anhand der Dockerfile selber bauen lassen-

Run (old method)

Erstellt zuerst ein virtuelles environment für Python über python3.7 -m venv env und aktiviert es über source env/bin/activate (Linux only). Anschließend könnt ihr alle benötigten Abhängikeiten über pip install -r requirements.txt installieren. (Um aus der virtuellen Umgebung wieder raus zu kommen einfach deactivate eintippen)

Anschließend started ihr das Script direkt über python3 main.py oder erstellt eine systemd service unit, ein Beispiel findet ihr unter discord.service.example:

[Unit]
Description=Shinobu Discord Bot
After=multi-user.target
[Service]
WorkingDirectory=/home/eddy/discord_bot
Environment="PYTHONHASHSEED=0"
User=eddy
Group=eddy
ExecStart=/usr/bin/python3 /home/eddy/discord_bot/main.py
Type=idle
Restart=on-failure
RestartSec=15
TimeoutStartSec=15

[Install]
WantedBy=multi-user.target

Nach /etc/systemd/system/discord.service kopieren und anpassen. Nicht vergessen die Unit zu starten via sudo systemctl start discord.service bzw. Autostart via sudo systemctl enable discord.service.

Einstellungen

Vor dem Start muss im Ordner config eine Datei namens config.py angelegt werden, ein Beispiel einer solchen gibt es in config.example.py zu finden:

__token__ = 'INSERT BOT TOKEN HERE'
__prefix__ = ':' #OPTIONAL Prefix for all commands, defaults to colon
__timezone__ = 'Europe/Berlin' #OPTIONAL
__botserverid__ = 102817255661772800 #OPTIONAL Specifies the main serverid from which the server-/modlog should be taken + some other nito features
__kawaiichannel__ = 207909155556687872 #OPTIONAL specified a channel where the :kawaii commands gets this pinned messages
__greetmsg__ = '{emoji} Welcome {member} on my server!' #OPTIONAL sends a greet message to new user in the botserverid system channel
__leavemsg__ = ':sad: {member} left the server' #OPTIONAL sends a leave message to the botserverid system channel
__selfassignrole__ = 'NSFW' #OPTIONAL allows to selfassign a role like NSFW on the BOTSERVERID

Alternativ für Heroku oder Docker Umgebungen können environment variables statt einer config.py Datei genutzt werden:

DISCORD_TOKEN: 'INSERT BOT TOKEN HERE'
DISCORD_PREFIX: ':' #OPTIONAL Prefix for all commands, defaults to colon
DISCORD_TIMEZONE: 'Europe/Berlin' #OPTIONAL
DISCORD_BOTSERVERID: '102817255661772800' #OPTIONAL Specifies the main serverid from which the server-/modlog should be taken + some other nito features
DISCORD_KAWAIICHANNEL: '207909155556687872' #OPTIONAL specified a channel where the :kawaii commands gets this pinned messages
DISCORD_GREETMSG: '{emoji} Welcome {member} on my server!' #OPTIONAL sends a greet message to new user in the botserverid system channel
DISCORD_LEAVEMSG: ':sad: {member} left the server' #OPTIONAL sends a leave message to the botserverid system channel
DISCORD_SELFASSIGNROLE: 'NSFW' #OPTIONAL allows to selfassign a role like NSFW on the BOTSERVERID

In games.py kann man die Titel der "Playing-" Rotation anpassen. Platzhalter wie {servers} oder {members} sind möglich.

__games__ = [
    (discord.ActivityType.playing, 'with Eddy-Senpai'),
    (discord.ActivityType.playing, 'with Cats'),
    (discord.ActivityType.playing, 'try :help'),
    (discord.ActivityType.playing, 'try :about'),
    (discord.ActivityType.playing, 'with VS Code'),
    (discord.ActivityType.playing, 'with Python'),
    (discord.ActivityType.playing, 'with async'),
    (discord.ActivityType.playing, 'with Karen-chan'),
    (discord.ActivityType.playing, 'with Hinata-chan'),
    (discord.ActivityType.playing, 'with Eduard Laser'),
    (discord.ActivityType.watching, 'over {guilds} Server'),
    (discord.ActivityType.watching, 'over {members} Members'),
    (discord.ActivityType.watching, 'Trash Animes'),
    (discord.ActivityType.watching, 'you right now'),
    (discord.ActivityType.watching, 'Hentai'),
    (discord.ActivityType.listening, 'Podcasts')
]
__gamesTimer__ = 2 * 60 #2 minutes

Erweiterungen (Cogs) die beim starten aktiviert werden sollen, kann man in cogs.py einstellen:

__cogs__ = [
    'cogs.admin',
    'cogs.mod',
    'cogs.fun',
    'cogs.anime',
    'cogs.utility',
    'cogs.help'
    ]

Support

Gibts auf meinem Discord Server: https://discord.gg/kPMbPDc

Troubleshooting

Sollte z.B. aus irgendeinem Grund die mod.py cog nicht geladen werden, kann der Bot vom Bot Besitzer über :shutdown_backup heruntergefahren werden. Weitere Tipps folgen

List of requirements

python>=3.7.0
discord.py
aiohttp
websockets
pytz
pillow

For a pinned version check requirements.txt

License

MIT License

Copyright (c) 2016 Eduard Nikoleisen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.