https://github.com/jacklehamster/dok-gamelib

Dok game library.
https://github.com/jacklehamster/dok-gamelib

dobuki dok-game-library dok-gamelib game game-development game-engine indiedev javascript webgl

Last synced: about 2 months ago
JSON representation

Dok game library.

• Host: GitHub
• URL: https://github.com/jacklehamster/dok-gamelib
• Owner: jacklehamster
• License: mit
• Created: 2020-01-31T17:39:21.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-12-26T00:06:55.000Z (about 3 years ago)
• Last Synced: 2023-08-02T20:57:20.197Z (over 1 year ago)
• Topics: dobuki, dok-game-library, dok-gamelib, game, game-development, game-engine, indiedev, javascript, webgl
• Language: JavaScript
• Homepage: https://jacklehamster.github.io/dok-gamelib/
• Size: 151 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# dok-gamelib

[![npm version](https://badge.fury.io/js/dok-gamelib.svg)](https://badge.fury.io/js/dok-gamelib)

Dok game library.

![Create Release](https://github.com/jacklehamster/dok-gamelib/workflows/Create%20Release/badge.svg)

![gh-pages](https://github.com/jacklehamster/dok-gamelib/workflows/github%20pages/badge.svg)

To build a game, add files to game folder:

- config.json

Set basic information such as:

	- title

	- description

- assets

Add images to assets folder. Those will be combined into a single spritesheet.

- scenes

Add js files to the scenes folder.

```

SceneManager.add(Class, config);

Class: Pass a javascript class as the first parameter, extending the Game class. That class will be instantiated as new Class().

config: The config will get processed and assigned to the class. For the schema of config, see schema.json

``` 

Documentation in progress. Meanwhile, check out the sample projects:

https://jacklehamster.github.io/dok-gamelib

- For each scene, you can see the code by clicking EDITOR

- The code shown is all the code needed to produce a scene (excluding the code for the engine itself).

## Scene file structure

```

game

├── game.json

│   scenes

│   ├── 

│   |   ├── start.js

│   │   ├── assets

│   |   │   ├── *.png

│   |   │   ├── *.jpg

```

## Deploy

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/jacklehamster/dok-gamelib)

Game produced: https://jacklehamster.github.io/dok-gamelib/archive/game.zip