@manybitsbyte/nesplayer-svelte 0.8.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2026] AgenticExpert.ai
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,185 @@
+# @manybitsbyte/nesplayer-svelte
+
+A self-contained NES emulator component for Svelte 5 / SvelteKit 2+ projects. Drop it in, pass a ROM, and play.
+
+## Install
+
+```sh
+npm install @manybitsbyte/nesplayer-svelte
+```
+
+## Basic usage
+
+```svelte
+<script>
+  import { Screen } from '@manybitsbyte/nesplayer-svelte';
+
+  let romBytes = $state(null);   // Uint8Array of a .nes file
+
+  async function loadRom() {
+    const res = await fetch('/roms/game.nes');
+    romBytes = new Uint8Array(await res.arrayBuffer());
+  }
+</script>
+
+<button onclick={loadRom}>Load ROM</button>
+
+<Screen rom={romBytes} romName="game" style="width: 512px; height: 480px;" />
+```
+
+The component fills its container. Set width/height on the element or a wrapping div. The canvas maintains the correct NES aspect ratio (8:7 pixel, ~1.167:1) and letter-boxes within the available space.
+
+## Props
+
+| Prop | Type | Default | Bindable | Description |
+|------|------|---------|----------|-------------|
+| `rom` | `Uint8Array \| undefined` | — | no | Raw bytes of a `.nes` ROM. Changing this value loads the new ROM. Leave unset to let the user open one via the built-in file picker. |
+| `romName` | `string \| undefined` | — | no | Identifier used as the localStorage key for SRAM and quick-save state. Should be unique per game. Falls back to the filename when using the file picker. |
+| `volume` | `number` | `1` | yes | Master volume, `0`–`1`. |
+| `muted` | `boolean` | `false` | yes | Mute audio without changing the volume value. |
+| `sampleRate` | `48000 \| 44100` | `48000` | yes | Audio output sample rate. |
+
+## Features
+
+### Controls overlay
+
+Hovering the right edge of the player reveals a vertical strip of controls. All buttons show a tooltip on hover.
+
+| Button | Action |
+|--------|--------|
+| Power | Toggle power on/off |
+| Play / Pause | Resume or pause emulation |
+| Reset | Soft reset (power stays on) |
+| Volume slider | Drag to adjust master volume |
+| Mute | Toggle mute |
+| Insert ROM | Open a `.nes` file from disk |
+| Controllers | Open the input-mapping panel |
+| Region | Cycle Auto → NTSC → PAL |
+| Fullscreen | Enter/exit browser fullscreen |
+
+### Input
+
+Player 1 defaults to keyboard. Player 2 defaults to none (unassigned). Both can be switched to any connected gamepad.
+
+**Default keyboard bindings (Player 1)**
+
+| Key | NES button |
+|-----|-----------|
+| Z | B |
+| X | A |
+| Right Shift | Select |
+| Enter | Start |
+| Arrow keys | D-Pad |
+| F5 | Quick Save |
+| F7 | Quick Load |
+
+All bindings are fully remappable per-player from the Controllers panel. Settings persist to `localStorage`.
+
+### Gamepad support
+
+- Connects any Gamepad API controller automatically when it is used in-game.
+- Supports two players simultaneously on separate controllers.
+- Each controller gets its own button mapping profile, persisted to `localStorage`.
+- Quick Save and Quick Load can each be bound to a gamepad button.
+- If a controller disconnects mid-game, emulation pauses and a dialog prompts the player to switch to keyboard or wait for reconnect.
+
+### Save states (quick save / load)
+
+Press **F5** to save the current emulator state to memory and to `localStorage`. Press **F7** to restore it. The saved state survives page reloads. A toast notification confirms each operation.
+
+The state is stored under the key `nesplayer-<romName>.state`, where `romName` is the value passed to the `romName` prop (or the filename when the user opens a ROM via the file picker). Use a consistent, URL-safe string as `romName` so saves persist across sessions reliably.
+
+### Battery save (SRAM)
+
+ROMs with battery-backed RAM (e.g. Zelda, Metroid) automatically save SRAM to `localStorage` on page unload and restore it when the same ROM is loaded again. Keys used:
+
+| Key | Contents |
+|-----|----------|
+| `nesplayer-<romName>.sram` | Battery-backed RAM (iNES mapper SRAM) |
+| `nesplayer-<romName>.flash` | Mapper 30 flash storage |
+| `nesplayer-<romName>.state` | Quick-save state snapshot |
+
+### Supported mappers
+
+| Mapper | Common boards / games |
+|--------|-----------------------|
+| NROM (0) | Super Mario Bros., Donkey Kong, most early titles |
+| MMC1 (1) | Mega Man 2, Zelda, Metroid, Castlevania II |
+| MMC3 (4) | Super Mario Bros. 3, Mega Man 3–6, Kirby's Adventure |
+| AXROM / ANROM (7) | Battletoads, Rare titles ⚠️ |
+| Mapper 30 | UNROM 512 — homebrew and modern NES releases |
+
+ROMs using other mappers will not load correctly. Famicom-specific features (expansion audio, Famicom Disk System, four-player adapters) are not currently supported.
+
+> ⚠️ **Battletoads** and **Wizards & Warriors** are currently affected by a sprite-zero hit detection bug. Battletoads hangs on the title screen before the first level; Wizards & Warriors exhibits screen flickering. Both use Mapper 7 and share the same underlying PPU timing issue, which is under active investigation.
+
+### Region
+
+The Region button cycles **Auto → NTSC → PAL**.
+
+- **Auto** reads the region field from the ROM header. iNES 2.0 ROMs include this field and will be detected correctly. iNES 1.0 ROMs do not include a region field, so Auto will default to NTSC — PAL games distributed as iNES 1.0 need to be set manually.
+- **NTSC** and **PAL** force the region regardless of what the header says.
+
+---
+
+## Server requirements
+
+### Audio
+
+Audio uses the Web Audio API with `SharedArrayBuffer` for a lock-free ring buffer between the emulator and the audio worklet. `SharedArrayBuffer` requires cross-origin isolation headers on every page that embeds the player:
+
+```
+Cross-Origin-Opener-Policy: same-origin
+Cross-Origin-Embedder-Policy: require-corp
+```
+
+Without these headers the component still works — the screen renders and input is accepted — but audio is silently disabled and a warning is logged to the console.
+
+**SvelteKit / Vite dev server** — add to `vite.config.ts`:
+
+```ts
+server: {
+  headers: {
+    'Cross-Origin-Opener-Policy':   'same-origin',
+    'Cross-Origin-Embedder-Policy': 'require-corp',
+  },
+},
+```
+
+**Netlify** — add to `netlify.toml`:
+
+```toml
+[[headers]]
+  for = "/*"
+  [headers.values]
+    Cross-Origin-Opener-Policy   = "same-origin"
+    Cross-Origin-Embedder-Policy = "require-corp"
+```
+
+**Vercel** — add to `vercel.json`:
+
+```json
+{
+  "headers": [
+    {
+      "source": "/(.*)",
+      "headers": [
+        { "key": "Cross-Origin-Opener-Policy",   "value": "same-origin" },
+        { "key": "Cross-Origin-Embedder-Policy", "value": "require-corp" }
+      ]
+    }
+  ]
+}
+```
+
+> **Note:** These headers restrict how your page can interact with cross-origin resources (iframes, popups, etc.). If your site relies on OAuth redirects, embedded third-party iframes, or similar cross-origin communication, audit the impact before enabling them.
+
+### WebGL
+
+The screen is rendered with WebGL (WebGL 1). Any browser that supports Svelte 5 supports WebGL, so no additional configuration is needed.
+
+---
+
+## Browser support
+
+Requires Chrome 85+, Firefox 79+, or Safari 15+. These are the minimum versions supported by the underlying WASM runtime.