open-optcg 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,26 @@
+MIT License
+
+Copyright (c) 2026 daavoo
+
+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.
+
+This license covers the engine, tooling, and site code in this repository.
+It does not cover One Piece Card Game trademarks, card text, or card artwork,
+which remain the property of their respective owners (Bandai / Eiichiro Oda
+/ Shueisha / Toei Animation). See README.md for how card art is handled.

package/README.md

@@ -1,3 +1,75 @@
-# Temporary Holding Version
+# open-optcg
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A deterministic rules engine for the One Piece Card Game, from the
+[Open OPTCG](https://github.com/daavoo/open-optcg) project. MIT licensed.
+
+The engine owns legality and transitions. Whenever a decision is due, it stops
+and offers the seat to act a list of legal actions, and the caller (a person, a
+bot or a model) picks one by its opaque `actionId`. Nothing advances on its own,
+so every game replays exactly from its seed and the actions taken.
+
+```sh
+npm install open-optcg
+```
+
+## Play a game
+
+```ts
+import { GameService } from "open-optcg/engine";
+import { resolveDeck, STARTER_DECK_IDS } from "open-optcg/decks";
+
+const [deck1, deck2] = STARTER_DECK_IDS;
+const service = new GameService();
+let view = service.create({
+  p1: resolveDeck(deck1),
+  p2: resolveDeck(deck2),
+  seed: "readme",
+});
+
+// `view` is what the seat to act may see: its own hand, both boards, and the
+// actions it may take. This loop always takes the first one.
+for (let step = 0; view.phase !== "finished" && step < 5000; step++) {
+  const action = view.legalActions[0]!;
+  view = service.act(view.gameId, view.revision, action.actionId);
+}
+console.log(`${view.winner} wins on turn ${view.turn} (${view.resultReason})`);
+```
+
+To play against the learned opponent, see
+[`open-optcg-model`](https://www.npmjs.com/package/open-optcg-model).
+
+## Entry points
+
+| Import                | What it is                                                                                                                                                                               |
+| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `open-optcg/engine`   | `GameService` (create, act, observe), and the functions under it for callers that hold the state themselves: `createGame`, `getLegalActions`, `applyAction`, `observe`, `replayActions`. |
+| `open-optcg/protocol` | The types the engine and a caller exchange: `GameObservation`, `LegalAction`, events, and the `Agent` contract any player implements.                                                    |
+| `open-optcg/cards`    | Card records by card number, with the rules derived from each card.                                                                                                                      |
+| `open-optcg/decks`    | The deck lists the project ships, and `parseDeckList` for the plain-text format deck builders export (`4x OP01-016` per line).                                                           |
+
+## Hidden information
+
+`observe(state, seat)`, and every view `GameService` returns, withholds what that
+seat cannot see: the opponent's hand, face-down Life and deck order. An online
+game keeps the state on the server and sends each player only their own view.
+
+## Card text and art
+
+The package carries no printed card text and no card art. Records hold each
+card's number, stats and derived rules. An app that shows card text loads a
+text pack at runtime with `loadPrintedText`, and brings its own art. See
+[asset packs](https://github.com/daavoo/open-optcg/blob/main/docs/asset-packs.md).
+
+## Versions
+
+While the version is `0.x`:
+
+- The `LegalAction` and `GameObservation` types change only in a minor version,
+  with a changelog entry.
+- An `actionId` is opaque and valid only for the view that offered it. Don't
+  parse it or store it across versions.
+- A replay records the engine's rules stamp, and `replayActions` refuses a
+  replay from an incompatible version instead of diverging silently.
+
+One Piece Card Game is a trademark of Bandai. This project is not affiliated
+with or endorsed by Bandai.

package/dist/cards.js

@@ -0,0 +1 @@
+import{cardFormatLegality,cardRegistry,createCardDatabase,isStandardLegal,loadPrintedText,parsePrintedTextPack,printedText,requireKnownCard}from"./chunks/chunk-4I54H2QI.js";export{cardFormatLegality,cardRegistry,createCardDatabase,isStandardLegal,loadPrintedText,parsePrintedTextPack,printedText,requireKnownCard};