https://github.com/marginalhours/browser-game-template
A ready-to-go game jam template using Kontra.js and GitHub actions
https://github.com/marginalhours/browser-game-template
Last synced: 4 months ago
JSON representation
A ready-to-go game jam template using Kontra.js and GitHub actions
- Host: GitHub
- URL: https://github.com/marginalhours/browser-game-template
- Owner: marginalhours
- License: mit
- Created: 2023-04-13T10:58:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-11T12:55:16.000Z (almost 3 years ago)
- Last Synced: 2025-01-01T08:15:07.731Z (over 1 year ago)
- Language: TypeScript
- Homepage: http://marginalhours.net/browser-game-template/
- Size: 538 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# browser-game-template
A ready-to-go game jam template using Kontra.js and GitHub actions
[KontraJS Examples](https://github.com/straker/kontra/tree/main/examples)
[KontraJS Docs](https://straker.github.io/kontra/api/animation)
[Link to running template](http://marginalhours.net/browser-game-template/)
## Assets
### Adding a sound (mp3)
See instructions in `assets/sounds/index.ts`
### Adding music (mp3)
See instructions in `assets/music/index.ts`
### Adding an image (png)
Add the `.png` file to the `assets/images/` folder, then `import` the path to it where you want to use it
and look it up in `imageAssets` (imported from `kontra`)
### Adding a scene
Add the `.ts` file somewhere in the folder hierarchy under `scenes/`. The file should export a kontra `Scene` object as the default export, with its `id` set to a unique new value from the `SceneID` enum in `scenes/constants.ts`
## Post-LD-53 todo list
- Transitions / timers (!!!)
- Particle effects
- Something something cards
- utility _scenes_ (ImageScene with a static image and a back button, MenuScene etc)
- Scene stack (???) to push/pop to instead of just transitioning (for eg battler with overworld)
- tileset usage
- Custom fonts
- stub entities (clickable, keyboard controlled)
- utility classes (hoverable button, progress dot)
- Keycap symbols (eg https://www.miragecraft.com/projects/keymason.html)
- work harder at figuring out the kontra factory-vs-class pattern to be a bit slicker
- camera shenanigans
- collision detection (?)
- localStorage example
- multiscreen instructions example
- JRPG dialogue example
- matterjs integration example
- achievements (woo)