vscode-inky
A Visual Studio Code extension that provides live preview for Inkle's Ink interactive narrative scripting language.
Features
- Syntax Highlighting: Rich syntax highlighting for Ink language constructs including knots, stitches, choices, diverts, logic blocks, tags, and more
- Live Preview: View your Ink stories in real-time as you write them
- Interactive Playthrough: Make choices and navigate through your story directly in the preview
- Auto-Reload: Preview automatically updates when you save your .ink file
- Error Display: See compilation errors directly in the preview window
- Restart Capability: Easily restart your story from the beginning
Usage
- Open any
.ink file in VS Code
- Click the preview icon (📖) in the editor toolbar, or use the command palette (
Cmd+Shift+P / Ctrl+Shift+P) and search for "Ink: Open Preview"
- The preview will open in a side panel
- Make changes to your .ink file and save - the preview will automatically update
- Click on choices to navigate through your story
- Click "Restart Story" at the end to play through again
Example
Try the example story included in the examples/sample.ink file to see the extension in action!
Requirements
This extension uses inkjs to compile and run Ink stories. All dependencies are included with the extension.
About Ink
Ink is a powerful narrative scripting language created by Inkle for writing interactive fiction. It's used in games like 80 Days and Heaven's Vault.
Learn more about Ink:
Release Notes
0.0.1
Initial release:
- Syntax highlighting for .ink files
- Live preview for .ink files
- Interactive story playthrough
- Auto-reload on file save
- Error handling and display
Contributing
Found a bug or have a feature request? Please open an issue on the GitHub repository.
Enjoy writing interactive stories with Ink!
| |
