Free and open-source bot for Discord.
Warning
Yuuki is not actively maintained. Only security and critical bug fixes will be made.
You can invite the publicly usable version of the bot or host your own version to gain full control and access to owner commands.
You can find a list of commands on the wiki.
For Docker (Recommended):
- A Docker installation, including
docker
anddocker-compose
binaries.- On Debian-based Linux distros this is usually as simple as
apt install docker.io docker-compose
- for advanced installations check out the documentation
- On Debian-based Linux distros this is usually as simple as
For standalone:
- Ruby 2.4.0+
- Bundler (
gem install bundler
) - Locally running Redis (
apt install redis-server
?)
Note: We do not currently support running standalone on bare Windows platforms. It should work, but no guarantees or support are made.
For Windows it's recommended to use WSL (WSL1 and WSl2 are both fine) or Docker Desktop.
- Clone the repo:
git clone --recursive https://github.com/yuuki-discord/Yuuki-Bot.git
- cd into the repo:
cd Yuuki-Bot
Then either
- Generate a configuration file. You have a few choices:
- Run the guided script:
docker-compose run yuuki ./config.rb
- Create a
config/config.yml
manually: seeconfig/README.md
for details. - Uncomment and edit the environment variables in
docker-compose.yml
- Run the guided script:
- Run the bot:
docker-compose up
To fork it to the background, instead usedocker-compose up -d
. You can check the running logs withdocker-compose logs yuuki
.
or
- Create a config file, either through the guided script (
ruby config.rb
) or manually (Seeconfig/README.md
) - Install bundler if you haven't already:
gem install bundler
- Install the bundle:
bundle install
- Run the bot. For Linux:
sh run_linux.sh
. For Windows:run_windows.bat
.
- Pull any changes from the repo:
git pull
- Check any config changes. In the future more work will be needed on our side to better support this.
- If anything errors, make sure to check the new
config.example.yml
and update yourconfig.yml
accordingly.
- If anything errors, make sure to check the new
- Update the containers:
docker-compose pull
- Start or restart the containers:
docker-compose up -d
- Install/update the gem dependancies:
bundle install
- Run the bot:
sh run_linux.sh
orrun_windows.bat
Please report any issues to Erisa | <@228574821590499329>
on Discord, or open an Issue!
You can also join our server for support! (Or to find me) https://discord.gg/PrTMrv4
Enjoy~
Use of this bot is at your own discretion. The bot's current code is viewable at this repository, feel free to review the code to verify its safety. The creator(s) of this code accept no responsibility for any repercussions that occur as a result of adding this bot.
The @Yuuki-Chan help
command on the publicly running bot should always show the commit hash of the running code (If a version is shown, omit the first g
after that version to get the commit hash) For example at time of writing the bot returns 990bcb5
, which corresponds to this code state.
- edwardslabs for CloudBot
- meew0 for Discordrb