https://github.com/liubinfighter/obsidian-tab-flow
Play and Create guitar tabs using AlphaTab. Modern music font and sound! (Support .alphatab, .gp, .gp3, .gp4, .gp5, .gpx)
https://github.com/liubinfighter/obsidian-tab-flow
alphatab guitar midi obsidian
Last synced: about 2 months ago
JSON representation
Play and Create guitar tabs using AlphaTab. Modern music font and sound! (Support .alphatab, .gp, .gp3, .gp4, .gp5, .gpx)
- Host: GitHub
- URL: https://github.com/liubinfighter/obsidian-tab-flow
- Owner: LIUBINfighter
- License: mpl-2.0
- Created: 2025-05-31T23:47:24.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-07-06T07:30:57.000Z (12 months ago)
- Last Synced: 2025-07-06T08:33:07.961Z (12 months ago)
- Topics: alphatab, guitar, midi, obsidian
- Language: JavaScript
- Homepage:
- Size: 4.44 MB
- Stars: 5
- Watchers: 0
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://doi.org/10.5281/zenodo.18446852)
[](https://github.com/LIUBINfighter/Obsidian-Tab-Flow/actions/workflows/ci.yml)
[](https://github.com/LIUBINfighter/Obsidian-Tab-Flow/releases/latest)
[](https://deepwiki.com/LIUBINfighter/obsidian-tab-flow)
# Tab Flow (Obsidian plugin)
Play and create your guitar tabs in Obsidian!
## Feature
- Render and play guitar pro files (.gp, .gp3, .gp4, .gp5, .gpx).
- Render tabs
- PlayPause/Stop
- cursor
- Darkmode
- auto-scroll
- Control components (tracks control, save settings, Layout, Zoom, Speed, CountIn, Metronome)
- Write scores in `alphaTex` (.atex or `alphaTex` codeblock in .md) and share it.
- Highlight syntax (codemirror plugin)
- gp export
- pdf(wip)
- png card
- Built-in doc for you to learn and enjoy alphaTex.
### Customed Play experience
### Write Guitar Tabs like Markdown
`.atex`
`alphaTex` codeblock in `.md`
### Share your riff (Beta)
### Learn alphaTex in built-in interactive playground
Enter the document view by command or click the robbin icon `guitar`.
## Install & Enable Play Font
### 1 install by bart42 (recommended, provide detailed version control & beta access)
1. Install Brat plugin (if not yet)
- search for BRAT
- Install & enable BRAT
2. Add Tab Flow plugin
- Jump to Option
- Add beta plugin
```
https://github.com/LIUBINfighter/Obsidian-Tab-Flow
```
- Select version & Add plugin
3. Download missing assets
- Open Tab Flow settingTab
- Downding missing asset files
- Reload Tab Flow plugin or Obsidian app
For Security reason, obsidian community plugin can't request from web automatically to prevent potential malicious attack, so it's neccesarry for you to do manually comfirm.
Tab Flow plugin uses a npm package @coderline/alphatab [github repo](https://github.com/CoderLine/alphaTab), where the package content (font & sound font) comes from. We plan to provide other font resources when ready.
Currently Tab Flow plugin downloads assets fromm github release(frozen and immutable release/tag, 0.0.5 for now). If you do concern about the code, please refer to the latest tag & release.
### 2 download by github release & manual install
Release `tab-flow.zip` contains assets in right dictory position, so there is no need to download assets and reload again.
### 3 (Unable, currently in review queue) Obsidian Community Plugin Market
[Click here](obsidian://show-plugin?id=tab-flow) or search `Tab Flow` and enable it.
## RoadMap
- 0.3.x (we are here!) maintain
- 0.4.x (work in progress) Refactor player and editor (React and Zustand), introduce alphaTex 2.0 when ready.
- 0.?.x Not sure yet.
- 1.0.0 Train a vlm for alphaTex ocr and integrate it in tab-flow.
## Contributing
Thanks for downloading this plugin and I appreciate it if you can help contribute!
If you have any feature requests / bugs to report, feel free to have an issue.
If you have done something brilliant, then go for a pull request. Before you push something, better to start a discussion or issue, so we can discuss it together.
## Inspired by ...
[AlphaTab.js](https://alphatab.net)
Bocchi the rock!
Girls' Band Cry
## Disclaimer
Please make a backup for your gp files. Currently Tab flow will not rewrite back to your guitar pro files but some tabs rendered with bad results because of the different encoding methods for Chinese/Japanese/... characters (CJK) or some other encoding reasons.
This plugin can't automatically download `font`, `soundfont` and `worker.mjs` for you due to obsidian's policy about community plugins. However, we provide a bottom to complete the settings.
## Copyright & Credit
Copyright (c) 2025 Jay Bridge and other contributors. All rights reserved.
Licensed under the MPL 2.0 License.
## Special Thanks to
