Getting started
About 15 minutes, all in the setup window. Optional steps can be skipped and changed later.
- Run the setup. At the end CompanionForge starts and opens its settings window with the setup steps.
- Install speech recognition. One click; it downloads while you go on (about 4 GB with an NVIDIA card, under 1 GB without). Or let OpenAI do the listening instead.
- Pick an avatar. Choose one of the bundled avatars, or (Premium) import your own (.vrm or .glb).
- Names. Your name, your companion's name and everyone's pronouns.
- Personality. Their persona and story, the languages they may speak and whether they swear. (Premium) Write their whole personality in your own words.
- Reactions. Whether and how much your companion comments without being asked.
- API keys and AI model. One key is needed, for the AI. With OpenRouter (recommended) it is one click: Connect with OpenRouter, sign in, Authorize. The other services have a step-by-step guide each. Then pick the AI model; our test results are right there. Keys are checked and stored encrypted on your PC.
- Voice. Pick a voice and a speed. The Edge voices are free; ElevenLabs sounds best.
- Game. Pick your World of Warcraft folder and click Install addon. Following a leveling guide (RestedXP's free guides or your own, or Ziro Guide) is free too.
- Push-to-talk. Click Bind and press the button you want to hold while talking, or just say your companion's name instead.
- Twitch. (Premium) Connect your Twitch account and viewers can ask your companion in chat.
- On screen. Show your companion on your own screen (over the game; World of Warcraft in Windowed (Fullscreen) mode), on your stream (add the address shown as a Browser source in your streaming app, it has a transparent background), or both.
- Place and test. Drag your companion where they should sit and press Test: they show up, fly to two spots and say a test line in their voice.
Premium
Open the Premium page in the settings window to see what it adds and to unlock it.