Guides

Attention

Documentation guides are in an unfinished, work-in-progress state. Some sections are complete, others outdated, and others missing. Documentation is being actively written and should be finished soon.

There are specific guides for each feature

Installing shows how to install the development files

Getting started is a guide for new users of Tilengine. It takes you through the most basic features.

Engine setup

• Initialization - basic engine setup and error handling
• Using the window - using the built-in window
• External rendering - integrating inside a host environment

Rendering features

• Background layers - using background layers
• Sprites - working with moving objects
• Animations - animating layers, sprites and colors
• Blending - compositing transparency, light and shadow effects
• Raster effects - create advanced FX
• World - assisted parallax scroll and object position in world space

Working with assets

• Tilemaps - managing background layout
• Tilesets - managing background graphic pieces
• Spritesets - managing sprite graphics
• Palettes - managing color
• Sequences - managing sequences for animation engine
• Bitmaps - using bitmaps

The performance tips gives some tips for maximizing performance

The reference documentation provides more detailed information about specific functions.