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
47 commits 1 branch 15 tags 400 KiB
TypeScript 62.9%
JavaScript 30.6%
CSS 6.5%
Find a file
Yabuk 6bdd2cee63 fix(deps): bump @types/node to ^20.0.0 for vitest 4.x compatibility 
vitest@4.x requires @types/node@^20 || ^22 || >=24.
The old ^16.11.6 constraint caused ERESOLVE in CI.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-23 01:27:12 +01:00
.github/workflows Add release workflow 2025-03-08 08:56:37 +08:00
src test(session): add full simulation round-trip and real useStory tests 2026-03-23 01:23:27 +01: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 Update LICENSE 2025-03-11 11:21:43 +08:00
main.ts feat: 创建 Ink Player 插件 2025-03-04 21:17:37 +08:00
manifest.json build(版本号): 更新版本号至 1.1.0 2025-03-18 11:58:41 +08:00
package-lock.json fix(session): prevent double compiledStory() race in view.setState() 2026-03-23 01:23:27 +01:00
package.json fix(deps): bump @types/node to ^20.0.0 for vitest 4.x compatibility 2026-03-23 01:27:12 +01:00
README.md Update README.md 2025-05-21 18:52:05 +08:00
README.zh-cn.md Update README.zh-cn.md 2025-05-21 18:52:27 +08:00
styles.css fix(ui): rewrite save/restore modal with custom styles 2026-03-23 01:23:27 +01:00
tsconfig.json feat(settings): 添加新设置项并优化国际化 2025-03-21 15:30:56 +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
vitest.config.ts fix(session): prevent double compiledStory() race in view.setState() 2026-03-23 01:23:27 +01: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.
  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.