koishipro-core.js 1.0.2

package/.eslintignore

@@ -0,0 +1,6 @@
+webpack.config.js
+dist/*
+build/*
+*.js
+
+/src/vendor

package/.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir : __dirname, 
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Nanahira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,108 @@
+# koishipro-core.js
+
+WASM wrapper for YGOPro/ocgcore, designed for both Node and browser runtimes.  
+Provides a clean TypeScript API around the Emscripten module, replay playback, and
+helpers for loading scripts/cards.
+
+## Features
+- Load ocgcore WASM (CJS or ESM) and create duels
+- TypeScript-friendly wrapper around duel APIs
+- Script readers (Map/Zip) for loading Lua scripts
+- SQL.js card reader helper
+- Replay (YRP/YRP2) playback to raw message streams
+- Constants auto-generated from upstream YGOPro sources
+
+## Install
+```bash
+npm install koishipro-core.js
+```
+
+## Quick Start
+```ts
+import { createOcgcoreWrapper, ZipReader, createSqljsCardReader } from 'koishipro-core.js';
+import initSqlJs from 'sql.js';
+
+const wrapper = await createOcgcoreWrapper();
+
+// Provide scripts via zip
+const zipBytes = await fetch('/script.zip').then((r) => r.arrayBuffer());
+wrapper.setScriptReader(await ZipReader(new Uint8Array(zipBytes)));
+
+// Provide cards via sql.js
+const SQL = await initSqlJs();
+const db = new SQL.Database(await fetch('/cards.cdb').then((r) => r.arrayBuffer()));
+wrapper.setCardReader(createSqljsCardReader(db));
+
+// Optional: log messages from ocgcore
+wrapper.setMessageHandler((_duel, message, type) => {
+  console.log(type, message);
+});
+
+const duel = wrapper.createDuel(1234);
+duel.setPlayerInfo({ playerId: 0, lp: 8000, startCount: 5, drawCount: 1 });
+duel.setPlayerInfo({ playerId: 1, lp: 8000, startCount: 5, drawCount: 1 });
+duel.startDuel(0);
+
+const { raw, status } = duel.process();
+console.log(raw, status);
+
+duel.endDuel();
+wrapper.finalize();
+```
+
+## Replay Playback
+`playYrp` replays a `.yrp/.yrp2` file by feeding responses back to ocgcore and
+collecting each engine message as `Uint8Array`. You can pass a parsed `YGOProYrp`
+instance or raw bytes.
+
+```ts
+import { createOcgcoreWrapper, playYrp } from 'koishipro-core.js';
+import { YGOProYrp } from 'ygopro-yrp-encode';
+
+const wrapper = await createOcgcoreWrapper();
+
+// ...setScriptReader / setCardReader / setMessageHandler...
+
+const yrpBytes = await fetch('/replay.yrp').then((r) => r.arrayBuffer());
+const messages = playYrp(wrapper, new Uint8Array(yrpBytes));
+console.log('message count:', messages.length);
+```
+
+
+## API Overview
+### Core
+- `createOcgcoreWrapper(options?)`  
+  Load the ocgcore WASM module and return an `OcgcoreWrapper`.
+- `OcgcoreWrapper`  
+  Manages the WASM module, script/card/message handlers, and duel creation.
+- `OcgcoreDuel`  
+  Duel lifecycle and core engine calls (`startDuel`, `process`, `setResponse`, etc.).
+
+### Script Readers
+- `MapReader(map)`  
+  Resolve Lua scripts from a `Map<string, string | Uint8Array>`.
+- `ZipReader(zipBytes)`  
+  Load all `.lua` files from a zip and expose them via `MapReader`.
+
+### Replay
+- `playYrp(wrapper, yrpOrBytes)`  
+  Run a replay and return a list of raw message `Uint8Array`s.  
+  Accepts `YGOProYrp` or raw `.yrp/.yrp2` bytes.  
+  Throws `Got MSG_RETRY` if a retry is encountered.
+
+### Card Reader
+- `createSqljsCardReader(...dbs)`  
+  Build a `CardReader` from one or more SQL.js databases.
+
+### Constants
+- `OcgcoreCommonConstants`, `OcgcoreScriptConstants`  
+  Pre-generated constants from upstream sources.
+
+## Build / Scripts
+- `npm run build` – build CJS + ESM + types
+- `npm run fetch-ocgcore` – download vendor WASM and JS
+- `npm run gen-constants` – regenerate constants from upstream sources
+
+## Notes
+- This package ships both CJS and ESM builds.
+- WASM binaries are bundled under `dist/vendor`.