gorlorn 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -15
- package/dist/index.d.mts +1 -3
- package/dist/index.d.ts +1 -3
- package/dist/index.js +35 -18
- package/dist/index.mjs +35 -18
- package/package.json +14 -8
- package/assets/bullet.png +0 -0
- package/assets/bullet_combo.png +0 -0
- package/assets/button_about.png +0 -0
- package/assets/button_play.png +0 -0
- package/assets/button_quit.png +0 -0
- package/assets/button_statistics.png +0 -0
- package/assets/death_text.png +0 -0
- package/assets/enemy.png +0 -0
- package/assets/heart.png +0 -0
- package/assets/hero.png +0 -0
- package/assets/left_button.png +0 -0
- package/assets/right_button.png +0 -0
- package/assets/space.png +0 -0
- package/assets/title.png +0 -0
package/README.md
CHANGED
|
@@ -1,7 +1,12 @@
|
|
|
1
1
|
# gorlorn
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/gorlorn)
|
|
4
|
+
|
|
3
5
|
A browser-based arcade shooter game, packaged as a React component.
|
|
4
6
|
|
|
7
|
+
- **npm**: https://www.npmjs.com/package/gorlorn
|
|
8
|
+
- **GitHub**: https://github.com/robgwalsh/gorlorn
|
|
9
|
+
|
|
5
10
|
## Install
|
|
6
11
|
|
|
7
12
|
```bash
|
|
@@ -22,21 +27,7 @@ function App() {
|
|
|
22
27
|
}
|
|
23
28
|
```
|
|
24
29
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
| Prop | Type | Default | Description |
|
|
28
|
-
|------|------|---------|-------------|
|
|
29
|
-
| `assetBasePath` | `string` | `"/gorlorn"` | Base URL path where gorlorn image assets are served |
|
|
30
|
-
|
|
31
|
-
The component renders an 800x600 canvas that automatically scales to fit its container while preserving aspect ratio.
|
|
32
|
-
|
|
33
|
-
### Serving Assets
|
|
34
|
-
|
|
35
|
-
Copy the `assets/` folder from this package to your public directory so they are served at the configured `assetBasePath`:
|
|
36
|
-
|
|
37
|
-
```bash
|
|
38
|
-
cp -r node_modules/gorlorn/assets public/gorlorn
|
|
39
|
-
```
|
|
30
|
+
All image assets are bundled inline — no extra setup or file copying required. The component renders an 800x600 canvas that automatically scales to fit its container while preserving aspect ratio.
|
|
40
31
|
|
|
41
32
|
## Controls
|
|
42
33
|
|
package/dist/index.d.mts
CHANGED
|
@@ -1,9 +1,7 @@
|
|
|
1
1
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
2
2
|
|
|
3
3
|
interface GorlornGameProps {
|
|
4
|
-
/** Base URL path where gorlorn image assets are served (default: "/gorlorn") */
|
|
5
|
-
assetBasePath?: string;
|
|
6
4
|
}
|
|
7
|
-
declare function GorlornGame({
|
|
5
|
+
declare function GorlornGame({}?: GorlornGameProps): react_jsx_runtime.JSX.Element;
|
|
8
6
|
|
|
9
7
|
export { GorlornGame, type GorlornGameProps };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,7 @@
|
|
|
1
1
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
2
2
|
|
|
3
3
|
interface GorlornGameProps {
|
|
4
|
-
/** Base URL path where gorlorn image assets are served (default: "/gorlorn") */
|
|
5
|
-
assetBasePath?: string;
|
|
6
4
|
}
|
|
7
|
-
declare function GorlornGame({
|
|
5
|
+
declare function GorlornGame({}?: GorlornGameProps): react_jsx_runtime.JSX.Element;
|
|
8
6
|
|
|
9
7
|
export { GorlornGame, type GorlornGameProps };
|