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
98 commits 1 branch 15 tags 400 KiB
TypeScript 62.9%
JavaScript 30.6%
CSS 6.5%
Find a file
InkWeave Bot d9b7dedabe chore(release): v2.0.2
2026-04-08 09:00:01 +08:00
.github/workflows chore(ci): update release workflow to use release notes from changelog 2026-03-31 13:06:42 +08:00
scripts chore(changelog): regenerate with correct tag references 2026-03-31 12:59:16 +08:00
src feat(plugin): register ink file extension 2026-04-08 08:59:09 +08:00
.editorconfig Initial commit 2025-03-04 10:25:20 +08:00
.gitignore chore(build): migrate from esbuild to vite 2026-03-31 11:11:29 +08:00
.npmrc Initial commit 2025-03-04 10:25:20 +08:00
biome.json chore(tooling): replace eslint with biome 2026-03-31 11:11:38 +08:00
bun.lock chore(deps): upgrade dependencies and clean up dev dependencies 2026-04-08 08:59:04 +08:00
CHANGELOG.md chore(release): v2.0.2 2026-04-08 09:00:01 +08:00
LICENSE Update LICENSE 2025-03-11 11:21:43 +08:00
manifest.json chore(release): v2.0.2 2026-04-08 09:00:01 +08:00
package-lock.json fix(session): prevent double compiledStory() race in view.setState() 2026-03-23 01:23:27 +01:00
package.json chore(release): v2.0.2 2026-04-08 09:00:01 +08: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
tsconfig.json chore(build): migrate from esbuild to vite 2026-03-31 11:11:29 +08:00
versions.json chore(release): v2.0.2 2026-04-08 09:00:01 +08:00
vite.config.ts chore(build): migrate from esbuild to vite 2026-03-31 11:11:29 +08:00
vitest.config.ts chore(build): migrate from esbuild to vite 2026-03-31 11:11:29 +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.
  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.