From 2fa2dd65d3711666cf306817fe11f643913115fa Mon Sep 17 00:00:00 2001 From: Lunar Journal Date: Tue, 30 Jan 2024 14:46:57 +0200 Subject: journal: update README.md --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a57205..0ee22e9 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,28 @@ To use simply create a PSG49 object as follows: ``` var emu8910 = new PSG49(YM_CLOCK_ZX, 50); ``` - Which sets the default clock speed and interrupt frequency. +This exposes a a PSG register file in the `emu8910.register` object: +``` +emu8910.register.A_FINE +emu8910.register.A_COARSE +emu8910.register.B_FINE +emu8910.register.B_COARSE +emu8910.register.C_FINE +emu8910.register.C_COARSE +emu8910.register.NOISE_PERIOD +emu8910.register.MIXER +emu8910.register.A_VOL +emu8910.register.B_VOL +emu8910.register.C_VOL +emu8910.register.ENV_FINE +emu8910.register.ENV_COARSE +emu8910.register.ENV_SHAPE +``` + +The register file is then used to control the PSG or extract state information. + To play a FYM module: ``` song = new FYMReader(); -- cgit v1.2.3-70-g09d2