@tmustier/pi-nes 0.2.40 → 0.2.41
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +62 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,6 +15,22 @@ Or from git:
|
|
|
15
15
|
pi install git:github.com/tmustier/pi-nes
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
+
## Updating
|
|
19
|
+
|
|
20
|
+
If you installed from npm:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
pi update npm:@tmustier/pi-nes
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Then fully restart `pi`.
|
|
27
|
+
|
|
28
|
+
### Updating from older versions
|
|
29
|
+
|
|
30
|
+
- No config migration is required.
|
|
31
|
+
- On Kitty-compatible terminals (Ghostty, Kitty, WezTerm), image mode now opens in pi's main custom UI instead of an overlay.
|
|
32
|
+
- Text mode still uses the classic overlay experience.
|
|
33
|
+
|
|
18
34
|
## Quick Start
|
|
19
35
|
|
|
20
36
|
```bash
|
|
@@ -110,6 +126,33 @@ Saves are flushed on quit and periodically during play.
|
|
|
110
126
|
|
|
111
127
|
Set `"renderer": "text"` if you prefer the ANSI renderer or want the classic overlay experience.
|
|
112
128
|
|
|
129
|
+
## Audio after npm install or update
|
|
130
|
+
|
|
131
|
+
The published package works without audio by default. To enable audio, rebuild the native core with the `audio-cpal` feature.
|
|
132
|
+
|
|
133
|
+
First, find the installed `@tmustier/pi-nes` path:
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
pi list
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Then `cd` into the printed install path plus `extensions/nes/native/nes-core`, and rebuild:
|
|
140
|
+
|
|
141
|
+
```bash
|
|
142
|
+
npm install
|
|
143
|
+
npm run build:audio
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
For a standard global npm install, that path is typically:
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
cd "$(npm root -g)/@tmustier/pi-nes/extensions/nes/native/nes-core"
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
Then enable audio in `/nes-config`.
|
|
153
|
+
|
|
154
|
+
If you update `@tmustier/pi-nes` later, run `build:audio` again because the native binary may be replaced during the update.
|
|
155
|
+
|
|
113
156
|
## Limitations
|
|
114
157
|
|
|
115
158
|
- **Audio is opt-in** — Requires building the native core with `audio-cpal` and setting `enableAudio: true`
|
|
@@ -148,3 +191,22 @@ Run locally:
|
|
|
148
191
|
```bash
|
|
149
192
|
pi --extension /path/to/pi-nes
|
|
150
193
|
```
|
|
194
|
+
|
|
195
|
+
## Troubleshooting
|
|
196
|
+
|
|
197
|
+
### `/nes` or `/nes-config` shows up twice
|
|
198
|
+
|
|
199
|
+
You likely have both an npm install and a local/path install enabled.
|
|
200
|
+
|
|
201
|
+
Check installed packages:
|
|
202
|
+
|
|
203
|
+
```bash
|
|
204
|
+
pi list
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
Then remove the extra one:
|
|
208
|
+
|
|
209
|
+
```bash
|
|
210
|
+
pi remove <source> # for entries under "User packages"
|
|
211
|
+
pi remove -l <source> # for entries under "Project packages"
|
|
212
|
+
```
|