summaryrefslogtreecommitdiff
path: root/platformer/src/config.h
diff options
context:
space:
mode:
Diffstat (limited to 'platformer/src/config.h')
-rw-r--r--platformer/src/config.h153
1 files changed, 153 insertions, 0 deletions
diff --git a/platformer/src/config.h b/platformer/src/config.h
new file mode 100644
index 0000000..c71ae35
--- /dev/null
+++ b/platformer/src/config.h
@@ -0,0 +1,153 @@
+/*
+ * ============================================================
+ * FILE: config.h
+ *
+ * PURPOSE: Every tunable number in the game, in one place. When movement
+ * "feels wrong", this is the first (and usually only) file to edit.
+ *
+ * FITS IN: Included by almost every .c file. Contains only #defines,
+ * with no functions, no types and no includes.
+ * Nothing in the game should hard-code a number that appears here.
+ *
+ * INTERFACE: Plain #define constants, float literals with an `f` suffix.
+ * Give EVERY constant a one-line comment that says what it
+ * changes about the *feel*, e.g. "higher = snappier stops".
+ * Use these exact names (other files depend on them). The
+ * values are starting points for tuning:
+ *
+ * Window
+ * WINDOW_WIDTH 1280
+ * WINDOW_HEIGHT 720
+ * WINDOW_TITLE "platformer"
+ * SKY_COLOR_R/G/B 0.45f 0.65f 0.90f (clear color)
+ *
+ * Simulation timing
+ * TICK_HZ 60 (fixed logic rate; SM64 used 30)
+ * TICK_DT (1.0f / TICK_HZ) (seconds per tick)
+ * MAX_FRAME_TIME 0.25f (clamp to avoid a "spiral of death"
+ * after a stall / breakpoint)
+ *
+ * Input
+ * MOVE_DEADZONE 0.20f (radial, left stick)
+ * LOOK_DEADZONE 0.20f (radial, right stick)
+ *
+ * Player: ground movement
+ * PLAYER_MAX_SPEED 9.0f m/s at full stick tilt
+ * PLAYER_GROUND_ACCEL 30.0f m/s^2 speeding up toward target speed
+ * PLAYER_GROUND_FRICTION 40.0f m/s^2 slowing down with no input
+ * PLAYER_TURN_RATE 12.0f rad/s max facing rotation on ground
+ *
+ * Player: air movement
+ * PLAYER_AIR_CONTROL 0.30f 0..1 multiplier on accel + turn rate in air
+ * PLAYER_JUMP_VELOCITY 14.0f m/s upward at jump start (~2.4 m apex)
+ * PLAYER_JUMP_CUT 0.50f vel.y multiplier when A released while rising
+ *
+ * Physics
+ * GRAVITY 40.0f m/s^2 (stronger than real 9.8 on purpose:
+ * platformers feel floaty with real gravity)
+ * TERMINAL_VELOCITY 50.0f m/s max fall speed
+ *
+ * Player: size (used by render, and later by collision)
+ * PLAYER_HALF_WIDTH 0.4f m
+ * PLAYER_HEIGHT 1.6f m (body.pos is the player's FEET)
+ *
+ * Camera
+ * CAMERA_DISTANCE 10.0f m from target
+ * CAMERA_TARGET_HEIGHT 1.0f m above player's feet to look at
+ * CAMERA_PITCH_DEFAULT 0.35f rad above horizontal
+ * CAMERA_PITCH_MIN 0.05f rad
+ * CAMERA_PITCH_MAX 1.20f rad
+ * CAMERA_YAW_SPEED 2.5f rad/s at full right-stick tilt
+ * CAMERA_PITCH_SPEED 1.5f rad/s at full right-stick tilt
+ * CAMERA_FOLLOW_RATE 8.0f 1/s; how fast the camera's DISTANCE catches up
+ * when the player runs toward/away from it
+ * CAMERA_ZONE_INSET 0.05f fraction of the window between the resting
+ * zone and the running bound, on every side
+ * CAMERA_ZONE_TOP 0.50f window fraction (0 = bottom) of the resting
+ * zone's top edge; lower = more view ahead
+ * CAMERA_SETTLE_RATE 3.0f 1/s; how fast the camera re-frames a player
+ * who stopped outside the resting zone
+ * CAMERA_RECENTER_RATE 6.0f 1/s; how fast the recenter button swings
+ * behind the player and centers them
+ * CAMERA_MIN_HEIGHT 0.5f m; lowest the eye may go above the player's feet
+ * CAMERA_FOV_DEG 60.0f vertical field of view
+ * CAMERA_NEAR 0.1f
+ * CAMERA_FAR 500.0f
+ *
+ * World
+ * WORLD_HALF_EXTENT 100.0f m; the ground is a square of 2x this per side
+ * GRID_SPACING 1.0f m between grid lines
+ * GRID_MAJOR_EVERY 10 every Nth line drawn brighter
+ *
+ * CONVENTIONS: 1 unit = 1 meter, seconds, radians (degrees only for the FOV,
+ * converted where it's used). Include guard: CONFIG_H.
+ *
+ * NOT IN SCOPE: Runtime config files, command-line parsing, hot-reload.
+ *
+ * DONE WHEN: Every constant above exists with a comment, and no other
+ * file contains a magic number for any of these concepts.
+ * ============================================================
+ */
+#ifndef CONFIG_H
+#define CONFIG_H
+
+/* ---- Window ------------------------------------------------------------ */
+#define WINDOW_WIDTH 1280 /* starting window width, pixels */
+#define WINDOW_HEIGHT 720 /* starting window height, pixels */
+#define WINDOW_TITLE "platformer" /* base title; main.c appends the debug readout */
+#define SKY_COLOR_R 0.45f /* clear color: the "sky" behind everything */
+#define SKY_COLOR_G 0.65f
+#define SKY_COLOR_B 0.90f
+
+/* ---- Simulation timing ------------------------------------------------- */
+#define TICK_HZ 60 /* logic ticks per second; higher = lower input latency (SM64 used 30) */
+#define TICK_DT (1.0f / TICK_HZ) /* seconds per tick; derived, don't edit */
+#define MAX_FRAME_TIME 0.25f /* longest frame we catch up on; stops a "spiral of death" after a stall */
+
+/* ---- Input ------------------------------------------------------------- */
+#define MOVE_DEADZONE 0.20f /* left stick radius ignored; higher = less drift, less fine control */
+#define LOOK_DEADZONE 0.20f /* right stick radius ignored; higher = camera harder to nudge */
+
+/* ---- Player: ground movement ------------------------------------------- */
+#define PLAYER_MAX_SPEED 9.0f /* m/s at full stick tilt; higher = faster top run speed */
+#define PLAYER_GROUND_ACCEL 30.0f /* m/s^2 toward target speed; higher = snappier starts */
+#define PLAYER_GROUND_FRICTION 40.0f /* m/s^2 slowdown with stick released; higher = snappier stops */
+#define PLAYER_TURN_RATE 12.0f /* rad/s max facing rotation on ground; higher = tighter turns */
+
+/* ---- Player: air movement ---------------------------------------------- */
+#define PLAYER_AIR_CONTROL 0.30f /* 0..1 multiplier on accel + turn rate in air; higher = more steerable jumps */
+#define PLAYER_JUMP_VELOCITY 14.0f /* m/s upward at jump start; higher = taller jumps (~2.4 m apex at 14) */
+#define PLAYER_JUMP_CUT 0.50f /* vel.y multiplier on early A release; lower = shorter taps */
+
+/* ---- Physics ----------------------------------------------------------- */
+#define GRAVITY 40.0f /* m/s^2; stronger than real 9.8 on purpose, real gravity feels floaty */
+#define TERMINAL_VELOCITY 50.0f /* m/s max fall speed; lower = long falls feel more controlled */
+
+/* ---- Player: size (used by render, and later by collision) ------------- */
+#define PLAYER_HALF_WIDTH 0.4f /* m; half the box's width/depth */
+#define PLAYER_HEIGHT 1.6f /* m; box height (body.pos is the player's FEET) */
+
+/* ---- Camera ------------------------------------------------------------ */
+#define CAMERA_DISTANCE 10.0f /* m from target; higher = see more, player looks smaller */
+#define CAMERA_TARGET_HEIGHT 1.0f /* m above player's feet the camera looks at */
+#define CAMERA_PITCH_DEFAULT 0.35f /* rad above horizontal at start */
+#define CAMERA_PITCH_MIN 0.05f /* rad; lowest the camera can swing (just above the ground) */
+#define CAMERA_PITCH_MAX 1.20f /* rad; highest the camera can swing (near top-down) */
+#define CAMERA_YAW_SPEED 2.5f /* rad/s orbit at full right-stick tilt; higher = faster spin */
+#define CAMERA_PITCH_SPEED 1.5f /* rad/s tilt at full right-stick tilt */
+#define CAMERA_FOLLOW_RATE 8.0f /* 1/s; how fast the distance catches up when running toward/away; lower = more lag */
+#define CAMERA_ZONE_INSET 0.05f /* window fraction between resting zone and running bound; higher = tighter zone */
+#define CAMERA_ZONE_TOP 0.50f /* resting zone's top edge (0 = bottom, 1 = top); lower = more view ahead of the player */
+#define CAMERA_SETTLE_RATE 3.0f /* 1/s; re-framing after stopping outside the zone; lower = lazier, more cinematic */
+#define CAMERA_RECENTER_RATE 6.0f /* 1/s; how fast recenter swings behind the player and centers them */
+#define CAMERA_MIN_HEIGHT 0.5f /* m; lowest the eye may sit above the player's feet (keeps it out of the floor) */
+#define CAMERA_FOV_DEG 60.0f /* vertical field of view, degrees; higher = wider, faster-feeling view */
+#define CAMERA_NEAR 0.1f /* m; near clip plane */
+#define CAMERA_FAR 500.0f /* m; far clip plane (must reach past the world edge) */
+
+/* ---- World ------------------------------------------------------------- */
+#define WORLD_HALF_EXTENT 100.0f /* m; the ground is a square of 2x this per side */
+#define GRID_SPACING 1.0f /* m between grid lines; the grid is how you read speed */
+#define GRID_MAJOR_EVERY 10 /* every Nth line drawn brighter, for reading distances */
+
+#endif /* CONFIG_H */