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
119 commits 1 branch 15 tags 400 KiB
TypeScript 62.9%
JavaScript 30.6%
CSS 6.5%
Find a file
Uglyboy 85f30ef468 refactor(plugin-core): migrate to Plugins API and consolidate module structure 
- Replace applySettings() with @inkweave/core Plugins API
- Move Settings/DEFAULT_SETTINGS types to types.ts
- Merge SettingsTab from settingsTab.ts into settings.ts
- Replace InkWeavePlayer component with render() function in components/index.tsx
- Rename storyCompiler.ts to compile.ts and add utils/index.ts
- Update view.tsx to use new render() and compile() APIs
2026-04-24 10:10:00 +08:00
.github/workflows chore(deps): update dependencies and release workflow 2026-04-22 06:22:08 +08:00
scripts chore(config): improve view lifecycle and update configuration 2026-04-21 10:44:07 +08:00
src refactor(plugin-core): migrate to Plugins API and consolidate module structure 2026-04-24 10:10:00 +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
biome.json chore(config): improve view lifecycle and update configuration 2026-04-21 10:44:07 +08:00
bun.lock chore(deps): upgrade @inkweave packages to v1.6.0 and remove unused deps 2026-04-24 10:09:57 +08:00
CHANGELOG.md chore(changelog): update changelog script and release notes for v2.0.6 2026-04-18 06:36:22 +08:00
LICENSE Update LICENSE 2025-03-11 11:21:43 +08:00
manifest.json chore(release): v2.0.7 2026-04-22 06:23:07 +08:00
package.json chore(deps): upgrade @inkweave packages to v1.6.0 and remove unused deps 2026-04-24 10:09:57 +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 feat(types): add CSS modules type declarations 2026-04-22 06:22:02 +08:00
versions.json chore(release): v2.0.7 2026-04-22 06:23:07 +08:00
vite.config.ts refactor(plugin-entry): rename plugin.ts to main.ts and update config 2026-04-22 06:21:49 +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.