API DOCS ARE OUTDATED

Hope I'll have a week of free time (or even two) to make them actual...

Overview

This library is a framework and set of tools for working with infinite game fields, loading infinite maps for one game level, creating an infinite count of game objects and active game players and NPCs - as much as possible.

The framework is fully compatible with Flame and does not contain any strict requirements for the game structure. Even existing games could be migrated to this framework if necessary.

This is still in beta. API and whole architecture might be changed at any time, including breaking changes.

Features

There are a lot of utility functions and the list of its features is too long to describe at a fast glance. So here is a list of only top-level features:

• Building endless game levels without the need to change the screen for rendering another map. System gives you the ability to create big open worlds with seamless loading of new maps while a player approaches to them.
• Build game levels with a destructible environment. Every Tiled tile could be converted into separate game component and handle interactions with other game elements individually
• Building procedural-generated pieces of a map (or whole maps) on the fly, as the player approaches to them.
• Wise resource management: the system does not eat resources greedily, it takes care of proper allocation and de-allocation so you can enjoy your game even in a browser or weak mobile phone.
• New visual effects: lean resource management system allows to create trails for many players and persists during a long game session, blending with other game elements like ground.

Some of possible features might still be undiscovered :-)

Core concepts

The core of the framework is a spatial grid that is building on-the-fly and controls component's visibility and activity, loads and unloads maps by chunks. It allows optimizing rendering by pre-rendering statical components into images, but keeps images size small enough and unloads unused chunks from memory.

Usage: minimal setup

1. Add HasSpatialGridFramework mixin into you game
2. Add HasGridSupport mixin to every game component
3. Call initializeSpatialGrid at your game's onLoad function before adding any component into game.
4. Enjoy!

See detailed "minimal start" tutorial at Getting Started section.

See game.dart for working code example Check out working demo at https://asgalex.github.io/flame_spatial_grid/

Future usage instructions

0. Getting Started Guide, if you still did not read it
1. Working with Tiled maps
2. Working with Tiled worlds
3. Optimizing static objects rendering and collisions using CellLayers
4. Interacting with Flame's Cameras
5. [TODO] Creating trails and other temporary marks on the ground.

Advanced section

1. [TODO] How custom collision detection system works
2. [TODO] How CellLayers optimizes collision detection.