summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLunar Journal <md.node.0@gmail.com>2024-01-30 14:46:57 +0200
committerGitHub <noreply@github.com>2024-01-30 14:46:57 +0200
commit2fa2dd65d3711666cf306817fe11f643913115fa (patch)
treec9a9a31f9c028b67f73c5edcffda0934ef3847e7
parentbf64932fb9b1207735f6568bc52a87b938cc7fd8 (diff)
downloademu8910-2fa2dd65d3711666cf306817fe11f643913115fa.tar.gz
emu8910-2fa2dd65d3711666cf306817fe11f643913115fa.zip
journal: update README.md
-rw-r--r--README.md21
1 files changed, 20 insertions, 1 deletions
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(<BUFFER>);