Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 1.84 KB

README.md

File metadata and controls

64 lines (41 loc) · 1.84 KB
Raw

bottlecap.js - 2D Game Framework

bottlecap.js

Table of Contents

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

npm create vite@latest my-bottlecap-game -- --template vanilla # vanilla-ts for TypeScript
cd my-bottlecap-game
npm i bottlecap

src/main.js:

import * as Bottlecap from 'bottlecap';

// your code

CDN

src/main.js:

import * as Bottlecap from 'https://unpkg.com/bottlecap@latest';

// your code

Docs

Explore the comprehensive documentation in the wiki to get started with bottlecap.js.

Example

Check out the live demo.

Source code

Demo

Games made using bottlecap

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!