How gurkenlabs/litiengine works
LITIENGINE is a Java 2D game engine, accompanied by utiLITI, a dedicated map editor. The main game-development workflow is to initialize a game, load resources and tile maps, populate an environment with entities, then run gameplay with rendering, input, physics, and audio. The README documents these capabilities, while sampled code confirms selected links among the runtime components. Editor internals and several engine subsystems are represented from the tree and README; their unsampled interactions are not asserted as verified calls.
Main entry points: IEntity.java Entity framework · Game.java Game lifecycle · Environment.java Environment · Editor.java Editor workflow
Components 20
Game runtime
- Game lifecycle
litiengine/src/main/java/de/gurkenlabs/litiengine/Game.java - Configuration
litiengine/src/main/java/de/gurkenlabs/litiengine/configuration/Configuration.java - Resource loading
litiengine/src/main/java/de/gurkenlabs/litiengine/resources/Resources.java - Scripting
litiengine/src/main/java/de/gurkenlabs/litiengine/scripting/JavaLanguageService.java
World and entities
- Game world
litiengine/src/main/java/de/gurkenlabs/litiengine/environment/GameWorld.java - Environment
litiengine/src/main/java/de/gurkenlabs/litiengine/environment/Environment.java - TMX tile maps
litiengine/src/main/java/de/gurkenlabs/litiengine/environment/tilemap/IMap.java - Map objects
litiengine/src/main/java/de/gurkenlabs/litiengine/environment/tilemap/IMapObject.java - Entity framework
litiengine/src/main/java/de/gurkenlabs/litiengine/entities/IEntity.java - Abilities
litiengine/src/main/java/de/gurkenlabs/litiengine/abilities/Ability.java - Physics and collisions
litiengine/src/main/java/de/gurkenlabs/litiengine/physics/PhysicsEngine.java
Presentation and input
- 2D rendering
litiengine/src/main/java/de/gurkenlabs/litiengine/graphics/RenderEngine.java - Sprite animation
litiengine/src/main/java/de/gurkenlabs/litiengine/graphics/animation/AnimationController.java - Player input
litiengine/src/main/java/de/gurkenlabs/litiengine/input/KeyboardEntityController.java - Sound engine
litiengine/src/main/java/de/gurkenlabs/litiengine/sound/SoundEngine.java
utiLITI editor
- Editor application
utiliti/src/main/java/de/gurkenlabs/utiliti/Program.java - Editor workflow
utiliti/src/main/java/de/gurkenlabs/utiliti/controller/Editor.java - Undo manager
utiliti/src/main/java/de/gurkenlabs/utiliti/controller/UndoManager.java - Script bindings
utiliti/src/main/java/de/gurkenlabs/utiliti/controller/ScriptBindingService.java
Other components
- Game developer
Connections 21
- Game developer → Game lifecycle: builds with
- Game lifecycle → Game world: owns
litiengine/src/main/java/de/gurkenlabs/litiengine/Game.java - Game lifecycle → Scripting: exposes
litiengine/src/main/java/de/gurkenlabs/litiengine/Game.java - Game lifecycle → Configuration: provides
- Game lifecycle → Resource loading: loads
litiengine/src/main/java/de/gurkenlabs/litiengine/Game.java - Game world → Environment: selects
- Environment → TMX tile maps: loads map data
litiengine/src/main/java/de/gurkenlabs/litiengine/environment/Environment.java - Environment → Map objects: builds entities
litiengine/src/main/java/de/gurkenlabs/litiengine/environment/Environment.java - Environment → Entity framework: stores
litiengine/src/main/java/de/gurkenlabs/litiengine/environment/Environment.java - Entity framework → Abilities: uses
- Entity framework → Physics and collisions: collides through
- Entity framework → Player input: receives controls
- Game world → 2D rendering: provides render context
litiengine/src/main/java/de/gurkenlabs/litiengine/graphics/RenderEngine.java - 2D rendering → Entity framework: renders
litiengine/src/main/java/de/gurkenlabs/litiengine/graphics/RenderEngine.java - Entity framework → Sprite animation: animates with
- Sound engine → Resource loading: loads sounds
litiengine/src/main/java/de/gurkenlabs/litiengine/sound/SoundEngine.java - Editor application → Editor workflow: starts
utiliti/src/main/java/de/gurkenlabs/utiliti/Program.java - Editor workflow → Undo manager: supports undo
utiliti/src/main/java/de/gurkenlabs/utiliti/controller/UndoManager.java - Editor workflow → Script bindings: manages bindings
utiliti/src/main/java/de/gurkenlabs/utiliti/controller/ScriptBindingService.java - Script bindings → Entity framework: updates scripts
utiliti/src/main/java/de/gurkenlabs/utiliti/controller/ScriptBindingService.java - Editor workflow → TMX tile maps: edits map data