asterism-games 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a35db1346246e5d20505026e701fef357536cc75fa53f22bf47878398fb01c3
-  data.tar.gz: 79c4c46763e2104c3e4d03ba521327e9ceb5fa77fc74521cec6041eb3ca48b89
+  metadata.gz: e6e27396e105e0e9ab5c096030c51cb529a437291460df76fc6b0510fc9dff6d
+  data.tar.gz: 237c4a6b962e98dc9c3a7e1288c646989a256c1773dd8244ddc9146d5873db55
 SHA512:
-  metadata.gz: 2b31fdedf12d610dca0c8cbd4f1ae060b5b42eeab54dee46d62f0ced96d8895468b48e84db2eae2904489448329a19ef5888cf9cb2a514684c2610d4e0937d87
-  data.tar.gz: 9908df82204210223cecd09b651da9d12e3a27ee832433d0e57b74d4d895a7a9753c83c20b75cadfeff88ef94eb91f6564290be193b1e501a37ce209124b67d3
+  metadata.gz: e428ec7e87cc08c9727743c322448eb8a4c39c2d2fa0d6005eb4855dea335d3884d82ceae0a3da66e35e8ca88a07c03518a7c7329cc0d4f6b0395ba702b3da4f
+  data.tar.gz: 1f61104e967413c4c5ee65a75a71ad9ca572007b8fdfa3dd0518257ea585be1e6798cc804dfa0752b6a8fa002bf41046efabe94b80df80fa7cb2766a9af19663

data/CHANGELOG.md

@@ -3,6 +3,41 @@
 Versions before 0.11.1 are noted in the README where each feature is
 described ("games 0.10.0" and the like).
 
+## Unreleased
+
+## 0.22.0
+
+- Needs CRuby 3.4 or newer (`required_ruby_version >= 3.4`; 3.2 is past its end of life). The image is built on `ruby:3.4.11-slim`.
+
+## 0.21.0
+
+- **The commentary's sound** (README "The sound"): the page of
+  `commentate mahjong` plays Family mruby's mahjong app's BGM and effects,
+  the same sounds at the same moments as the app. The BGM follows the
+  app's scenes (the lobby, the game, the tense part, none at the end),
+  starts low (the app's levels: off, low, mid, high, **B** or the bar's
+  button) and goes down to half while the voice speaks. The effects (a
+  round's start, the jingles of the calls, riichi and the wins, the
+  winner's points, the draws, a discard, the fanfare at the end; as for
+  the app's spectator, no draw or turn sound) play beside the voice, sharing the APU's channels as in the
+  app; **E** turns them off and on; the page remembers both. Which sound
+  when is a pure function of two views (`commentate/mahjong_sounds.rb`);
+  each `state` event now carries `bgm` and `sounds`.
+- The files are in the gem (`commentate/assets/sounds/`, 3.6 MB: WAVs for
+  the effects, MP3s for the three tunes, `sounds.json`), made with Family
+  mruby's own APU emulator by fmruby-core's `tools/mahjong_sounds.rb`.
+  The effects are MIT here; the BGM is shiru8bit's under CC BY 3.0,
+  unchanged (`SOUNDS_LICENSE.txt`), credited in the page's corner. The
+  web server serves `/sounds/` (those files only) and
+  `/SOUNDS_LICENSE.txt`.
+
+## 0.20.1
+
+- `play mahjong`: an owner's command queued with `--commands` (`watch`,
+  `start`, `cpu` ...) while someone else holds the owner's role now says
+  so (「卓の主ではありません。卓の主の役が回ってくるのを待っています」)
+  instead of asking for a seat: since 0.20.0 an owner may be unseated.
+
 ## 0.20.0
 
 - **Watch games** (README "Watch games"): the owner of a mahjong table

data/README.md

@@ -92,7 +92,7 @@ nothing else (othello, the drawing board), `bin/asterism-games` (with
 `play`, the terminal clients of othello and mahjong: a mahjong table needs
 riichi_engine, its client does not; and `commentate`, a mahjong table watched
 in the browser with commentary, with the tile sheets of Family mruby's
-mahjong app). It depends on
+mahjong app and its sound: the effects and the BGM, "The sound"). It depends on
 the asterism gem only (0.7.1 or later in
 0.x; what came after 0.7.1, such as `@status` and `on_app_join`, is used
 when there). Not in it: mahjong (`app/`, it needs the riichi_engine fork
@@ -102,7 +102,7 @@ anthropic gem as well, which is not a dependency (`gem install anthropic`,
 "AI players").
 
 ```
-gem install asterism-games              # CRuby 3.2 or newer and a C compiler (asterism-zenoh)
+gem install asterism-games              # CRuby 3.4 or newer and a C compiler (asterism-zenoh)
 ```
 
 A host of the sample games on a plain zenohd (`games.yml`):
@@ -144,7 +144,7 @@ docs/install.md (`deploy/vps`, which pulls it, or builds it with
 
 ## Running
 
-From this checkout (everything, mahjong too). CRuby 3.2 or newer and a C
+From this checkout (everything, mahjong too). CRuby 3.4 or newer and a C
 compiler (asterism-zenoh compiles its extension). Bundler fetches the
 riichi_engine fork from GitHub (see "riichi_engine"). The `Gemfile` is for
 this checkout and the image (mahjong, the AI players); the gem's own needs
@@ -1568,7 +1568,8 @@ when it is taken), prints the address and opens it in the browser (macOS
   each, the newest at the bottom. Two seats to a row in a wide window, one
   in a narrow one (a phone). Keys: **Space** pauses (what comes meanwhile
   is held and shown when it goes on), **M** turns the voice off and on,
-  **H** hides the hands on that page (backs instead of the tiles, and the
+  **B** steps the BGM (off, low, mid, high), **E** turns the effects off
+  and on, **H** hides the hands on that page (backs instead of the tiles, and the
   lines that tell a hand left out). A table that several hosts put is
   chosen in the bar.
 - **The AI's one-liners.** Claude's short lines at the big moments,
@@ -1583,6 +1584,9 @@ when it is taken), prints the address and opens it in the browser (macOS
   Japanese voice when it has one (the bar says which voice, or that it has
   none). Browsers play sound only after the page has been clicked once:
   the page says so until then. "The voice" below.
+- **The sound.** The BGM and the effects of Family mruby's mahjong app,
+  at the moments the app plays them, the BGM low by default and lower
+  while the voice speaks. "The sound" below.
 - **The commentary.** Made by rules from the difference between one view
   and the one before (pure functions, `commentate/mahjong_events.rb` and
   `mahjong_phrases.rb`, so the host can take them over later), each event
@@ -1601,9 +1605,10 @@ when it is taken), prints the address and opens it in the browser (macOS
   game goes on as before. The delay of the table is the host's
   ("Spectators"); the page shows it and adds none.
 - **The web server.** HTTP by hand on the standard library's `socket`
-  (no gem): the page, its script and style, the two tile sheets and
-  `/events`, a stream of Server-Sent Events (`status`, `state`, `line`)
-  that pushes the table and the commentary. It listens on `127.0.0.1`
+  (no gem): the page, its script and style, the two tile sheets, the
+  sounds (`/sounds/`, the files of `assets/sounds/` only) and `/events`,
+  a stream of Server-Sent Events (`status`, `state`, `line`) that pushes
+  the table and the commentary. It listens on `127.0.0.1`
   only, answers GET (and HEAD) on those paths only, and refuses a request
   whose Host is not `127.0.0.1` or `localhost`. The page loads nothing from
   elsewhere.
@@ -1714,8 +1719,61 @@ your character before you publish anything; they can change):
   description too** (the page shows it in its corner).
 - Whoever you give generated voices to must follow the same terms, so
   they cannot be mixed into an MIT package. That is why this gem ships no
-  sound: each user makes the files with their own VOICEVOX, and they stay
-  on that machine.
+  voice: each user makes the files with their own VOICEVOX, and they stay
+  on that machine. (The sounds it does ship are the mahjong app's effects
+  and BGM, "The sound".)
+
+### The sound
+
+(games 0.21.0) The page plays the sound of Family mruby's mahjong app:
+its BGM for the scene and its effects and jingles for what happens, the
+same sounds at the same moments as the app. They are files in the gem
+(`lib/asterism_games/commentate/assets/sounds/`), made beforehand with
+Family mruby's own APU emulator from the app's notes and its NSF tunes
+(not played again by ear), and the page plays them with Web Audio after
+the first click (the browser's autoplay rule).
+
+- **The BGM** follows the app's scenes: the lobby (a table waiting, or no
+  table yet) "After The Rain", the game and its results "Spring Thing",
+  the tense part (a riichi on the table, or 10 tiles or fewer left)
+  "Encounter", nothing at the end of a game (the fanfare plays alone). A
+  tune starts from its beginning and repeats its loop without a seam.
+  **B** (or the bar's button) steps it off, low, mid, high: the app's
+  levels (low is 30 % of the tune's full level, mid 55 %, high 100 %, the
+  effects always at theirs), **low by default**.
+- **Ducking.** While the voice speaks (VOICEVOX or the browser's), the BGM
+  goes down to half its level, and back up a moment after the voice stops
+  (not between two lines). The effects are not lowered.
+- **The effects** come with each new view of the table, beside the voice
+  (never waiting in its queue): a round's start, the jingles of a call
+  (チー, ポン, カン), of a riichi, of a win (ロン, ツモ) followed by the
+  winner's points, a draw of the round and the abortive draws, a discard
+  (the app's sound for another player's discard, whoever made it), and
+  the fanfare at the end of the game (the app's spectator's: the
+  winner's). As for the app's spectator, a move sounds its discard only:
+  the player's own sounds (a draw, the turn coming) are not played. They
+  share the APU's four channels as in the app: a sound of a higher
+  priority still sounding keeps its channels, otherwise the newest wins.
+  A voice that would start on top of a jingle waits for most of it (at
+  most 0.6 s). **E** turns the effects off and on. The page remembers
+  both switches (the browser's local storage).
+- **Which sound, when** is a pure function of two views
+  (`commentate/mahjong_sounds.rb`), and each `state` event carries the
+  BGM's scene (`bgm`) and the effects (`sounds`, `[name, delay ms]`).
+- **The files.** The effects are WAVs (mono, 16-bit, the APU's 15720 Hz,
+  under 40 KB each); the three tunes are MP3s (24 kHz mono, 64 kbit/s,
+  about 1 MB each: the tune from its start through one pass of its loop,
+  115 to 154 s). `sounds.json` lists each with its SHA-256, the loop
+  points, the app's levels and scenes. They are made by fmruby-core's
+  `tools/mahjong_sounds.rb` (`ruby tools/mahjong_sounds.rb <dir>`;
+  `--check <dir>` makes them again elsewhere and says whether any differs).
+- **Their licenses** (`assets/SOUNDS_LICENSE.txt`): the effects are the
+  app's author's and are under the MIT License in this gem, by his
+  decision (fmruby-core keeps them under GPL-3.0). **The BGM is not MIT**:
+  the tunes are by shiru8bit under CC BY 3.0, unchanged (only played from
+  their NSF files and saved as MP3). The page shows
+  「BGM: shiru8bit (CC BY 3.0)」 in its corner while the BGM is on, beside
+  the voice's credit; put it in a stream's description too.
 
 ### The AI's one-liners
 

data/VERSION

@@ -1 +1 @@
-0.20.0
+0.22.0

data/lib/asterism_games/commentate/assets/SOUNDS_LICENSE.txt

@@ -0,0 +1,63 @@
+The sounds in sounds/
+
+These are the sound of Family mruby's mahjong app (fmruby-core,
+flash/app/game/mahjong/mahjong_sound.rb), which the commentary page plays:
+the effects and jingles, and the BGM of its scenes. They were not played
+again by ear: fmruby-core's tools/mahjong_sounds.rb plays the app's notes
+and tunes with Family mruby's own APU emulator (components/apu_emu) and
+writes the files; sounds/sounds.json lists each file with its SHA-256 and
+what it was made from.
+
+1. The effects and jingles (sounds/*.wav)
+
+   discard, discard_other, draw, turn, round, yaku, points, riichi, pon,
+   chi, kan, ron, tsumo, kyuushu, ryuukyoku, fanfare1, fanfare2, fanfare3,
+   fanfare4
+
+   Written by Katsuhiko Kageyama, the author of Family mruby and of this
+   gem, as notes for the APU. In this gem they are under the MIT License,
+   the license of the gem (LICENSE), by the author's decision. In
+   fmruby-core they stay under that repository's license (GPL-3.0).
+
+   MIT License
+
+   Copyright (c) 2026 Katsuhiko Kageyama
+
+   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.
+
+2. The BGM (sounds/*.mp3): music by shiru8bit, CC BY 3.0
+
+   NOT under the MIT License. These three tunes are by shiru8bit and are
+   licensed under the Creative Commons Attribution 3.0 Unported license
+   (CC BY 3.0, https://creativecommons.org/licenses/by/3.0/), as the NSF
+   files Family mruby ships (fmruby-core, flash/usr/share/sounds/nsf/).
+
+     after_the_rain.mp3  "8-bit Chiptune - After The Rain" by shiru8bit
+                         https://opengameart.org/content/8-bit-chiptune-after-the-rain
+     spring_thing.mp3    "8-bit Chiptune - Spring Thing" by shiru8bit
+                         https://opengameart.org/content/8-bit-chiptune-spring-thing
+     encounter.mp3       "8-bit Chiptune - Encounter" by shiru8bit
+                         https://opengameart.org/node/100497
+
+   The music is not changed. Each file is the original NSF played by
+   Family mruby's APU emulator and saved as MP3: from the start of the tune
+   through one pass of its loop (and a second more); the page repeats the
+   loop as the NSF does. Whoever passes these files on, or plays them in a
+   stream or a recording, gives the same credit, for example
+   "BGM: shiru8bit (CC BY 3.0)" (the page shows it in its corner).

data/lib/asterism_games/commentate/assets/commentate.css

@@ -80,19 +80,24 @@ body.obs #captions { max-height: none; background: rgba(0, 0, 0, 0.55); }
 .cap.ai span { color: var(--ai); font-style: italic; }
 .cap.ai.old span { color: var(--dim); }
 #keys { padding: 0 12px 8px; color: var(--dim); font-size: 12px; }
-/* The voice's credit (VOICEVOX:<character>), in the corner, on a stream too. */
-#credit {
+/* The credits (VOICEVOX:<character>, the BGM's), in the corner, on a stream too. */
+#credits {
   position: fixed;
   right: 8px;
   bottom: 6px;
+  display: flex;
+  gap: 6px;
+  pointer-events: none;
+}
+#credits span {
   padding: 1px 6px;
   font-size: 12px;
   color: var(--dim);
   background: rgba(0, 0, 0, 0.45);
   border-radius: 3px;
-  pointer-events: none;
 }
-#credit[hidden] { display: none; }
+#credits span[hidden] { display: none; }
+#bar .btn { cursor: pointer; user-select: none; }
 @media (max-width: 600px) {
   #captions { font-size: 16px; }
   .cap.p3 span { font-size: 18px; }