https://github.com/remarkablegames/kaplay-template
🦖 KAPLAY game template
https://github.com/remarkablegames/kaplay-template
game javascript kaboom kaboom-js kaboomjs kaplay kaplayjs remarkablegames template typescript web website
Last synced: 8 months ago
JSON representation
🦖 KAPLAY game template
- Host: GitHub
- URL: https://github.com/remarkablegames/kaplay-template
- Owner: remarkablegames
- License: mit
- Created: 2024-01-14T21:48:35.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-29T16:32:29.000Z (about 1 year ago)
- Last Synced: 2025-04-29T17:38:46.900Z (about 1 year ago)
- Topics: game, javascript, kaboom, kaboom-js, kaboomjs, kaplay, kaplayjs, remarkablegames, template, typescript, web, website
- Language: TypeScript
- Homepage: http://remarkablegames.org/kaplay-template/
- Size: 911 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Kaplay Template
[](https://github.com/remarkablegames/kaplay-template/actions/workflows/build.yml)
kaplay-template is a template for making [KAPLAY](https://kaplayjs.com/) games.
Play the game on:
- [remarkablegames](https://remarkablegames.org/kaplay-template)
## Prerequisites
- [nvm](https://github.com/nvm-sh/nvm#readme)
## Install
Clone the repository:
```sh
git clone https://github.com/remarkablegames/kaplay-template.git
cd kaplay-template
```
Install the dependencies:
```sh
npm install
```
Update the environment variables:
```sh
cp .env .env.local
```
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the game in the development mode.
Open [http://localhost:5173](http://localhost:5173) to view it in the browser.
The page will reload if you make edits.
You will also see any errors in the console.
### `npm run build`
Builds the game for production to the `dist` folder.
It correctly bundles in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your game is ready to be deployed!
### `npm run bundle`
Builds the game and packages it into a Zip file in the `dist` folder.
Your game can be uploaded to your server, [Itch.io](https://itch.io/), [Newgrounds](https://www.newgrounds.com/), etc.
## License
[MIT](LICENSE)