Getting Started with Ryokan

Ryokan is a free, cross-platform application for AI-powered interactive stories and roleplay. You can create your own characters, develop stories, and choose which AI models you want to use.

Ryokan supports Windows and Android. Your chats and characters are stored locally on your device.

1. Download Ryokan

Download the latest version of Ryokan from the official GitHub Releases page:

Download Ryokan

Install the application on your device and launch it.

2. Set Up an AI Provider

Ryokan uses AI models through external providers or your own compatible API endpoint.

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

1. Select your preferred language.
2. Choose an AI provider.
3. Enter your API key if required.
4. Select the AI model you want to use.

Supported providers include OpenRouter, OpenAI, Anthropic, Google Gemini, and NanoGPT. You can also connect additional compatible services through custom API endpoints.

Important: Ryokan does not provide paid AI models itself. Depending on your provider and model, API usage may incur costs. Some providers also offer free models.

3. Create or Import a Character

Characters are the foundation of your interactive stories.

You can create your own characters and define their personality, background, scenario, and opening message.

Alternatively, you can import existing character cards in the supported V3 format.

4. Start Your First Story

Select a character and start a new chat.

The AI takes on the character's role and responds to your messages. You can engage in conversations, describe actions, or take the story in an entirely new direction.

Ryokan also offers several ways to influence how your story unfolds:

• Regenerate Responses: Let the AI generate an alternative continuation.
• Edit Messages: Modify existing messages and change the direction of the story.
• Director Mode: Provide additional instructions to guide the story's development.
• Personas: Define the role you take within the story.

5. Customize Your Settings

You can adjust the AI's behavior to match your preferences in the settings.

Depending on the model and provider, parameters such as Temperature, Top-P, Top-K, Min-P, and Frequency Penalty are available.

Advanced users can also configure thinking settings, context lengths, and text rules.

You don't need to change any of these settings to start using Ryokan.

6. Privacy and Local Storage

Ryokan follows a local-first approach.

Your stories, characters, and settings are stored locally on your device. No Ryokan account is required for regular use.

When using an external AI provider, the information needed to generate a response is sent to that provider's API. Data processing is subject to the respective provider's privacy policy.

7. Updates and Support

New versions, bug fixes, and improvements are released through GitHub.

If you encounter a bug or want to suggest a feature, you can open a GitHub issue.

Have fun creating your own stories!