Repository navigation
Add README and CI stub, remove duplicate root styles.css #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| name: ci | ||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| jobs: | ||
| ci: | ||
| uses: got-feedback/.github/.github/workflows/reusable-ci.yml@main | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # Bongo Cat's Rhythm Trainer | ||
|
|
||
| A feedBack minigame plugin for practicing rhythms on your real instrument — guitar, bass, piano, or drums. Bongo Cat demos a rhythm pattern in time with the metronome, then you play it back; your hits are picked up through feedBack's note detection and judged against the beat. | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| ## How it works | ||
|
|
||
| - Pick an instrument, mode, and tempo from the minigame modifiers. | ||
| - Bongo Cat plays the pattern first (with paw animations synced to the beat), and a notation strip shows what to play. | ||
| - Play the pattern back. Each hit is scored discretely (timing judgement per note), with a HUD tracking your accuracy and streak. | ||
| - **Learning mode** eases you in and repeats patterns; **Challenge mode** keeps generating new ones and pushes the difficulty. | ||
| - Run history is kept per session so you can see your progress over time. | ||
|
|
||
| ## Modifiers | ||
|
|
||
| | Modifier | Values | Default | | ||
| |---|---|---| | ||
| | Instrument | guitar/bass, piano, drums | guitar/bass | | ||
| | Mode | learning, challenge | learning | | ||
| | Tempo (BPM) | 60–160 in 20 BPM steps | 80 | | ||
| | Calibration | auto, on, off | auto | | ||
|
|
||
| ## Structure | ||
|
|
||
| - `game.js` — plugin entry point | ||
| - `src/` — game logic: beat clock, pattern generator, input gate/judge, scoring, run controller, FSM, HUD, notation strip, cat animations | ||
| - `src/notedetect-bridge.js` — bridge to feedBack's note-detection plugin | ||
| - `routes.py` — server-side routes | ||
| - `assets/` — sprites, fonts, styles | ||
| - `docs/implementation-artifacts/` — design notes per feature | ||
|
|
||
| ## Development | ||
|
|
||
| ```bash | ||
| npm install | ||
| npm test # vitest | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.