Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Changelog

All notable changes to the Drum Highway plugin. The format follows
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versions follow `plugin.json`.

## [Unreleased]

Version 4.1.0 in `plugin.json`.

### Added
- **Rock Band-style scoring** from a JavaScript port of YARG.Core's drums engine (`assets/engine.js`,
LGPL-3.0, see `NOTICE.md`): ±70 ms hit window, multiplier up to x4 (x8 in star power), pro-drums
cymbal/tom lanes, accent/ghost dynamics bonus, stars, and star power with fill activation. Driven
through `assets/session.js`, which also adds spot-on timing, roll and drum-solo bonuses. The 2D view
marks hits / misses from the engine and shows a score HUD when **Score** is on.
- **Difficulty per player** — Easy, Medium, Hard, Expert, Expert+ (`drums_difficulty_v1`), from the
settings panel, the HUD badge or D / Shift+D; Expert drops the double-kick notes. Easier levels, star
power, fills and solos come from the drum tab's feedpak 1.20.0 gameplay metadata; without it the song
plays Expert (plus Expert+ when the chart has double-kick notes, e.g. a legacy chart with GM 35 kicks),
without star power.
- **Assists** — auto kick / auto cymbals up to a chosen difficulty (played on the drum sound at their own
volume), hit-timing presets (Relaxed / Forgiving / Normal / Precision), **Pro cymbals** toggle and an
input **Offset** (ms) for audio / MIDI latency.
- **Timing meter** under the score: the last 24 hits early / late on a ±100 ms bar, their median, and the
input offset that would centre them, with an **Apply** button.
- **Star power without fills**: on charts with star power phrases but no drum fills, press **Enter** or
hit the **SP pad** (settings: off, hi-hat pedal, ride bell, splash or china; `drums_sp_pad_v1`) to
activate it. With fills, the note that ends a fill activates it, as before.
- **Results card** at the end of the song (single view, Score on): total score with the bonuses, best
score per song and difficulty (`drums.best:<song>|<difficulty>` in `localStorage`), stars, accuracy,
notes hit, best streak / full combo and where the points came from.
- The drum view on a part that isn't drums (no drum tab, arrangement not named Drums / Percussion) shows
"This song has no drums" or "Pick the Drums part" and plays / scores nothing, instead of reading guitar
notes as drum notes.

### Changed
- Hit timing: the view draws and scores on a smoothed per-highway clock (interpolated between the
player's audio samples, like core's 3D highway), a pad hit is timed when the MIDI message arrived
(its timestamp, when the MIDI provider passes one) rather than at the last frame, and the engine runs
60 ms behind the frame clock so a hit struck just before a frame is judged at its own time instead of
being moved forward to the frame.
- The input offset applies to the engine's clock as well as to the hits, so a positive offset no longer
leaves a late-registered hit facing a note the engine has already missed.
- MIDI velocity reaches the engine as 0..1 (velocity / 127); velocity 1 used to count as full strength.
- Auto kick / auto cymbals are timed from the audio clock (mapped to the stems plugin's audio context
when it is there), scheduled 100 ms ahead by one forward-only schedule shared by all drum views and
cancelled on pause / seek: no more late or doubled auto notes.
- Splitscreen: kit hits go to the focused drum view if it is on screen, else to the drum view that is,
so a hidden main-player drum view no longer swallows them.
- A scoring file that failed to load is loaded again on the next try (its dead `<script>` element is
removed).
- A drum-tab hit is an accent only when the tab marks it (`a`, feedpak 1.20.0) or, for older tabs, when it
has a written velocity of 100 or more; a hit with no velocity is no longer drawn as an accent. A kick
marked `x2` is a double kick (GM 35).
- The "Hits" checkbox is now **Score**.
674 changes: 674 additions & 0 deletions LICENSE.GPL-3.0

Large diffs are not rendered by default.

165 changes: 165 additions & 0 deletions LICENSE.LGPL-3.0
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.


This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.

0. Additional Definitions.

As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.

"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.

An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.

A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".

The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.

The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.

1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.

2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:

a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or

b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.

3. Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:

a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the object code with a copy of the GNU GPL and this license
document.

4. Combined Works.

You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:

a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.

c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.

d) Do one of the following:

0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.

1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.

e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)

5. Combined Libraries.

You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:

a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.

b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.

6. Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
26 changes: 26 additions & 0 deletions NOTICE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Licensing notice for the drums plugin

Most of this plugin is original code under the **MIT** license (see `README.md`). That includes
`screen.js`, `assets/session.js`, `plugin.json`, the other assets and the tests other than
`tests/engine.test.js`.

Two files are ports of [YARG.Core](https://github.com/YARC-Official/YARG.Core) and are licensed under the
**GNU Lesser General Public License v3.0** (full text in [`LICENSE.LGPL-3.0`](LICENSE.LGPL-3.0); the LGPL
builds on the GNU GPL v3.0, whose text is in [`LICENSE.GPL-3.0`](LICENSE.GPL-3.0)):

| File | Status |
|------|--------|
| `assets/engine.js` | LGPL-3.0. JavaScript port, with modifications, of YARG.Core's drums engine (`Engine/Drums/DrumsEngine.cs`, `Engine/Drums/Engines/YargDrumsEngine.cs`, `DrumsEngineParameters.cs`, `DrumsStats.cs`, `Engine/BaseEngine*.cs`, `BaseStats.cs`, `HitWindowSettings.cs`, `Chart/Notes/DrumNote.cs`, `Note.cs`, drum activation flags from `InstrumentDifficultyExtensions.cs`, and defaults from `Game/Presets/EnginePreset*.cs`). It also takes the drum star thresholds from YARG's `DrumsPlayer.cs` (LGPL-3.0). Copyright (c) YARC (YARG) contributors. |
| `tests/engine.test.js` | LGPL-3.0. Tests for `engine.js`, partly ported from `YARG.Core.UnitTests/Engine/DrumEngineTester.cs` and `DrumsStatsTests.cs`. |

`assets/engine.js` is a standalone, unminified script with no dependencies, shipped as its own file and
loaded at runtime. `screen.js` and `assets/session.js` only use it through its public API
(`window.DrumsEngine` / `require('./engine.js')`), so they remain separate MIT works that use the Library
as described in LGPL-3.0 section 4 ("Combined Works"). You may replace `assets/engine.js` with a modified
version. A modified `assets/engine.js` that you distribute is conveyed under LGPL-3.0 or, as LGPL-3.0
section 2(b) allows, under the GPL-3.0 (without the LGPL's additional permissions), with its source
available either way. Combining an LGPL-3.0 file with MIT code this way is permitted by both licenses, and
both are compatible with feedBack's AGPL-3.0.

The header of `assets/engine.js` lists every behaviour that deviates from YARG ("Deviations from YARG").
The scoring look and feel imitates rhythm-game drum tracks but uses no artwork, fonts or logos from them.
Loading