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.