gorlorn 1.0.0

package/README.md

@@ -0,0 +1,56 @@
+# gorlorn
+
+A browser-based arcade shooter game, packaged as a React component.
+
+## Install
+
+```bash
+npm install gorlorn
+```
+
+### Peer Dependencies
+
+- `react` ^18.0.0 || ^19.0.0
+
+## Usage
+
+```tsx
+import { GorlornGame } from "gorlorn";
+
+function App() {
+  return <GorlornGame />;
+}
+```
+
+### Props
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `assetBasePath` | `string` | `"/gorlorn"` | Base URL path where gorlorn image assets are served |
+
+The component renders an 800x600 canvas that automatically scales to fit its container while preserving aspect ratio.
+
+### Serving Assets
+
+Copy the `assets/` folder from this package to your public directory so they are served at the configured `assetBasePath`:
+
+```bash
+cp -r node_modules/gorlorn/assets public/gorlorn
+```
+
+## Controls
+
+- **Arrow keys** — move left/right
+- **Pointer/touch** — on-screen controls
+- **Escape** — pause/menu
+
+## Development
+
+```bash
+npm run dev    # watch mode
+npm run build  # production build
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,9 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+interface GorlornGameProps {
+    /** Base URL path where gorlorn image assets are served (default: "/gorlorn") */
+    assetBasePath?: string;
+}
+declare function GorlornGame({ assetBasePath }?: GorlornGameProps): react_jsx_runtime.JSX.Element;
+
+export { GorlornGame, type GorlornGameProps };

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+interface GorlornGameProps {
+    /** Base URL path where gorlorn image assets are served (default: "/gorlorn") */
+    assetBasePath?: string;
+}
+declare function GorlornGame({ assetBasePath }?: GorlornGameProps): react_jsx_runtime.JSX.Element;
+
+export { GorlornGame, type GorlornGameProps };