Storybro

Storybro是AI Dungeon 2的社区维护分支。AI Dungeon最初由Nick Walton创建。

访问我们的Wiki： Storybro wiki

了解更多关于AI Dungeon 2及其构建信息这里。

此分支旨在提供

• 改进原始代码库
• 命令行工具 storybro 用于管理模型、故事等
• 改进的交互式游戏模式
• 模型注册表，可以从中下载模型
• 暴露大多数功能的HTTP网络服务
• 可使用Pip安装的Python包

注意

Storybro的AI可以使用您的GPU或CPU。GPU将比CPU产生更快的AI响应。需要具有12 GB或更多内存的NVIDIA GPU和已安装的CUDA才能进行GPU游戏。如果您没有这样的GPU，您可以在CPU上玩游戏。但是，每一轮可能需要几分钟或更长时间来让游戏生成其响应。

游戏

此README仅涵盖安装。要了解如何玩游戏，请访问我们的Wiki。

安装

安装Storybro需要以下软件

• Python 3.4 - 3.7

使用Git获取源代码并将其克隆到您的机器上

git clone https://github.com/storybro/storybro/

Windows安装

Storybro附带一些Windows批处理脚本，以简化安装。如果您想手动安装，请参阅手动安装。

Storybro 使用 Chocolatey 包管理器来安装依赖项

1：从本仓库根目录使用 管理员 终端

./bin/windows/install/install-choco.bat

2：关闭您的终端并重新打开它。

3：现在 Chocolatey 已安装，安装我们的依赖项和 Storybro

./bin/windows/install/install-storybro.bat

4：安装完成后，您应该处于 shell 状态。现在您可以使用 storybro 命令

Linux 安装

Storybro 随带一些 shell 脚本以方便安装。如果您想手动安装，请参阅手动安装。

要安装 Storybro，只需运行安装脚本

./bin/linux/install/install

您现在可以使用 Poetry 进入一个可以使用 storybro 命令的 shell

poetry shell

手动安装

Storybro 是一个 Python 应用程序，并使用 Poetry 作为其环境。

使用 Pip 安装 Poetry

$ pip install poetry

使用 Poetry 安装 Storybro

$ poetry install

使用 Poetry 运行 Storybro

$ poetry run storybro

Storybro 使用 Aria2 下载模型。如果您打算使用 Storybro 下载模型，请确保它已安装并添加到您的 $PATH 中。

社区

Storybro 是一个开源项目。欢迎提问、讨论和贡献。贡献可以是新包、错误修复、文档，甚至是新的核心功能。

资源

• Reddit： r/AIDungeon
• Discord： aidungeon discord

贡献

为 Storybro 贡献非常简单！只需从您的分叉发送给我们一个 拉取请求。请确保 develop 是目标分支。

Storybro 使用类似 Git Flow 的分支模型。`develop` 分支包含最新的贡献，而 `master` 分支始终带有标签并指向最新的稳定版本。

如果您是贡献者，请确保您在 `develop` 上进行测试和玩耍。那里正在进行所有魔术（我们希望那里不会有错误）。