open-lyric-plugin-player 0.0.0-stage → 0.1.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 raksa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,86 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# open-lyric-plugin-player
+
+Hear an [Open Lyric](../open-lyric) song's strumming patterns, and every chord
+Open Lyric offers, on ten instruments: acoustic, classical and electric
+guitar, piano, electric piano, organ, ukulele, baritone ukulele, bass and
+upright bass.
+
+## Install
+
+```bash
+npm i open-lyric open-lyric-plugin-player
+```
+
+`open-lyric` is a peer dependency. This package contains no copy of it.
+
+## Use
+
+The full playground UI:
+
+```js
+import { OpenLyricPlayerPlayground } from 'open-lyric-plugin-player';
+
+const root = document.getElementById('root');
+const playground = new OpenLyricPlayerPlayground({ container: root, theme: 'dark' });
+playground.render();
+```
+
+`theme` is `'light'` or `'dark'`. Leave it out and the system's colour scheme
+decides. `playground.setTheme(…)` switches the theme at runtime.
+
+The headless player:
+
+```js
+import { OpenLyricPlayer } from 'open-lyric-plugin-player';
+
+const player = new OpenLyricPlayer();
+
+// Call it from a user gesture, so the browser allows audio.
+button.onclick = () =>
+  player.playPattern({ pattern: 'd--u-- | d-u-d-', key: 'E', tempo: 70, instrument: 'guitar' });
+```
+
+The plugin for the `open-lyric` previews — a play button on every
+strumming-pattern card, chords that play when clicked, and an Instrument
+picker in the settings popup:
+
+```js
+import { OpenLyric } from 'open-lyric';
+import { OpenLyricPluginPlayer } from 'open-lyric-plugin-player';
+
+const preview = new OpenLyric({ container, value: song });
+preview.addPlugin('player', new OpenLyricPluginPlayer());
+await preview.mount();
+```
+
+It attaches to an `OpenLyricMarkdownManager` the same way.
+
+`how-to_open-lyric-plugin-player.md` in this package covers every option,
+method, event and error.
+
+## Licenses
+
+This package's code is MIT, its voice engine included. The sound it plays
+ships as separate, unmodified asset files in `dist/assets/`:
+
+- the WebAudioFont player script (GPL-3.0-or-later, by Sergey Surikov), which
+  only decodes the soundfonts;
+- the webaudiofontdata soundfonts of the FluidR3_GM bank (MIT).
+
+The player script is loaded at runtime by its own `<script>` tag. It is never
+bundled into the MIT code.
+
+
+### Releasing to npm
+
+For maintainers, from a clean `main`:
+
+```bash
+npm test
+npm pack --dry-run                          # check which files go in the package
+npm whoami                                  # run `npm login` if this fails
+npm version patch --tag-version-prefix=""   # or minor / major
+npm publish
+git push origin main --follow-tags
+npm view open-lyric-plugin-player version   # confirm the new version is live
+```