Project AIRI Manual

Corresponding version: AIRI-0.10.2

Table Of Contents ​

• Chapter 1 – Installation
• Chapter 2 – Initial Configuration
  • Section 1 – Preparation
  • Section 2 – Launch Airi!
• Chapter 3 – Airi Interface Overview
  • Main Window
  • System Tray Other Options
  • Settings Window
  • Chat Window
• Chapter 4 – Settings
  • AIRI Character Card
  • Body Modules
  • Scene
  • Character Model
  • Memory Bank
  • Service Sources
  • Data
  • Connection
  • System
• Web Version Feature Additions
• Historical Characteristics & Common Issues
• Written at the End

Chapter 1 – Installation ​

Go to the Project AIRI GitHub homepage: moeru-ai/airi

Follow these steps:

1. Find the "Releases" option on the right side of the page.
2. Click "+ 68 releases".
3. Pick a version, find "Assets" below it, and expand.
4. Choose the version suitable for your computer and download it.
5. Locate the downloaded installer and double-click to install.

Chapter 2 – Initial Configuration ​

Section 1 – Preparation ​

Before you begin, you need to prepare at least one API from an LLM service provider.

Section 2 – Launch Airi! ​

Historical Characteristics: Bugs at Startup

Follow these steps to finish the first-time setup:

1. Open Airi (normally it opens automatically after installation).
2. Select your language in the main window.
3. Click "setup with your provider", alternatively, click on "Login" (A brief note on the process of choosing to log in).
4. Select your service source and click "Next".
5. Enter your API Key and click "Next".
6. Click "Next" again.
7. Select the model you wish to use, then click "Save and continue".

Congratulations! You have completed the initial configuration of Airi.

Chapter 3 – Airi Interface Overview ​

> Main Window ​

Introduction to the Main Interface of the Web Version

This window displays the virtual character. There are three buttons: Historical characteristics

• "Expand" – bottom right, click to reveal more options (see below).
• "Open hearing control" – bottom right, allows you to speak to Airi. Requires an STT service.
• "Move" – bottom right, long-press and drag to reposition the main window.

Click "Expand" to reveal nine options: (Login button & Eight small buttons)

• "Login" – You can log in to your own Airi account.
• "Open settings" – opens the settings window.
• "Switch character" – switch character cards.
• "Open chat" – opens the chat window.
• "Refresh" – refreshes the main window.
• "Switch to dark mode" – toggles light/dark theme.
• "Unpin" – makes the main window not always on top.
• "Always show" / "Hide on hover" – allows clicking through the window.
• "Close" – closes Airi.

> System Tray Other Options ​

First, locate the Airi icon in the system tray.

Right-click the Airi icon to see ten options:

• "Show" – brings up the main window, usually not needed.
• "Adjust size" – adjusts the main window size and centers it. Includes four sub-options:
  • "Recommended (450x600)" – sets the window to the recommended 450x600 size.
  • "Full height" – makes the window's height span the full desktop height.
  • "Half height" – makes the window's height span half the desktop height.
  • "Full screen" – makes the window fill the entire desktop.
• "Align to" – aligns the main window to a specific screen position. Includes five sub-options:
  • "Center" – aligns to the center of the desktop.
  • "Top left" – aligns to the top-left corner.
  • "Top right" – aligns to the top-right corner.
  • "Bottom left" – aligns to the bottom-left corner.
  • "Bottom right" – aligns to the bottom-right corner.
• "Settings" – opens the settings window.
• "About" – details omitted.
• "Open quick actions" – details omitted.
• "Open widgets" – details omitted.
• "Open caption" – opens subtitles. Requires TTS service to display text when Airi speaks; hidden on hover by default.
• "Caption overlay" – includes two sub-options:
  • "Follow window" – default; caption position follows the main window.
  • "Reset position" – resets the caption position.
• "Quit" – closes Airi.

> Settings Window ​

You can open settings in either of these ways:

• Click "Expand" on the main window, then select "Open settings".
• Right-click the Airi tray icon and select "Settings".

The settings window contains nine sections:

• "AIRI Character Card" – configure character personality.
• "Body Modules" – configure various functions: Consciousness, Vocalization, Hearing, Vision, Short-term Memory, Long-term Memory, Discord, X/Twitter, Minecraft, Factorio, MCP Server, Rhythm Game.
• "Scene" – Configure Airi's scene (background).
• "Character Model" – choose and configure the character's model.
• "Memory Bank" – not yet released.
• "Service Sources" – configure LLM, TTS, STT, Artistry services.
• "Data" – manage Airi's data.
• "Connection" – configure WebSocket server address.
• "System" – includes four sub-sections:
  • "General" – theme, language, etc.
  • "Color Scheme" – change the theme color.
  • "Window Shortcuts" – currently empty, no back button.
  • "Developer" – advanced features, see Chapter 4.

> Chat Window ​

You can open the chat window by clicking "Expand" on the main window and selecting "Open chat".

Here you can chat with Airi.

Chapter 4 – Settings ​

You can open settings in either of these ways:

• Click "Expand" on the main window, then select "Open settings".
• Right-click the Airi tray icon and select "Settings".

> AIRI Character Card ​

Here you can upload, create, or modify the default character card.

About creating a new character card, the recommended order is:

1. Fill out Identity, including name, nickname, description, and creator's notes.
2. Then adjust Behavior, including personality, scenario, and greeting.
3. If needed, configure Modules for character-specific body modules.
4. Configure the Artistry section as needed to set up the image generation function for the character.
5. Finally, review Settings, including system prompt, history prompt instructions, and version.
6. When you are ready, click "Create" to create the character card.
7. After creation, click the circle in the bottom-right corner of the card, or select the card and click Activate, to enable it.

The most important fields in Identity are name and description:

• Name is the official name; if a nickname is set, the nickname will be used first.
• Description is the detailed personality. You can be creative or refer to the default character card.

> Body Modules ​

Here you can configure various Airi functions, as follows:

> Consciousness ​

Recommended order:

1. First select a service source, or add a new one and select it.
2. Then select a model.

> Vocalization ​

Recommended order:

1. First select a service source, or add a new one and select it.
2. Then select a model.
3. Next select a voice.
4. If you do not want Airi to speak, choose "None".
5. After the basic setup, you can enter text at the bottom of this page and click "Test voice" to generate a sample.

> Hearing ​

Recommended order:

1. First select your audio input device.
2. Then select a service source, or add a new one and select it.
3. Then select a model.

In addition, you can:

• Enable "Auto-send transcribed text" to send transcripts automatically.
• Disable it to adjust the transcription result before sending.
• Configure "Auto-send delay" to tune the send delay.

If you want to test the microphone:

1. Click "start monitoring" in the middle of the page.
2. If needed, adjust Sensitivity.

If you want to test STT:

1. Click "start speech-to-text" at the bottom of the page.
2. Check the result under "Transcription Result".

> Vision ​

Recommended order:

1. First select a service source, or add a new one and select it.
2. Then select a model.
3. Optionally set "Capture interval" to control the capture frequency.

> Artistry ​

Here, you can configure Airi's artistic creation capability.

Please note: This feature is different from Neuro's drawing logic — it generates images using a third-party AI service, allowing you to obtain highly detailed AI-generated images.

Due to time constraints, this section will not be explained in detail for now.

> Short-term Memory ​

Not yet released.

> Long-term Memory ​

Not yet released.

> Discord ​

Here you can configure a Discord bot so that Airi can join your Discord server and interact.

Recommended order:

1. Obtain your Discord bot token.
2. Enter it into the appropriate field.
3. Finish the rest of the configuration based on the page.

> X/Twitter ​

Similar to Discord; requires a bot. Tutorial omitted.

> Minecraft ​

Requires a bot. Tutorial omitted.

> Factorio ​

Requires a bot. Tutorial omitted.

> MCP Server ​

The editor has not used this. Tutorial omitted.

> Rhythm Game ​

The editor is still exploring this. Tutorial omitted.

> Scene ​

Here, you can configure Airi's main interface scene—simply put, the background of Airi's main interface.

Two presets are included. To enable a scene, click the checkmark in the middle of one of the presets (it will appear only when you hover your mouse over it).

You can also click "Upload to Gallery" to import your own image scene.

If you need to clear the scene, click "Clear Default".

> Character Model ​

Here you can choose and set the character's model.

Airi supports Live2D models and VRM 3D models.

If you only want to switch to an existing model:

1. Click "select model" to open the model picker.
2. In this version, there are two Live2D and two VRM models by default.
3. Select one and click "confirm" to switch.

If you want to import your own model, click "add" to import a Live2D or VRM model.

> If you choose a Live2D model ​

You can continue in this order:

1. Expand "Zoom & Position" to adjust the model's size and position in the main window. x is horizontal (left/right), y is vertical (up/down).
2. Expand "parameters" to set mouse tracking, Idle Animation, frame rate, Auto Blink, Force Auto Blink (fallback timer), Shadow, reset to default parameters, clear model cache, and all model-specific parameters.
3. If you want idle animation, make sure the model zip includes animation files.
4. If needed, expand "Expressions" to enable the Expression System.

> If you choose a VRM 3D model ​

Expand "Scene" and then set Model Position, camera angle (degrees), camera distance (zoom), model orientation (Y-axis rotation), model gaze direction, and related values.

> Memory Bank ​

Not yet released.

> Service Sources ​

Here you can configure Chat(LLM), Speech(TTS), Transcription(STT), Artistry service sources.

Select an option, choose a service source you have already prepared, and fill in the required information on the corresponding interface to complete the configuration.

In addition, you can filter all services by criteria such as Pricing and Deployment.

• Regarding Pricing, there are three options:

  • All
  • Free
  • Paid

• Regarding Deployment, there are three options:

  • All
  • Local
  • Cloud

> Data ​

Here you can manage Airi's various data.

This page is organized into boxes:

1. The first box contains "Open app data folder". Click "Open folder" to open it.
2. The second box allows you to import/export chat history or delete all chat sessions.
3. The third box allows you to delete all imported models or reset module preferences and credentials.
4. The fourth box allows you to reset desktop settings and state.
5. The fifth box allows you to reset all provider settings and credentials, or clear every local setting, provider configuration, and model.

> Connection ​

Here you can configure your WebSocket server address.

> System ​

> General ​

Here you can set the program theme, language, etc.

• Theme defaults to light; click the button to switch to dark mode.
• Language sets the interface language.
• Control island icon size changes the size of the three buttons at the bottom-right of the main window.
• Finally, you can choose whether to allow collection of usage data and crash reports, or read the privacy policy (click "Privacy Policy" to open).

> Color Scheme ​

Here you can change the theme color.

• Enable the RGB option to make the theme color cycle like an RGB strip.
• Drag the black line or click on the color bar to change the theme color.
• Below that is a color preview.
• You can also select a preset below to change the theme color.

> Window Shortcuts ​

> Developer ​

Here you can use some advanced features.

First box and its related options:

• In the first box, you can click "Open" to open the developer tools window (like F12 in a browser).
• The second "Markdown stress test" – details omitted.
• The third "IO Tracer" — function introduction omitted for now.
• The fourth "Lag visualization" – details omitted.
• The fifth "Enable stage transition animation" – details omitted.
• The sixth "Use page-specific cutscenes" – details omitted.

> useMagicKeys tool ​

> useElectronWindowMouse ​

Here you can detect the mouse cursor position on the screen.

> Displays ​

Here you can visualize the mouse cursor position on the screen.

> widgets calling ​

> Context Flow ​

Real-time inspection of incoming context updates (server + broadcast) and outgoing chat hooks. Use this to verify how plugin context (e.g., VSCode coding context) flows into the chat pipeline and out to server events.

> relative mouse ​

Here you can visualize the mouse cursor position within this window.

> beat sync visualizer ​

> WebSocket Inspector ​

> Plugin Host Debug ​

> Updater ​

Detailed introduction omitted for now.

> Screen Capture ​

If you have not granted system-level screen capture permission yet, you will first see a permission prompt like the screenshot below. After granting permission, you can capture any application window or the entire screen.

There are four options at the top:

• "applications" – select any open application window, click "share window" to view it at the top; move the mouse over the capture and click "stop" to stop.
• "displays" – capture the whole screen, click "share screen" to view; move the mouse over the capture and click "stop" to stop.
• "devices" – details omitted.
• "refetch" – details omitted.

> vision capture ​

If screen capture permission has not been granted yet, this page will also show a permission prompt first. After granting permission, the page can start capturing frames and show the vision processing result.

> Web Version Feature Supplement ​

> Web Version Main Interface ​

Here, you can see your character model and talk directly to it.

Broadly, it is divided into three parts:

• Character model space
• Chat box
• Others

Below, we focus on the chat box and the other parts.

> Chat Box ​

The chat box is divided into two sections:

• The upper section is the area that displays and records the conversation history
• The lower section is the input box, where you can type to converse with the character

Below the lower section, there are three buttons: (text for reference only)

• Conversations (manage conversations; conversations are independent of each other)
• Send method (choose how to confirm sending a message)
• Enable voice input

> Other Parts ​

> Top Area ​

Includes three options:

• About
• Character Card
• Account & Settings

The third option contains three main sections:

• Account info
• Profile, Flux, Settings
• Log out

> Profile ​

If you are logged into Airi, you can manage your account information here.

Details omitted.

> Flux ​

Relevant instructions omitted for now.

> Settings ​

Same as the desktop version settings; see Chapter 4 for details.

> Bottom Area ​

Includes four options: (text for reference only)

• Position & Size
• Delete Chat History
• Toggle Light/Dark
• Background

> Position & Size ​

After clicking, you will see three new options on the left side of the option: x, y, scale, as well as a vertical bar on the left side of the web interface. Here, x refers to the model's x-axis position, y refers to the model's y-axis position, and scale refers to the model's zoom (size). You can adjust these three parameters by clicking and dragging the vertical bar on the left side of the web interface.

> Delete Chat History ​

Click to clear all chat history with one click.

> Toggle Light/Dark ​

Switch the interface between "Light" or "Dark" theme.

> Background ​

Change the background of the main interface.

> Historical Characteristics & Common Issues ​

> Common Issues ​

• When upgrading from an older version to version 0.10.2, if you have previously changed the size and position of the model, your model may 'disappear'. If you encounter this problem, please do not worry. You can solve it by resetting the model's scale and position in the model settings interface.

> Characteristics H2-2-1 ​

The first time you start the application, you may encounter this bug: the main interface border flickers, and when you click to expand the pop-up menu, it quickly retracts…

If you encounter this bug, don't worry—you can resolve it by following the steps below (but you'll need to be quick with your clicks):

First, click to expand at the exact moment when the flickering border goes dark.

Then quickly find the first option in the second row, 'Refresh', and click it. This will solve the problem.

• This feature has been fixed!

> Characteristics H3-1-1 ​

In some of the past versions, an option could also be seen in the top right corner of the main window:

• "websocket status" – top right, click to open connection settings where you can configure your WebSocket server address.

> Written at the End ​

This manual is primarily written by non-official personnel but submitted to the official website. Although content maintenance is usually handled by members of the Mujiu Yunxuan Studio, we sincerely hope that all friends who wish to edit this document or have already edited it will leave your name in the author section at the beginning. Whether you make content changes or formatting adjustments, we welcome everyone to join us in enriching and optimizing this manual, contributing your own strength—from anyone—to the Airi project and to this manual!

Furthermore, if you are a non-official user and have ideas for editing this manual, please do not have any additional concerns—simply make the changes and submit a pull request. However, we remind you again not to forget to leave your name!

Thank you all for your support and cooperation!

Sincerely, JhIceFair