README
¶
Vantage
A reusable 2D game engine for Go, built on Ebitengine
and the trancecode/ecs entity-component-system
module. Extracted from the NRG game.
- Engine code: MIT (see
LICENSE). - Bundled fonts: SIL Open Font License (see each font's
OFL.txt).
Directories
¶
| Path | Synopsis |
|---|---|
|
Package app provides the engine's top-level App, which implements ebiten.Game so games do not have to.
|
Package app provides the engine's top-level App, which implements ebiten.Game so games do not have to. |
|
Package asset provides engine-bundled assets and asset loading.
|
Package asset provides engine-bundled assets and asset loading. |
|
cmd
|
|
|
showcasedemo
command
Command showcasedemo runs the engine's sprite showcase scene against procedurally generated placeholder art, so the scene can be exercised without a game and without any asset files.
|
Command showcasedemo runs the engine's sprite showcase scene against procedurally generated placeholder art, so the scene can be exercised without a game and without any asset files. |
|
visualdiff
command
Command visualdiff compares PNG images or PNG sequences pixel-for-pixel and reports the first difference, exiting non-zero on any mismatch or error.
|
Command visualdiff compares PNG images or PNG sequences pixel-for-pixel and reports the first difference, exiting non-zero on any mismatch or error. |
|
Package config provides a layered configuration loader.
|
Package config provides a layered configuration loader. |
|
Package easing provides easing curves: functions that shape how a value progresses from its start to its end over a fixed span of time.
|
Package easing provides easing curves: functions that shape how a value progresses from its start to its end over a fixed span of time. |
|
Package geometry provides geometric types and operations for 2D space.
|
Package geometry provides geometric types and operations for 2D space. |
|
Package motion provides components and systems for entity movement.
|
Package motion provides components and systems for entity movement. |
|
Package pathfinding implements A* search with terrain awareness.
|
Package pathfinding implements A* search with terrain awareness. |
|
Package render provides the graphics layer for the game.
|
Package render provides the graphics layer for the game. |
|
Package scene defines the Scene interface and the Manager that drives the scene lifecycle: registration, per-frame update, and layer-ordered drawing, with per-scene visibility and exclusive focus.
|
Package scene defines the Scene interface and the Manager that drives the scene lifecycle: registration, per-frame update, and layer-ordered drawing, with per-scene visibility and exclusive focus. |
|
Package sim provides deterministic event scheduling for games built on vantage.
|
Package sim provides deterministic event scheduling for games built on vantage. |
|
Package tilemap provides tile-based coordinate conversion and occupancy tracking.
|
Package tilemap provides tile-based coordinate conversion and occupancy tracking. |
|
Package ui provides interactive user-interface components.
|
Package ui provides interactive user-interface components. |
|
Package util provides shared infrastructure used across the codebase.
|
Package util provides shared infrastructure used across the codebase. |
|
Package visualtest provides a deterministic, pixel-exact PNG comparator for visual-regression testing that any consuming game can reuse.
|
Package visualtest provides a deterministic, pixel-exact PNG comparator for visual-regression testing that any consuming game can reuse. |
|
capture
Package capture provides a fixed-step frame-capture helper for deterministic visual-regression testing.
|
Package capture provides a fixed-step frame-capture helper for deterministic visual-regression testing. |
Click to show internal directories.
Click to hide internal directories.