feedBack/docs/diagnostics/README.md
Bret Mogilefsky af2949677a
rename: slopsmith → feedBack, byron → got-feedBack (#537)
* Update GitHub repo references from feedback* to feedBack*

* rename: slopsmith -> feedBack, byron -> got-feedBack

Renames across the entire codebase:
- slopsmith/Slopsmith/SLOPSMITH/SlopSmith -> feedBack/FeedBack/FEEDBACK/FeedBack
- byron/Byron/Byrongamatos -> got-feedBack/got-feedBack/got-feedBack
- /home/byron/ -> /opt/got-feedBack/
- byron@ougsoft.com -> hi@got-feedBack.org
- github.com/byrongamatos/ -> github.com/got-feedback/
- com.byron. -> com.got-feedback.
- SLOPSMITH_ env vars -> FEEDBACK_ with backward-compat fallback
- Protocol/storage strings migrated with read-old/write-new pattern
- window.slopsmith JS API -> window.feedBack (canonical) + backward-compat alias

Refs: #rename-slopsmith

* rename: complete regen against current main + fix backward-compat alias

Regenerated the slopsmith->feedBack / byron->got-feedBack rename on top of
current main (3 commits had landed since the branch: #572/#554/#574),
resolving the four content conflicts in favour of main's newer content
(autoplay/auto-exit, accuracy-badge, Virtuoso re-home, feedpak badge).

Completion fixes on top of the mechanical rename:
- Re-apply rename to post-branch content the original rename never saw:
  window.slopsmith(.Tour) consumers in lessons.js / notifications.js /
  onboarding-tour.js, and the matching JS + python tests (autoplay_exit,
  progression_*, test_feedpak_extension FEEDBACK_* env vars). The test env
  vars now match server.py (which reads FEEDBACK_SYNC_STARTUP /
  FEEDBACK_SKIP_STARTUP_TASKS), so the sync-startup test exercises the real
  path again.
- Restore the window.slopsmith backward-compat alias dropped during conflict
  resolution, and move the bus aliases to AFTER the _feedBackExisting merge
  block so they reference the fully-assembled object (also fixes the
  loop_api.test.js API-surface regex, which the original PR latently broke).
- Drop the stray empty data/web_library.db (runtime DB lives in CONFIG_DIR)
  and gitignore it.
- Fix stale tone-source test: feed[dB]ack -> fee[dB]ack to match shipped
  source labels.

Verified locally (org CI billing-blocked): JS 819/819 pass; pytest 1669
passed / 1683 collected with 0 import errors; zero residual slopsmith/byron
except the two intentional window.slopsmith aliases.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* rename: implement advertised backward-compat + prune dead community plugins

Address gaps where PR #537's "Backward compatibility" section was advertised
but not implemented, and clean up the community plugin list.

Env vars (FEEDBACK_* canonical, legacy SLOPSMITH_* honoured):
- New lib/env_compat.py (getenv_compat / env_flag_compat) + tests. server.py
  (_env_flag + all FEEDBACK_* reads), diagnostics_hardware, gp2midi and
  tailwind_rebuild now resolve the legacy alias, so existing SLOPSMITH_UI /
  SLOPSMITH_PLUGINS_DIR / etc. deployments keep working.
- Fix the rename collapsing plugins/__init__.py and minigames/routes.py from
  `FEEDBACK_PLUGINS_DIR or SLOPSMITH_PLUGINS_DIR` into a redundant
  `FEEDBACK_ or FEEDBACK_` (the fallback was silently lost).

Storage (app.js update-channel):
- Read feedBack-update-channel, fall back to legacy slopsmith-update-channel,
  and clear the legacy key on write — so a user's update-channel preference
  survives the rename instead of resetting to "stable".

Community plugin list (README): the rename rewrote third-party repo URLs we
don't own. Probed every one; their owners never renamed, so:
- Restore the 13 live community plugins to their real slopsmith-* names.
- Prune 6 that are 404 to the public (topkoa splitscreen/stems, OmikronApex
  tuner, Jafz2001 nam-rig-builder, DeathlySin song-preview, Erikcb91 shuffle).
- Fix a pre-existing Guitar Theory clone-command typo (nam-tone -> guitar-theory).

Verified: env_compat 7/7, JS 819/819, pytest 1690 collected / 0 import errors,
rename-sensitive + startup suites green.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: byrongamatos <xasiklas@gmail.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-23 11:03:01 +02:00

2.5 KiB

FeedBack diagnostic sloppaks

Generated, non-copyrighted mini-songs for technique-assessment style checks. Report-only — they do not change gameplay settings or detection thresholds.

Basic Guitar (POC)

Artifact: feedBack-diagnostic-basic-guitar.sloppak

Contents (~55 s):

  • 3 s count-in (quiet click)
  • Open thickest string, open next string
  • Thickest string, 5th fret
  • Repeated E5 power chords (thickest open + next string fret 2)
  • Repeat pass: open, fretted, power chords again

Sections: Intro, Open Strings, Fretted Note, Power Chords, Repeat Check.

Manifest includes a custom diagnostic: tag (ignored by the loader today; for future Technique Assessment integration).

Rebuild

From the feedBack repo root (requires ffmpeg; the feedBack Docker image has libvorbis, Homebrew ffmpeg may use the built-in vorbis encoder):

python3 docs/diagnostics/build_diagnostic_basic_guitar.py

Builtin seeding

On library scan startup (and periodic rescans), the server copies bundled diagnostic sloppaks into the user DLC folder when missing or when the bundled source is newer:

DLC_DIR/diagnostics-builtin/feedBack-diagnostic-basic-guitar.sloppak

Source: docs/diagnostics/feedBack-diagnostic-basic-guitar.sloppak (next to server.py in dev; must be included in the desktop bundle — see feedBack-desktop/scripts/bundle-feedBack.sh).

Unlike tutorials-builtin/, diagnostics-builtin/ is included in the library scan. Tracks appear under FeedBack / Technique Assessment Diagnostics.

Existing destination files are not overwritten unless the bundled source has a newer modification time. User files elsewhere (e.g. diagnostics-test/) are never touched.

Manual install / test

Normally seeding is automatic once a DLC folder is configured. To test a custom copy or an unreleased build:

  1. Copy feedBack-diagnostic-basic-guitar.sloppak into your FeedBack DLC folder (e.g. diagnostics-test/ or any scanned path).
  2. Restart FeedBack or trigger a library rescan if the song does not appear.
  3. Load FeedBack Diagnostic — Basic Guitar.
  4. Play the Diagnostic Guitar arrangement.
  5. Confirm the 3D highway shows open notes and power-chord gems.
  6. Turn Detect on — note_detect should push the chart to the desktop verifier on song:ready like any other sloppak.

Future

  • Bass diagnostic sloppak
  • 7/8-string guitar variants
  • Drums (drum_tab.json)
  • Piano/keys (separate wire model)
  • Detection Health “Run Basic Guitar Diagnostic” launch button (note_detect)