# gurkenlabs/litiengine architecture

> Architecture diagram of the GitHub repository gurkenlabs/litiengine, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gurkenlabs/litiengine
- Repository: https://github.com/gurkenlabs/litiengine

## Overview

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: [`litiengine/src/main/java/de/gurkenlabs/litiengine/entities/IEntity.java`](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/entities/IEntity.java) (Entity framework), [`litiengine/src/main/java/de/gurkenlabs/litiengine/Game.java`](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/Game.java) (Game lifecycle), [`litiengine/src/main/java/de/gurkenlabs/litiengine/environment/Environment.java`](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/environment/Environment.java) (Environment), [`utiliti/src/main/java/de/gurkenlabs/utiliti/controller/Editor.java`](https://github.com/gurkenlabs/litiengine/blob/main/utiliti/src/main/java/de/gurkenlabs/utiliti/controller/Editor.java) (Editor workflow)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Game runtime"]
  node_game["Game lifecycle<br/>[Game.java]"]
  node_configuration["Configuration<br/>[Configuration.java]"]
  node_resources["Resource loading<br/>[Resources.java]"]
  node_scripting["Scripting"]
end

subgraph group_world["World and entities"]
  node_worldstate["Game world<br/>[GameWorld.java]"]
  node_environment["Environment<br/>[Environment.java]"]
  node_tilemaps["TMX tile maps<br/>[IMap.java]"]
  node_mapobjects["Map objects<br/>[IMapObject.java]"]
  node_entities["Entity framework<br/>[IEntity.java]"]
  node_abilities["Abilities<br/>[Ability.java]"]
  node_physics["Physics and collisions<br/>[PhysicsEngine.java]"]
end

subgraph group_presentation["Presentation and input"]
  node_rendering["2D rendering<br/>[RenderEngine.java]"]
  node_animation["Sprite animation"]
  node_input["Player input"]
  node_sound["Sound engine<br/>[SoundEngine.java]"]
end

subgraph group_editor["utiLITI editor"]
  node_editorapp["Editor application<br/>[Program.java]"]
  node_editor["Editor workflow<br/>[Editor.java]"]
  node_undo["Undo manager<br/>[UndoManager.java]"]
  node_editorbinding["Script bindings"]
end

node_developer(("Game developer"))

node_developer -.->|"builds with"| node_game
node_game -->|"owns"| node_worldstate
node_game -->|"exposes"| node_scripting
node_game -.->|"provides"| node_configuration
node_game -.->|"loads"| node_resources
node_worldstate -.->|"selects"| node_environment
node_environment -.->|"loads map data"| node_tilemaps
node_environment -.->|"builds entities"| node_mapobjects
node_environment -.->|"stores"| node_entities
node_entities -.->|"uses"| node_abilities
node_entities -.->|"collides through"| node_physics
node_entities -.->|"receives controls"| node_input
node_worldstate -->|"provides render context"| node_rendering
node_rendering -->|"renders"| node_entities
node_entities -.->|"animates with"| node_animation
node_sound -->|"loads sounds"| node_resources
node_editorapp -.->|"starts"| node_editor
node_editor -.->|"supports undo"| node_undo
node_editor -.->|"manages bindings"| node_editorbinding
node_editorbinding -->|"updates scripts"| node_entities
node_editor -.->|"edits map data"| node_tilemaps

click node_game "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/Game.java"
click node_configuration "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/configuration/Configuration.java"
click node_resources "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/resources/Resources.java"
click node_scripting "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/scripting/JavaLanguageService.java"
click node_worldstate "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/environment/GameWorld.java"
click node_environment "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/environment/Environment.java"
click node_tilemaps "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/environment/tilemap/IMap.java"
click node_mapobjects "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/environment/tilemap/IMapObject.java"
click node_entities "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/entities/IEntity.java"
click node_abilities "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/abilities/Ability.java"
click node_physics "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/physics/PhysicsEngine.java"
click node_rendering "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/graphics/RenderEngine.java"
click node_animation "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/graphics/animation/AnimationController.java"
click node_input "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/input/KeyboardEntityController.java"
click node_sound "https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/sound/SoundEngine.java"
click node_editorapp "https://github.com/gurkenlabs/litiengine/blob/main/utiliti/src/main/java/de/gurkenlabs/utiliti/Program.java"
click node_editor "https://github.com/gurkenlabs/litiengine/blob/main/utiliti/src/main/java/de/gurkenlabs/utiliti/controller/Editor.java"
click node_undo "https://github.com/gurkenlabs/litiengine/blob/main/utiliti/src/main/java/de/gurkenlabs/utiliti/controller/UndoManager.java"
click node_editorbinding "https://github.com/gurkenlabs/litiengine/blob/main/utiliti/src/main/java/de/gurkenlabs/utiliti/controller/ScriptBindingService.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_game,node_configuration,node_resources,node_scripting toneBlue
class node_worldstate,node_environment,node_tilemaps,node_mapobjects,node_entities,node_abilities,node_physics toneAmber
class node_rendering,node_animation,node_input,node_sound toneMint
class node_editorapp,node_editor,node_undo,node_editorbinding toneRose
class node_developer toneIndigo
```

## Components

### Game runtime

- [Game lifecycle](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/Game.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/Game.java`
- [Configuration](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/configuration/Configuration.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/configuration/Configuration.java`
- [Resource loading](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/resources/Resources.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/resources/Resources.java`
- [Scripting](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/scripting/JavaLanguageService.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/scripting/JavaLanguageService.java`

### World and entities

- [Game world](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/environment/GameWorld.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/environment/GameWorld.java`
- [Environment](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/environment/Environment.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/environment/Environment.java`
- [TMX tile maps](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/environment/tilemap/IMap.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/environment/tilemap/IMap.java`
- [Map objects](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/environment/tilemap/IMapObject.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/environment/tilemap/IMapObject.java`
- [Entity framework](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/entities/IEntity.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/entities/IEntity.java`
- [Abilities](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/abilities/Ability.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/abilities/Ability.java`
- [Physics and collisions](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/physics/PhysicsEngine.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/physics/PhysicsEngine.java`

### Presentation and input

- [2D rendering](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/graphics/RenderEngine.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/graphics/RenderEngine.java`
- [Sprite animation](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/graphics/animation/AnimationController.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/graphics/animation/AnimationController.java`
- [Player input](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/input/KeyboardEntityController.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/input/KeyboardEntityController.java`
- [Sound engine](https://github.com/gurkenlabs/litiengine/blob/main/litiengine/src/main/java/de/gurkenlabs/litiengine/sound/SoundEngine.java): `litiengine/src/main/java/de/gurkenlabs/litiengine/sound/SoundEngine.java`

### utiLITI editor

- [Editor application](https://github.com/gurkenlabs/litiengine/blob/main/utiliti/src/main/java/de/gurkenlabs/utiliti/Program.java): `utiliti/src/main/java/de/gurkenlabs/utiliti/Program.java`
- [Editor workflow](https://github.com/gurkenlabs/litiengine/blob/main/utiliti/src/main/java/de/gurkenlabs/utiliti/controller/Editor.java): `utiliti/src/main/java/de/gurkenlabs/utiliti/controller/Editor.java`
- [Undo manager](https://github.com/gurkenlabs/litiengine/blob/main/utiliti/src/main/java/de/gurkenlabs/utiliti/controller/UndoManager.java): `utiliti/src/main/java/de/gurkenlabs/utiliti/controller/UndoManager.java`
- [Script bindings](https://github.com/gurkenlabs/litiengine/blob/main/utiliti/src/main/java/de/gurkenlabs/utiliti/controller/ScriptBindingService.java): `utiliti/src/main/java/de/gurkenlabs/utiliti/controller/ScriptBindingService.java`

### Other components

- **Game developer**

## Connections

- Game developer → Game lifecycle: builds with
- Game lifecycle → Game world: owns (evidence: `litiengine/src/main/java/de/gurkenlabs/litiengine/Game.java`)
- Game lifecycle → Scripting: exposes (evidence: `litiengine/src/main/java/de/gurkenlabs/litiengine/Game.java`)
- Game lifecycle → Configuration: provides
- Game lifecycle → Resource loading: loads (evidence: `litiengine/src/main/java/de/gurkenlabs/litiengine/Game.java`)
- Game world → Environment: selects
- Environment → TMX tile maps: loads map data (evidence: `litiengine/src/main/java/de/gurkenlabs/litiengine/environment/Environment.java`)
- Environment → Map objects: builds entities (evidence: `litiengine/src/main/java/de/gurkenlabs/litiengine/environment/Environment.java`)
- Environment → Entity framework: stores (evidence: `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 (evidence: `litiengine/src/main/java/de/gurkenlabs/litiengine/graphics/RenderEngine.java`)
- 2D rendering → Entity framework: renders (evidence: `litiengine/src/main/java/de/gurkenlabs/litiengine/graphics/RenderEngine.java`)
- Entity framework → Sprite animation: animates with
- Sound engine → Resource loading: loads sounds (evidence: `litiengine/src/main/java/de/gurkenlabs/litiengine/sound/SoundEngine.java`)
- Editor application → Editor workflow: starts (evidence: `utiliti/src/main/java/de/gurkenlabs/utiliti/Program.java`)
- Editor workflow → Undo manager: supports undo (evidence: `utiliti/src/main/java/de/gurkenlabs/utiliti/controller/UndoManager.java`)
- Editor workflow → Script bindings: manages bindings (evidence: `utiliti/src/main/java/de/gurkenlabs/utiliti/controller/ScriptBindingService.java`)
- Script bindings → Entity framework: updates scripts (evidence: `utiliti/src/main/java/de/gurkenlabs/utiliti/controller/ScriptBindingService.java`)
- Editor workflow → TMX tile maps: edits map data
