MiniLibX-powered 2D exploration gane with animated sprite work, full map validation, with a built-in Tester.

1. About
2. Subject Compliance
3. Custom Tester
4. Repository Layout
5. Build & Integration
6. Usage Guidelines
7. Feature Deep Dive
8. Input & Animation
9. Rendering & HUD
10. Internal Architecture
11. Tester Workflow
12. Results & Reporting

Highlights: Mandatory compliance, bonus animations, and repeatable validation in a single codebase.

• Mandatory source lives in src/, matching the subject's structure; bonus content lives in srcb/ and keeps API parity for easy swapping.
• Map safety hinges on rectangular checks, perimeter walls, required components, and a flood-fill reachability pass before the game even opens.
• Assets are all local (assets/), so the build stays portable across 42 evaluation hosts and personal setups.
• The Makefile wraps compilation, guided map selection, and automated tests so setup-to-play is a two-command workflow.

# Compile the animated build and launch a sample map
make bonus && ./so_long assets/maps/valid/demo.ber

• The game parses .ber layouts, validates them, spins up MiniLibX, and reacts to keyboard inputs through the routines in src/game/game_init.c and src/game/game_input.c.
• Directional animation, mining loops, and enemy patrol failures come from the bonus pipeline (srcb/game/game_animations_bonus.c, srcb/game/game_input_bonus.c).
• Collectibles, exits, and enemies are all configured from tile metadata, so map changes flow straight into gameplay without code edits.
• Libft (including ft_printf, get_next_line, and utility helpers) ships inside the repository, removing external dependencies for evaluators or teammates.

Every rule in the subject is explicitly validated before the game starts, ensuring predictable and safe gameplay.

inc/          - Shared headers (`so_long.h`, `so_long_bonus.h`) describing structs, keycodes, and prototypes.
src/          - Mandatory gameplay: static sprites, HUD-free movement, and core validation.
srcb/         - Bonus gameplay: animated sprites, mining cycles, HUD overlay, and enemy collisions.
assets/       - Tiles, player sprites, mining sequences, and curated maps (valid + invalid suites).
docs/         - Subject PDF and capture assets (WEBM sources + README GIFs).
mlx/          - MiniLibx Library already compiled to ease use
libft/        - Custom 42 Library with helper functions (printf, gnl, libft/ft_*)

Self-contained tooling: clone, build, test- no extra environment work.

make            # mandatory build (clones libft if absent)
make bonus      # animated build with mining + enemy logic
make start      # interactive map chooser with optional launch
make tester     # runs invalid-map sweep + texture permissions suite
make fclean     # removes binaries, objects, and the libft clone

• make pulls in libft (if missing), builds MiniLibX, and links the mandatory binary.
• make bonus compiles the bonus objects and still outputs so_long, so launching maps never changes between builds.
• make start offers an ncurses-like prompt that copies a map to the working directory, optionally runs it, and cleans up the copy afterwards (Makefile:64).
• make tester orchestrates both test targets sequentially, with exit codes bubbling up so CI can flag failures instantly.

Playbook: load a map, explore, and exit without leaving artifacts behind.

• Launch the mandatory build with ./so_long <map.ber> or compile the bonus branch first for animated sprites.
• Movement is WASD-driven; ESC and the window close button call close_game() for a graceful teardown (srcb/game/game_input_utils_bonus.c:36).
• Expect rectangular, fully walled maps with one player, one exit, collectibles, and optional enemies; anything else is rejected with a formatted error.
• Collectibles trigger a mining animation and decrement counters before updating the HUD (srcb/game/game_input_utils_bonus.c:53).
• Enemy contact prints a game-over message and closes the window immediately, keeping the loss state tight (srcb/game/game_input_bonus.c:31).

Automation flow: compile once, sweep invalid maps, lock down textures, and surface leaks immediately.

• test_invalid iterates through every .ber stored under assets/maps/invalid, capturing the first two output lines to ensure the standard "Error" header and explanation are intact (Makefile:190).
• Valgrind runs in the background for each invalid map, forcing an error exit code on leaks so memory hygiene is verified alongside messaging.
• test_textures chmods each .xpm to 000, runs the game with a known-good map, confirms the error mentions the missing file, and restores original permissions (Makefile:240).
• make tester returns non-zero if any suite fails, so the target doubles as a CI check or a quick local regression test.

Signal over noise: The tester and logs are designed to show only the important results (errors, verdicts, tallies) and hide unnecessary clutter for efficient debugging.

• Console logs show per-case verdicts and aggregate tallies, making it obvious where to focus next.
• Valgrind trace dumps appear only when something goes wrong, keeping successful runs concise.
• During manual sessions, the on-screen move counter mirrors the terminal printf output so navigation errors are easy to trace.