Getting Started with Ryokan

With Ryokan, you can explore interactive AI stories or create your own. You decide where the story goes, and the AI continues it based on your choices.

All you need to get started is the app and a connection to an AI model.

1. Download Ryokan

Ryokan is free and available for Windows and Android.

Download Ryokan

Download the version for your device, install it, and launch the app.

2. Set Up an AI Provider

When you first launch Ryokan, the setup wizard will guide you through the process.

1. Choose your language and an AI provider.
2. Create an API key with your chosen provider and enter it in Ryokan.
3. Select the AI model you want to use.

Ryokan supports providers including OpenRouter, OpenAI, Google Gemini, Anthropic, and NanoGPT. You can also connect your own locally hosted models.

What is an API key?

An API key allows Ryokan to send requests to your chosen AI provider. You can usually generate one in your provider's account dashboard.

Does it cost anything?

Ryokan itself is free. Some AI models are also available for free, while others are billed by the provider based on usage.

3. Start Your First Story

Once setup is complete, you're ready to go.

Ryokan comes with pre-made stories featuring different characters and scenarios.

Simply choose a story and start chatting. Write what you want to say or do, and the AI responds to your actions.

You can make different choices, regenerate responses, or edit messages to change how the story unfolds.

4. Create Your Own Stories

Have an idea of your own? You can bring it to life in Ryokan.

Create your own characters, define their personalities and backgrounds, and describe how the story should begin.

You can also import existing character cards in the supported V3 format.

You'll find more features and customization options in the documentation, but you don't need any of them to enjoy your first story.

---

That's it! Pick a story and see where your choices take you. Have fun with Ryokan!