srobertson421 / kaboom Goto Github PK

Kaboom.js is a JavaScript library that helps you make games fast and fun!

Check out our official website!

<script src="https://kaboomjs.com/lib/0.4.1/kaboom.js"></script>
<script type="module">

// initialize kaboom context
const k = kaboom();

// define a scene
k.scene("main", () => {

	// add a text at position (100, 100)
	k.add([
		k.text("ohhimark", 32),
		k.pos(100, 100),
	]);

});

// start the game
k.start("main");

</script>

You can paste this directly into an html file and start playing around!

We recommend downloading the script and use it directly, the source should be easy to read and modify (documentation is still in progress).

You can also use CDN

<script src="https://kaboomjs.com/lib/@version/kaboom.js"></script>

All available version tags can be found in CHANGELOG.md, or Github releases.

Special Version Tags:

• dev: current master with the newest unreleased features / fixes, but not guaranteed to be stable
• latest: latest release

The script will expose a window.kaboom function to initialize a kaboom context, returning an object containing

const k = kaboom();

k.init();
k.scene(...);
k.start(...);

You can also import all functions to global namespace by giving a global flag

kaboom({
	global: true,
});

init();
scene(...);
start(...);

However, it is possible to use a module version of kaboomjs.

<script type="module" src="script.js"></script>

script.js:

import kaboom from "https://kaboomjs.com/lib/0.4.1/kaboom.mjs";

const k = kaboom();

k.init();
k.scene(...);
k.start(...);

Using the module version means that there will be no window.kaboom available and kaboom must be imported.

Use examples to test / add features

1. npm run dev
2. go to http://localhost:8000/examples
3. edit examples in examples/

Featured on Console 50