@thenick775/mgba-wasm 1.0.9 → 1.0.11

package/README.md

@@ -0,0 +1,43 @@
+# mGBA-wasm
+
+This package is a bundled version of my [mGBA fork](https://github.com/thenick775/mgba/tree/feature/wasm) compiled to webassembly.
+
+This core currently powers [gbajs3](https://gba.nicholas-vancise.dev)!
+
+To instantiate the emulator using react:
+
+```
+import mGBA, { type mGBAEmulator } from '@thenick775/mgba-wasm';
+import { useEffect, useState } from 'react';
+
+export const useEmulator = (canvas: HTMLCanvasElement | null) => {
+  const [emulator, setEmulator] = useState<mGBAEmulator | null>(null);
+
+  useEffect(() => {
+    const initialize = async () => {
+      if (canvas) {
+        const Module = await mGBA({ canvas });
+
+        const mGBAVersion =
+          Module.version.projectName + ' ' + Module.version.projectVersion;
+        console.log(mGBAVersion);
+
+        await Module.FSInit();
+
+        setEmulator(Module);
+      }
+    };
+
+    initialize();
+  }, [canvas]);
+
+  return emulator;
+};
+
+```
+
+See the feature/wasm [README](https://github.com/thenick775/mgba/tree/feature/wasm#readme) for further details such as:
+
+- available emulator interface methods
+- building from source
+- embedding and usage in vanilla javascript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thenick775/mgba-wasm",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "mGBA emulator compiled to webassembly",
   "main": "./dist/mgba.js",
   "types": "./dist/mgba.d.ts",
@@ -30,5 +30,5 @@
   "bugs": {
     "url": "https://github.com/thenick775/mgba/issues"
   },
-  "homepage": "https://github.com/thenick775/mgba#readme"
+  "homepage": "https://github.com/thenick775/mgba/tree/feature/wasm#readme"
 }