aura-3d v0.15.5
Aura3D
Aura3D is a general purpose TypeScript/WebGL game engine designed to facilitate the swift implementation of 3D browser games. It is the domain-specific 3D variant of Aura, providing a swathe of utility, from standard geometries to generally-useful shaders to common game object components and systems.
Built according to the Entity-Component-System architecture with applications broken up into distinct states, Aura3D aims to enable a compartmentalised development approach, supporting developments of varying complexity with focus on getting prototypes off the ground fast.
While functional, Aura3D is very much a work-in-progress, made purely for fun and self-education.
Documentation
(Under Construction) Aura Documentation
Getting Started
Quickstart
For getting up and running with Aura3D fast with recommended configurations and example applications, see the Aura3D template repository.
NPM
npm i --save aura-3d
It's recommended to write Aura3D applications in TypeScript and build with Webpack - though regular JS and other bundlers should work.
CDN
<script src="https://unpkg.com/aura-3d/_min/aura.3d.min.js"></script>The minified Aura3D provides the library Aura3D. For example:
<!DOCTYPE html>
<html>
<body>
<script src="https://unpkg.com/aura-3d/_min/aura.3d.min.js"></script>
<script>
const { Game, State, Vec2 } = Aura3D;
const game = new Game({ canvasDimensions: new Vec2(1024, 768) });
game.addState(new State({ name: 'example', init: () => console.log('Aura3D'), tick: () => {} }));
game.start('example');
</script>
</body>
</html>Note for Text Rendering
Currently, for text rendering, Aura3D will require a res/font.png situated next to the application entry script. This is a uniform, one-dimensional texture atlas of characters for sampling onto in-game text.
Aura configures a default charset matching the example font found in the Aura repository; for now, this should be copied into Aura projects (or an alternative atlas configured on the Game).
This is naturally subject to change with an upcoming overhaul to texture management and text rendering.