Obsidian Stats logoObsidian Stats

Ink Player

by Uglyboy
5
4
3
2
1
Score: 55/100
Install Code

Description

Category: Creative & Writing Tools
#interactive-fiction#ink#storytelling

The Ink Player plugin brings interactive storytelling into Obsidian by allowing users to play ink-based fiction directly within their notes. Designed to work with Inkle's ink scripting language, this plugin transforms .ink files into playable narratives with full support for advanced features like custom tags, save/load functionality, and seamless mobile compatibility. Users can activate stories through a command or ribbon button and experience branching paths, choices, and immersive dialogue as part of their knowledge management workflow.

Reviews

No reviews yet.

Stats

5
stars
521
downloads
1
forks
410
days
2
days
2
days
4
total PRs
0
open PRs
0
closed PRs
4
merged PRs
0
total issues
0
open issues
0
closed issues
0
commits

Latest Version

2.3.0
2 days ago

Changelog

Refactoring

  • core: migrate UI framework from Svelte to SolidJS

Full Changelog: https://github.com/uglyboy-tl/obsidian-ink-player/compare/2.2.0...2.3.0

See all version on GitHub

README file from

Github

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.
Sponsors