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

1. Install the extension.
2. Open or create an .otab file.
3. Use the Command Palette to run OpenTab commands:
   • OpenTab: Format Document
   • OpenTab: Preview (ASCII)
   • OpenTab: Export ASCII
   • OpenTab: Export MIDI
   • OpenTab: 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

1. Build the package:

   npm run vsce:package
   

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

1. Open this folder (editors/vscode) in VS Code.
2. Press F5 to launch an Extension Development Host.
3. In the new window, open or create an .otab file 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:

• Webview Message Protocol