nerogm/nbase

A library powered by Heaps for making games.

NBase is a game framework/engine built on top of Heaps. Heaps is the engine behind cross-platform games like Dead Cells, Evoland, Northgard and Dune.

Introduction - Supported Platforms

Installation

You must have Haxe installed.

Install NBase:

haxelib install NBase

To make desktop apps get a release of HashLink. If you can't find Linux/Mac releases, check the latest release.

Put the release in a folder so that your project can find the executable. (See ".vscode/launch.json".)

Install hashlink dependencies:

haxelib install hlopenal
haxelib install hlsdl
haxelib install hldx

Quick start a project

To create a project folder quickly, in your projects folder, use:

haxelib run nbase [ProjectName]

Compilation

Compile your app using the corresponding haxe compile_X.hxml. For example, use haxe compile_js.hxml to build a javascript file, then launch "build/js/index.html".

Or you can run and debug directly from VS Code if your ".vscode/launch.json" is correctly configured.

Learn

API Documentation | NBase Wiki | Heaps Wiki

Follow & Support

Twitter | Patreon | Ko-fi

Community

nbase's Issues

Detecting logical processors

Needed for NFileSystem and threading in general.

ProjectAccess support

Introduce UI classes

Introduce debug classes

Shapes resizing

Can't be done quickly. Need to define setSize behavior

Setup Project

Collision detection

Currently partly done.
Refs: Collision.hx

Continuous Collision Detection

Complex shapes

Will need to add a class for shapes that are for example a combination of circles and polygons.
nb.shape.Shapes currently only works with polygons.

QuadTree

Physics API documentation

Introduce physics classes

Physics are meant for convex shapes.

TODO

• Shapes (#8)
• #12
• #14
• #15
• #13