Ink Player
by Uglyboy
Score: 15/100
favorite
share
Description
Category: Creative & Writing Tools

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.

Stats
0
stars
20
downloads
0
forks
7
days
12
days
15
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
0
commits
Latest Version
16 days ago
Changelog
  • 重构了业务逻辑,增加了对功能组件的支持。
    • 可以更加方便灵活的构建新功能组件,而不需要修改骨干代码
    • 可以通过 Obsidian 的设置管理来控制功能组件的启用。
  • 修复了一些其他的小问题,并添加了部分样式。

Full Changelog: https://github.com/uglyboy-tl/obsidian-ink-player/compare/1.0.2…1.1.0

README file from

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 SettingsCommunity PluginsBrowse.
  2. Search for Ink Player and select the Ink Player plugin.
  3. Click Install.
  4. Click Enable.

Usage

  1. Open an Ink script file (usually with a .ink extension).
  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.