https://github.com/harshdoesdev/bottlecap
bottlecap - Lightweight JavaScript 2D Game Engine For Making Cross-Platform Hypercasual Games
https://github.com/harshdoesdev/bottlecap
2d-game-engine bottlecap collision-detection games javascript-game-engine
Last synced: 3 months ago
JSON representation
bottlecap - Lightweight JavaScript 2D Game Engine For Making Cross-Platform Hypercasual Games
- Host: GitHub
- URL: https://github.com/harshdoesdev/bottlecap
- Owner: harshdoesdev
- License: mit
- Created: 2020-11-27T15:58:10.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-13T21:56:03.000Z (over 1 year ago)
- Last Synced: 2025-03-03T19:47:19.048Z (3 months ago)
- Topics: 2d-game-engine, bottlecap, collision-detection, games, javascript-game-engine
- Language: JavaScript
- Homepage: https://bottlecap.js.org
- Size: 1.42 MB
- Stars: 18
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bottlecap.js - 2D Game Framework
## Table of Contents
- [About](#about)
- [Installation and Setup](#installation-and-setup)
- [NPM](#npm)
- [CDN](#cdn)
- [Docs](#docs)
- [Example](#example)
## About
**bottlecap.js** is a lightweight 2D game framework written in ES6. It offers a set of modular components, referred to as **bottlecaps**, that can be easily combined to create engaging 2D games.
## Installation and Setup
### NPM
```shell
npm create vite@latest my-bottlecap-game -- --template vanilla # vanilla-ts for TypeScript
cd my-bottlecap-game
npm i bottlecap
```
**src/main.js:**
```javascript
import * as Bottlecap from 'bottlecap';
// your code
```
### CDN
**src/main.js:**
```javascript
import * as Bottlecap from 'https://unpkg.com/bottlecap@latest';
// your code
```
## Docs
Explore the comprehensive documentation in the [wiki](https://github.com/harshsinghdev/bottlecap/wiki) to get started with **bottlecap.js**.
## Example
Check out the live [demo](https://harshdoesdev.github.io/bottlecap-demo/).
[Source code](https://github.com/harshdoesdev/bottlecap-demo/)
## Games made using bottlecap
- [Hydrogen](https://hypervoid.itch.io/hydrogen)
- [Play Or Die](https://hypervoid.itch.io/play-or-die)
- [Sneaky Tails](https://hypervoid.itch.io/sneaky-tails)
- [SlideToShoot](https://hypervoid.itch.io/slide-to-shoot)
Feel inspired by these creations? Start your own journey with **bottlecap.js** and join the growing community of game developers. Share your masterpiece and let the world experience your unique vision! If you have a game developed using **bottlecap.js** that you'd like to showcase, consider adding it to the list by opening a pull request. Happy gaming!