General instructions

AI Roguelite can communicate with local AI servers for text or image generation. Use this option if you are unsatisfied by the cloud options or want more freedom over which models to use. However, note that this will likely require a GPU with lots of VRAM, and take a bit of time to download and set up (5-15 minutes).

Step 1 - Pick and download the program which will run/host the AI model

For text gen, supported APIs are Kobold API and Oobabooga/OpenAI API. Here are some popular options which support these APIs:

• KoboldAI Client (Kobold API): API should work out of the box, using the URL that KoboldAI provides.
• KoboldCpp (Kobold API): API should work out of the box, using the URL that KoboldCpp provides
• Oobabooga Text Gen WebUI (Oobabooga/OpenAI API): API instructions in Wiki, but you only need the first step of adding the --api flag when starting it up
• LM Studio (Oobabooga/OpenAI API): API instructions in LM Studio website, but you only need to follow the first part of the guide.

For image gen, supported APIs are A1111 API and ComfyUI API. Here are some popular options which support these APIs:

• A1111 Stable Diffusion WebUI (API instructions in Wiki, but you only need the first step of adding the --api flag when starting it up)
• ComfyUI Stable Diffusion GUI (API should work out of the box, using the same URL as the browser webpage. Be sure to also specify the ckpt file!)

Step 2 - Run the downloaded program and make sure it works

You will most likely need to select and download a specific AI model on first launch. Make a couple queries from the browser interface (if provided) to make sure it's working.

Step 3 - Copy/paste the API URL provided by your program into AI Roguelite

Inside AI Roguelite, select the API you're using from the text generation dropdown, and copy/paste your URL into the field.

Important: Be sure to copy the actual API URL, which isn't always the same as the URL ending in /api leading to information about the API. In some cases, the API URL may be identical to the browser URL. In other cases, you will be given two different URLs and must select the one meant for the API rather than the browser.

Important: For text generation URLs, in most cases, if it ends with /v1, /v1/chat, or /v1/chat/completions, this suffix should be omitted.

Important: For ComfyUI, you also need to specify your ckpt file or it won't work correctly.

Please feel free to ask the Discord at any point if you are confused or stuck.

Troubleshooting

To narrow down whether an issue is caused by AI Roguelite or your local server, use an http request tool such as Postman, or a command such as Curl, to test your server. Send a request with some basic parameters to the API URL and verify that you're using the correct URL. If it works from another app but still doesn't work from AI Roguelite, report the issue in the Discord or email max@maxloh.com.