Skip to main content

互动小说播放器 — 基于 Ink 的多平台故事引擎(交互式菜单 + 富文本降级 + Dashboard)

Project description

ErisPulse-CYOA

CYOA(Choose Your Own Adventure,选择你自己的旅途)— 基于 inkpython 的多平台 Ink 互动小说播放器。

特性

  • Ink 原生格式 — 用 Ink 编写,Inky/inklecate 编译
  • 跨平台按钮 — Telegram / 云湖 / QQBot 按钮 + event.choose() 回退
  • 仓库分发 — 添加 Git 仓库自动获取故事
  • 独立存档 — 每用户每故事多槽位
image

安装

epsdk install CYOA

Docker 部署

docker compose(推荐)

# 复制配置模板
cp -r config/ ./docker-config/

# 编辑配置(填写适配器 token 等)
# vim docker-config/config.toml

# 设置 Dashboard Token(可选)
export ERISPULSE_DASHBOARD_TOKEN=your-token

# 启动
docker compose up -d

docker run

docker run -d \
  --name cyoa-bot \
  -p 8000:8000 \
  -v $(pwd)/config:/app/config \
  -e TZ=Asia/Shanghai \
  -e ERISPULSE_DASHBOARD_TOKEN=your-token \
  --restart unless-stopped \
  ghcr.io/wsu2059q/erispulse-cyoa:latest

命令

/cyoa                        帮助
/cyoa list                   故事列表
/cyoa play <ID>              开始
/cyoa import <URL>           导入 .ink.json
/cyoa save|load|restart|quit 游戏管理
/cyoa repo list|add|remove|update  仓库管理

快速开始

导入编译好的 .ink.json 直接玩:

/cyoa import https://example.com/my_story.ink.json
/cyoa play my_story

或添加小说仓库,一次更新就能获取全部故事:

/cyoa repo add <名称> https://raw.githubusercontent.com/<用户>/<仓库>/main
/cyoa repo update
/cyoa list
/cyoa play <故事ID>

推荐仓库

我们维护的官方故事合集:

/cyoa repo add official https://raw.githubusercontent.com/wsu2059q/cyoa-stories/main

贡献请 Fork cyoa-stories

编写故事

Inky 编写 .ink 文件,导出为 .ink.json 后导入。

详见 FORMAT.md

平台兼容

平台 交互
Telegram Inline Keyboard
云湖 Buttons (actionType=3)
QQBot Keyboard
其他 event.choose()

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

erispulse_cyoa-1.1.3.tar.gz (22.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

erispulse_cyoa-1.1.3-py3-none-any.whl (24.5 kB view details)

Uploaded Python 3

File details

Details for the file erispulse_cyoa-1.1.3.tar.gz.

File metadata

  • Download URL: erispulse_cyoa-1.1.3.tar.gz
  • Upload date:
  • Size: 22.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for erispulse_cyoa-1.1.3.tar.gz
Algorithm Hash digest
SHA256 483d0553b3c0f5d285e905761593ce46af4b2c37e1e4b85895e8f769ed13c324
MD5 e46c329be0fcf30ca9c17dfee6992040
BLAKE2b-256 d59c6f95c6fdabdb5e954054e7a9db6d7c252f19fcd32b2ed6a5e33eeaec001a

See more details on using hashes here.

Provenance

The following attestation bundles were made for erispulse_cyoa-1.1.3.tar.gz:

Publisher: python-publish.yml on wsu2059q/ErisPulse-CYOA

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file erispulse_cyoa-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: erispulse_cyoa-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 24.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for erispulse_cyoa-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 781b6d614b39f30f41565be5bc98966f3480a97cbb6c7fb543d54c1ea19fa729
MD5 57c0b03388ea0f1673a85ad0d76e1507
BLAKE2b-256 6bd7229edc9cd5cc7136ca7951a819482be67ca7a3ed20111fc247555891c272

See more details on using hashes here.

Provenance

The following attestation bundles were made for erispulse_cyoa-1.1.3-py3-none-any.whl:

Publisher: python-publish.yml on wsu2059q/ErisPulse-CYOA

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page