jamdon2/ai-horde-bot

AI Horde Bot

This is a utility bot for the Stable Horde. It provides functionlity for using and interacting with other Stable Horde users

It is free software so you can not only add it to your owns server to interact with the stable horde, but also host it on your own to interact on your own terms.

Usage

This discord bot provides many functionalities around it, but the most significant ones are generating images, and gifting kudos to other stable horde users.

To use this bot on your own server, simply invite it or use the discord link from its description

Login

Any user can login to the stable horde using /login and their individual API key received from registering. This will provide more priority than an anonymous account when using /generate, and it also allow them to receive kudos from other discord users using kudos emojis, or from adding their own worker to the horde. Read how Kudos are working

It will also allow a user to retrieve their own or (optionally) another user stable horde information, such as kudos balance and usage/contributions.

Generating Images

Any user in your server should be able to generate images using the /generate command however this command will be run anonymous by default, giving the lowest priority.

To get more priority, users should /login with their own API key.

Emoji Kudos

If you want your users to be able to gift kudos to each other, you will need to setup your own emojis which will trigger the bot to award kudos from the Stable horde. The names have to match the emoji keys you see in config.json

Any time that emoji is reacted with, it will transfer the stated amount of kudos. For this to work, both the reactor and the reactee, needs to have logged in to the Kudos bot with /login command. If either of them has not, the emoji will be removed and whoever is missing it, will receive a private message from the bot to log in.

If the reactor doesn't have enough kudos, the emoji will also be removed.

Use this functionality to promote good behaviour with something that has a bit more utility than random emojis

There's more command you can run to view information about users and this bot is in active development.

Community

Join our server and let us know what you think

Running your own

Configuration

The bot is configured using the config.json file.

Make a copy of config.example.json with the name config.json.

The config.json file contains the following properties:

• emojis: An object containing the emojis that the bot will react to. The keys should be the emoji names or IDs, depending on whether useEmojiNames is enabled.
  • value: The amount of kudos associated with the emoji.
  • message: The message the recipient for the transfer gets (optional)
    • {{amount}}: The amount of kudos formatted with the region en-US
    • {{user_mention}}: The mention string for the sender
    • {{message_url}}: A URL for the message that was reacted to
• horde: This contains the specific horde to be used.
  • baseUrl: The API base URL for the horde, not including API version.
• autorole: This contains the autorole module configuration.
  • enabled: Whether the module is enabled.
  • worker: An object containing server IDs, and the worker role for the server in question.
  • trusted: An object containing server IDs, and the worker role for the server in question.
• generate: This contains the generate module configuration.
  • enabled: Whether the module is enabled.
  • bannedWords: An array of words that are not allowed in the prompt.
  • nsfw: Whether to enable the nsfw flag, and disable censor_nsfw
• status_notifications: This contains the status-notifications module configuration.
  • enabled: Whether the module is enabled.
  • channel: The channel ID to send the notifications to.
  • messages: The message to send. The following variables are available:
    • up: The message to send when the bot comes online.
    • down: The message to send when the bot goes offline.
• event: This part is for Discord events.
  • enabled: Whether the module is enabled.
  • guildId: The ID of the server the event works in.
  • channelId: The ID of the channel the event submissions get sent to.
• escrowtime: Time in seconds to remember a reward for, if the recipient isn't logged in
• defaultMessage: Same as message, a fallback if no message is specified for the emoji.
• useEmojiNames: If enabled, the bot will use the emoji names instead of IDs for finding the emoji.
• clientId: The client ID of the bot.

The .env file stores the token and the database details.

It should contain these variables:

• TOKEN: The token of the bot
• MONGODB_URI: The URI of the MongoDB database
• MONGODB_DATABASE: The name of the database

Deploying

Prerequisites

• Docker
• Docker Compose
• Node.js (>= 16.17.0, for deploying commands)
• npm (for deploying commands)

Deploying Commands

Install the dependencies with npm install, and run the following command in the root of the project:

npx ts-node-esm src/deploy-commands.ts

Running

• cd into the project directory
• Build the docker image: docker build -t ai-horde-bot .
• Copy .env.example to .env and fill in the values
• If you want to change to your own emoj names, make a copy of config.example.json and name it config.json and fill it in
• Start the bot: docker-compose up (use the -d flag to run detached)