无神论者

使用您喜爱的 AI 服务，与个性化角色进行 AI 角色扮演聊天。

在线版本 | Discord

请访问在线版本：Agnai.chat。

基于 PygmalionAI 的早期作品 Galatea-UI。

---

快速入门

重要！ MongoDB 和 Redis 是可选的！如果 MongoDB 不可用，Agnaistic 将以“仅访客”模式运行。

Agnaistic 已发布为 NPM 包，可以全局安装：

# 安装或更新：
npm install agnai -g
agnai

# 查看启动选项：
agnai help

# 带管道功能运行
agnai --pipeline

使用 NPM 包时，您的图片和 JSON 文件将存储在：HOME_FOLDER/.agnai。
示例：
Linux：/home/sceuick/.agnai/
Mac：/Users/sceuick/.agnai
Windows：C:\Users\sceuick\.agnai。

功能

• 群组对话：多名用户与多个机器人互动
• 多种 AI 服务：支持 Kobold、Novel、AI Horde、Goose、OpenAI、Claude、Replicate、OpenRouter、Mancer
• 多种人格模板格式：W++、方括号格式 (SBF)、Boostyle、纯文本
• 多租户：
  • 用户身份验证
  • 用户设置：选择使用的 AI 服务及个人设置
  • 用户生成预设
• 订阅功能
• 记忆/传说书籍
• 使用 AI 生成角色
• 使用第三方服务生成图片
• 可选的管道功能
  • 长期记忆
  • 维基百科文章和 PDF 嵌入

手动运行

3. 安装 Node.js
4. 安装 MongoDB 可选
   • 数据库是可选的。如果没有数据库，Agnaistic 将以“仅匿名”模式运行。
   • “匿名”用户的数据会保存在浏览器的本地存储中。数据会“保留”，但无法在不同设备或浏览器之间共享。清除浏览器的应用程序数据/cookies 会删除这些数据。
5. 下载项目：git clone https://github.com/agnaistic/agnai 或 下载
6. 在终端/控制台中进入克隆/解压后的文件夹：
   • npm run deps
     • 每次更新 AgnAI 时都执行此操作，以防万一。
     • 这将使用 pnpm v8 安装依赖项。
   • npm run build:all
   • 以监听模式构建并运行项目：
     • Mac/Linux：npm run start
     • Windows：npm run start:win
   • 以本地隧道模式构建并运行项目：
     • Mac/Linux：npm run start:public
     • Windows：npm run start:public:win

使用 Docker 运行

1. 克隆项目
2. 如果有 MongoDB：docker compose -p agnai -f self-host.docker-compose.yml up -d
3. 如果没有 MongoDB：docker run -dt --restart=always -p 3001:3001 ghcr.io/agnaistic/agnaistic:latest
   • -dt 以分离模式运行容器
   • --restart=always 在启动时或服务器崩溃时自动重启
   • -p 3001:3001 暴露 3001 端口。可通过 http://localhost:3001 访问应用。

自托管设置

为了满足用户在应用层面针对特定需求所做的微调，我们提供了 settings.json 文件。
您可以在根目录下创建一个名为 settings.json 的文件，以在整个应用中应用一些更改。
如果您对应用有特殊需求，这里就是提出请求的地方。

我会努力在满足这些请求与避免代码库失控之间找到平衡。

适合在此处处理的请求示例：

• 我希望为所有用户应用一个“默认记忆书”。
• 我想使用不同于提供的结束标记集。
• 我想禁用匿名访问。

settings.json

您可以复制或查看 template.settings.json 以了解所有可用设置的示例。更改生效后需要重启 Agnai。

当前支持的自定义设置：

• baseEndTokens：向基础集合添加额外的响应结束标记。

针对开发者

推荐的开发工具

强烈建议使用 VSCode 并安装以下扩展：

• Prettier - Code formatter：用于自动格式化
• Tailwind CSS Intellisense：用于 Tailwind CSS 类的自动补全和智能提示
• 并在 VSCode 的 settings.json 中添加 "editor.formatOnSave": true，以便使用 Prettier 自动格式化。

使用 pnpm start 时，Node.JS 服务器会使用 --inspect 参数运行。这意味着您可以使用各种 Inspector Clients 进行调试。

技术栈

该堆栈的重要组成部分包括：

• MongoDB 用于持久化
• Redis 用于 WebSocket 的分布式消息传递
• SolidJS 用于交互性
• TailwindCSS 用于样式
• pnpm 用于依赖管理

启动

# 安装依赖项 - 拉取更改后务必运行此命令
> npm run deps

# 使用 Docker 启动 MongoDB
> npm run up

# 启动前端、后端和 Python 服务
# Mac/Linux
> npm start

# Windows
> npm run start:win

# 安装并运行 Pipeline API
# 如需，这将在运行 API 之前更新依赖项
> npm run model # 将 poetry 安装到虚拟环境中

# 使用单个命令运行所有内容：
> npm run start:all # Linux 和 OSX
> npm run start:all:win # Windows

此时，您应该能够在浏览器中访问 http://localhost:3001 来查看界面。

您还可以尝试通过热重载访问前端：http://localhost:1234。

推荐的开发者工具

• Redux Dev Tools
  • 前端应用状态已连接到 Chrome 扩展“Redux Dev Tools”。
• NodeJS 调试器
  • pnpm start 脚本使用 --inspect 标志启动 NodeJS API
  • 可以使用 VSCode 的默认启动任务（F5）进行附加
  • 或前往 chrome://inspect 使用调试器
• 使用 Poetry 管理 Python 依赖项 - https://python-poetry.org/docs/cli
  • .model/bin/poetry [...args]

格式与类型检查

该项目使用 ESLint 进行代码检查，Prettier 强制执行代码风格，TypeScript 用于检查类型错误。在提交 PR 时，请确保不会引入任何新的错误，方法是运行：

# 自动修复任何样式问题
$ pnpm run format:fix

# 运行 TypeScript 编译器，显示所有类型错误
$ pnpm run typecheck

该项目已在 BrowserStack 上进行了测试。

Agnaistic (agnai) 快速上手指南

Agnaistic 是一个支持个性化角色扮演的 AI 聊天平台，兼容多种主流 AI 服务（如 OpenAI、Claude、Kobold 等）。它支持多用户、群组对话、长期记忆及自定义角色生成。

环境准备

系统要求

• 操作系统: Linux, macOS, 或 Windows
• Node.js: 推荐安装最新 LTS 版本 (需配合 pnpm v8)
• 可选依赖:
  • MongoDB: 用于持久化存储用户数据（若不安装，系统将运行在“仅限访客/匿名”模式，数据仅保存在浏览器本地）。
  • Redis: 用于分布式 WebSocket 消息（多实例部署时需要，单机非必须）。

前置说明

• 国内开发者若遇到 npm/pnpm 下载缓慢，建议配置国内镜像源（如腾讯云或阿里云镜像）加速依赖安装。
• 项目默认使用 pnpm 管理依赖。

安装步骤

你可以选择以下两种方式之一进行安装：

方式一：通过 NPM 全局安装（最简单）

适合快速体验，无需克隆代码库。

# 全局安装或更新 agnai
npm install agnai -g

# 启动服务
agnai

# 查看启动选项帮助
agnai help

# 启用管道功能（如长期记忆、PDF/Wikipedia 嵌入等）
agnai --pipeline

注意：使用此方式时，图片资源和 JSON 文件将存储在用户主目录下的 .agnai 文件夹中：

• Linux: /home/用户名/.agnai/
• Mac: /Users/用户名/.agnai
• Windows: C:\Users\用户名\.agnai

方式二：手动源码部署（适合开发与定制）

适合需要修改源码、贡献代码或进行深度定制的用户。

1. 克隆项目

   git clone https://github.com/agnaistic/agnai
   cd agnai
   

2. 安装依赖

   每次更新代码后都建议执行此步骤。

   npm run deps
   

3. 构建项目

   npm run build:all
   

4. 启动服务

   • Mac/Linux:

     npm run start
     

   • Windows:

     npm run start:win
     

方式三：Docker 部署

无需 MongoDB (匿名模式):

docker run -dt --restart=always -p 3001:3001 ghcr.io/agnaistic/agnaistic:latest

包含 MongoDB (完整功能):

docker compose -p agnai -f self-host.docker-compose.yml up -d

基本使用

1. 访问界面 启动成功后，在浏览器中打开：

   http://localhost:3001
   

   (如果是开发模式且启用了热重载，前端可能运行在 http://localhost:1234)

2. 初始配置

   • 若未连接 MongoDB，你将直接进入匿名模式，数据保存在当前浏览器缓存中。
   • 若已连接数据库，可注册账号并登录。

3. 连接 AI 服务

   • 进入设置页面，选择你偏好的 AI 服务提供商（支持 OpenAI, Claude, Kobold, NovelAI, AI Horde 等）。
   • 填入对应的 API Key 或端点地址。

4. 开始对话

   • 创建或导入一个角色卡片（支持 W++, SBF, Boostyle 等格式）。
   • 开启新对话，即可与个性化角色进行互动。
   • 高级功能：可在设置中开启“长期记忆”或上传文档（PDF/Wiki）以增强角色知识库（需使用 --pipeline 参数或对应 Docker 配置）。

5. 自定义全局设置 (可选) 在项目根目录创建 settings.json 文件（参考 template.settings.json），可配置全局默认项，例如：

   • 为所有用户应用默认记忆书
   • 禁用匿名访问
   • 自定义回复结束令牌 (End Tokens)

   修改后需重启服务生效。