Skip to content

docs: describe usage as a visualization renderer - #27

Open
odntht wants to merge 1 commit into
got-feedBack:mainfrom
odntht:docs/v3-visualization-usage
Open

odntht wants to merge 1 commit into
got-feedBack:mainfrom
odntht:docs/v3-visualization-usage

Conversation

@odntht

@odntht odntht commented Oct 16, 2026

Copy link
Copy Markdown

What was wrong

The Installation section said: A "Drums" button will appear in the player controls when you play a song. Click the gear icon next to it... That no longer matches the code:

  • plugin.json declares "type": "visualization", and screen.js registers window.feedBackViz_drums (with slopsmithViz_drums as an alias). Core's picker (static/js/viz.js) lists it by its name, Drum Highway, in the Visualization & quality popover (#viz-picker in static/v3/index.html).
  • With Auto (match arrangement), createFactory.matchesArrangement picks it for songs with has_drum_tab and for arrangements matching /\b(?:drums|percussion|drum\s*kit)\b/i.
  • The plugin doesn't inject any "Drums" button. It only injects a ⚙ settings gear, and only while the renderer is active (init → _injectSettingsGear, destroy → _removeSettingsGear). The gear goes into #player-controls, or into the panel bar under splitscreen, and the v3 UI re-homes it into the Plugin controls popover (static/v3/player-chrome.js).

What changed

  • Replaced that sentence with a short Usage section: pick the visualization, or let Auto pick it. The gear opens the settings, and you switch back by choosing another visualization. The README mentions the drum-tab case.
  • The Auto-activate feature bullet now says it works through Auto mode.
  • Added a one-line note that the desktop app bundles the plugin (feedBack-desktop/scripts/build-common.sh).

Verification

  • Every label (Auto (match arrangement), Classic 2D Highway, Visualization & quality, Plugin controls) was checked against core main.
  • The match patterns were checked against screen.js.

Docs only. I left the clone URL alone because #13 already changes its casing. The new section has no overlap with it.

🤖 Generated with Claude Code

The README said a button appears in the player controls. Since 4.0.0 the
plugin is a visualization renderer (plugin.json "type": "visualization",
window.feedBackViz_drums), so it is chosen in the viz picker or by Auto
mode via matchesArrangement. Only the settings gear is injected, and v3
re-homes it into the Plugin controls popover. Rewrite Usage for that.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: odntht <odntht@gmail.com>
@coderabbitai

coderabbitai Bot commented Oct 16, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: d83cd2be-24e2-4238-8cf8-74d69a822727
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant