obsidian-plugin/uglyboy-tl_obsidian-ink-player
1
0
Fork 0
mirror of https://github.com/uglyboy-tl/obsidian-ink-player.git synced 2026-07-22 05:42:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
19 commits 1 branch 15 tags 400 KiB
TypeScript 62.9%
JavaScript 30.6%
CSS 6.5%
Find a file
Uglyboy ff774e01d1 docs(README): 更新文档以匹配 Ink Player 插件 
- 修改 README.md 文件，移除与示例插件无关的内容
- 添加 Ink Player 插件的安装和使用说明
- 更新版本号至 1.0.0
2025-03-11 10:23:58 +08:00
.github/workflows Add release workflow 2025-03-08 08:56:37 +08:00
src refactor(save): 重构存储模块并优化记忆卡功能 2025-03-11 10:02:40 +08:00
.editorconfig Initial commit 2025-03-04 10:25:20 +08:00
.eslintignore Initial commit 2025-03-04 10:25:20 +08:00
.eslintrc Initial commit 2025-03-04 10:25:20 +08:00
.gitignore Initial commit 2025-03-04 10:25:20 +08:00
.npmrc Initial commit 2025-03-04 10:25:20 +08:00
esbuild.config.mjs Initial commit 2025-03-04 10:25:20 +08:00
LICENSE Initial commit 2025-03-04 10:25:20 +08:00
main.ts feat: 创建 Ink Player 插件 2025-03-04 21:17:37 +08:00
manifest.json docs(README): 更新文档以匹配 Ink Player 插件 2025-03-11 10:23:58 +08:00
package-lock.json feat: 创建 Ink Player 插件 2025-03-04 21:17:37 +08:00
package.json docs(README): 更新文档以匹配 Ink Player 插件 2025-03-11 10:23:58 +08:00
README.md docs(README): 更新文档以匹配 Ink Player 插件 2025-03-11 10:23:58 +08:00
README.zh-cn.md docs(README): 更新文档以匹配 Ink Player 插件 2025-03-11 10:23:58 +08:00
styles.css feat(components): 实现内容淡入效果并优化故事展示逻辑 2025-03-10 14:53:30 +08:00
tsconfig.json feat: 创建 Ink Player 插件 2025-03-04 21:17:37 +08:00
version-bump.mjs Initial commit 2025-03-04 10:25:20 +08:00
versions.json Initial commit 2025-03-04 10:25:20 +08:00

README.md

Ink Player for Obsidian

English | 中文

This is an open-source Obsidian plugin for playing interactive fiction powered by Inkle's ink engine, designed for web games.

You can find a guide to the basics of ink here.

Thanks to Calico, this plugin offers a wealth of new features, including custom tags, full mobile compatibility, game saving, and advanced parsing.

Installation

  1. In Obsidian, navigate to Settings → Community Plugins → Browse.
  2. Search for Ink Player and select the Ink Player plugin.
  3. Click Install.
  4. Click Enable.

Usage

  1. Open an Ink script file (usually with a .ink extension).
  2. Use the Activate Ink Story command (available via the command palette or the dedicated ribbon button).
  3. Enjoy your story!

Contributing

  • Clone this repository.
  • Run npm i or yarn to install dependencies.
  • Run npm run dev to start compilation in watch mode.