summaryrefslogtreecommitdiff
path: root/platformer/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--platformer/README.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/platformer/README.md b/platformer/README.md
index 9adbe7b..4d79ed0 100644
--- a/platformer/README.md
+++ b/platformer/README.md
@@ -110,6 +110,10 @@ arrow keys = camera, C = recenter camera, Space = jump, R = reset, Esc = quit.
## Architecture
+**Terms:** an **object** is anything solid in the game world: a platform, cliff, pillar, wall or
+moving platform (all boxes). A **zone** is a non-solid region where an effect applies (such as the
+locked-pan zone). Zones are box-shaped too, but they're never objects: nothing collides with them.
+
| File | Purpose |
|---|---|
| `src/main.c` | Entry point. Starts every module, runs the fixed-timestep game loop, shuts down. |
@@ -132,7 +136,7 @@ controls ──► window (keyboard fallback needs the window handle)
player ──► physics, world, controls (Input struct only)
physics ──► world
world ──► level (level.c only uses world.h's Box type; it never calls world)
-camera ──► controls (Input struct only)
+camera ──► controls (Input struct only), world (keeps the eye out of objects)
render ──► player, camera, world (reads only, never modifies)
everything ──► config.h, math3d.h
```
@@ -192,8 +196,7 @@ Suggested fill-in order (each step can be compiled before moving on):
## Roadmap (explicitly *not* now)
-- Richer level geometry: slopes, moving platforms, step-up onto small ledges, hand-built or loaded levels
-- Camera collision (the camera can currently pass through tall platforms)
+- Richer level geometry: slopes, hand-built or loaded levels (moving platforms and stairs exist)
- Loading levels
- SM64-style extra moves: triple jump, long jump, ground pound (the second jump, the skid's retreat
jump and the wall hang/wall jump exist)