Skip to content

aikyoは、相互につながるAIコンパニオンを作成するためのフレームワークです。

License

Notifications You must be signed in to change notification settings

marukun712/aikyo

Repository files navigation

aikyo

Ask DeepWiki
日本語 | English

aikyo is a framework for building interconnected AI companions.

Join our Discord server!

https://discord.gg/JxAVZkQdDX

Features

  • Turn-taking functionality included as standard
  • Natural conversations with multiple companions
  • Flexible tool-usage rules defined with CEL
  • Frontend extensibility by parameterizing character behaviors

Installation

pnpm i @aikyo/utils @aikyo/server @aikyo/firehose

License

MIT License


Contribution

Contributions are welcome!

Requirements

pnpm , Node.js (>= 24.2)

Using Nix Flake

First, enter the devShell.

nix develop
Using mise
mise install

Setup

Install the packages.

pnpm i

Create .env file.
Enter an API key for each provider supported by the ai-sdk.

cp .env.example .env

Run / Development Workflow

Using Nix Flake

Bundle the package.

nix run .#bundle

Start the firehose and companion.

# Usage: nix run .#dev -- <COMPANION> [<COMPANION> ...]
# Example: nix run .#dev -- kyoko aya
$ nix run .#dev <companion_name>

Bundle the package.

pnpm run bundle
# 1) Start the firehose server (default: http://localhost:8080)
$ pnpm run firehose


# 2) Launch a companion by name (see configs/ directory for available names)
$ pnpm run companion <companion_name>

Acknowledgments

This project is inspired by the research paper:

"Who Speaks Next? Multi-party AI Discussion Leveraging the Systematics of Turn-taking in Murder Mystery Games"
by Ryota Nonomura and Hiroki Mori (2025)
📄 Journal

We appreciate their groundbreaking work on multi-agent dialogue systems and turn-taking mechanisms.

About

aikyoは、相互につながるAIコンパニオンを作成するためのフレームワークです。

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 6