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
140 commits 1 branch 15 tags 400 KiB
TypeScript 62.9%
JavaScript 30.6%
CSS 6.5%
Find a file
InkWeave Bot 672d91d5a4 chore(release): v2.3.0
2026-05-08 16:25:56 +08:00
.github/workflows chore(deps): update dependencies and release workflow 2026-04-22 06:22:08 +08:00
scripts chore(release): update changelog and fix release script tag reference 2026-04-24 10:10:03 +08:00
src refactor(core): migrate UI framework from Svelte to SolidJS 2026-05-08 16:25:18 +08:00
.editorconfig Initial commit 2025-03-04 10:25:20 +08:00
.gitignore chore(config): migrate build toolchain from React to Svelte 2026-05-06 09:15:55 +08:00
CHANGELOG.md chore(release): v2.3.0 2026-05-08 16:25:56 +08:00
LICENSE Update LICENSE 2025-03-11 11:21:43 +08:00
manifest.json chore(release): v2.3.0 2026-05-08 16:25:56 +08:00
package.json chore(release): v2.3.0 2026-05-08 16:25:56 +08:00
README.md docs(readme): update build steps for monorepo 2026-05-01 16:24:57 +08:00
README.zh-cn.md docs(readme): update build steps for monorepo 2026-05-01 16:24:57 +08:00
tsconfig.json refactor(core): migrate UI framework from Svelte to SolidJS 2026-05-08 16:25:18 +08:00
versions.json chore(release): v2.3.0 2026-05-08 16:25:56 +08:00
vite.config.ts refactor(core): migrate UI framework from Svelte to SolidJS 2026-05-08 16:25:18 +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

This plugin is part of the InkWeave monorepo. It depends on @inkweave/core, @inkweave/react, and @inkweave/plugins.

  • Clone the InkWeave repository.
  • Run git submodule update --init to pull the plugin source.
  • Run bun install to install dependencies.
  • Run bun run build:obsidian to build the plugin.
  • Run bun check for linting and type checking.