OpenTab VS Code Extension
OpenTab VS Code Extension
OpenTab is a minimal, explicit tablature format. This extension adds editor support for .otab files.
Features
- Syntax highlighting
- Format Document
- Preview (ASCII)
- Export ASCII
- Export MIDI
- Play MIDI (opens default player)
How to use
- Install the extension.
- Open or create an
.otabfile. - Use the Command Palette to run OpenTab commands:
OpenTab: Format DocumentOpenTab: Preview (ASCII)OpenTab: Export ASCIIOpenTab: Export MIDIOpenTab: Play MIDI
Screenshots
Screenshot placeholders (add images when available):
- Preview (ASCII)
- Export MIDI
Install
From Marketplace
Placeholder until published.
https://marketplace.visualstudio.com/items?itemName=Homeputers.opentab-vscode
From VSIX
- Build the package:
npm run vsce:package - Install the generated
.vsix:code --install-extension opentab-vscode-*.vsix
Publish
Ensure dependencies are installed before publishing (required for vsce validation):
npm run vsce:publish
Dev run
- Open this folder (
editors/vscode) in VS Code. - Press
F5to launch an Extension Development Host. - In the new window, open or create an
.otabfile to see highlighting.
Contributing
See the root documentation and specification for OpenTab guidelines:
- https://github.com/homeputers/opentab/blob/main/README.md
- https://github.com/homeputers/opentab/blob/main/spec/
Webview message protocol
The preview webview message contract is documented here: