diff --git a/README.md b/README.md index bcce1fb..980c4a5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,52 @@ -# novelai-bot +# NovelAI Discord Bot +![Code Quality](https://git.0day.agency/wirehack7/novelai-bot/actions/workflows/check-code_quality.yaml/badge.svg) +![Safety Check](https://git.0day.agency/wirehack7/novelai-bot/actions/workflows/check-safety.yaml/badge.svg) +![Release](https://git.0day.agency/wirehack7/novelai-bot/actions/workflows/release.yaml/badge.svg) + +Simple bot which registers a command to generate images via the NovelAI API. + +## Usage + +Just enter `/generate` in the desired channel. + +```text +/generate + *prompt: string + undesired_prompt: string + orientation: landscape or portrait + seed: integer +``` + +`*: required` + +## Run + +You might create environvent vars: + +- **NOVELAI_API_TOKEN**: your NovelAI user API key +- **DISCORD_BOT_TOKEN**: token of your Discord bot +- **DISCORD_CHANNEL_ID**: ID of the channel to enable this bot + +Don't forget to install the requirements in [requirements.txt](src/requirements.txt) + +## Docker Compose + +Or simply run it via **docker-compose**: + +```yaml +services: + bot: + restart: unless-stopped + image: git.0day.agency/wirehack7/novelai-bot:latest + environment: + - NOVELAI_API_TOKEN= + - DISCORD_BOT_TOKEN= + - DISCORD_CHANNEL_ID= +networks: {} +``` + +## Notes + +To create a Discord bot go to [Discord Developers](https://discord.com/developers/). +You should make the bot private. \ No newline at end of file