Smart Home, Automation, and all purpose homelab management bot.

Report Bug · Request Feature

Yotsugi was created to simplify the management of my servers. I wanted a easy way to manage my docker container, smart devices, download clients and many more.

1. You can create your MongoDB container using docker-compose. Save this as docker-compose.yml where you would like to save the data at and run docker-compose up -d to start the container.

version: '3'
services:
  mongodb:
    image: mongo
    container_name: mongodb
    ports:
      - 27017:27017
    volumes:
      - ./mongodb/data:/data/db
    restart: unless-stopped

1. Create a folder for Yotsugi with a config and logs directory inside of it.
2. Inside the config directory make a config.json file with the following content. Changing ownerID, prefix and token accordingly. trustedUsers are the user ID's of members who bypass permission checks for commands.

{
  "mongoUrl": "mongodb://USERNAME:PASS@HOST:27017/yotsugi",
  "ownerID": "YOUR DISCORD USER ID",
  "prefix": "//",
  "apiKey": "1234",
  "token": "YOUR BOT TOKEN",
  "trustedUsers": ["userID 1", "userID 2"]
}

3. Create a docker-compose.yml file with the following content. Changing the host directories if opting to store the config and log directories elsewhere.

version: '3'
services:
  yotsugi:
    image: callmekory/yotsugi:latest
    container_name: yotsugi
    volumes:
      - /path/for/config/files:/app/dist/config # where config.json, rclone.conf and db are stored
    ports:
      - 5055:5055 # api server port
    restart: unless-stopped

4. Run docker-compose up in the same directory as your docker-compose.yml file. If all goes well you should see the bot login and present you with a invite link to add her to your server. Press ctrl + c to exit then run it with docker-compose up -d to start the bot in the background.

To get a local copy up and running follow these simple steps.

1. Download latest release

https://github.com/callmekory/yotsugi/releases

2. Unzip yotsugi.zip

3. Navigate into yotsugi folder

4. Run npm install to install project dependencies

5. Edit config/config.json with you bot token and user ID

6. Run the bot with npm start

All commands in Yotsugi are linked to a database where all params are set with the command //config. For example to see Embys config you would do //config get emby and to set a param like apiKey you would do //config set emby apiKey YOURAPIKEY. For command usages, etc run the //help command.

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. yarn install to get all dependencies
3. Edit config in /src/config/config.json with your bot token and user ID
4. Run tsc -w to watch and build the project as you edit source
5. Run the bot with nodemon build/index.js make sure you have nodemon install globally with NPM

See the open issues for a list of proposed features (and known issues).

Distributed under the GPL3 License. See LICENSE for more information.

You can open a issue on github or join my personal Discord server and chat with me there if you'd like some help. Feel free to also DM me, my tag is callmekory#4233

• Mellow - Ombi movies/series code
• nwithan8 Command ideas, testing and making some of the best bots on discord