You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-7Lines changed: 29 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,20 +6,42 @@ It is a small programming study, not a full game, engine, or content recreation.
6
6
7
7
This project is not affiliated with, endorsed by, or associated with Maddy Makes Games, Inc. or Extremely OK Games, Ltd. It does not include Celeste art, audio, maps, screenshots, commercial game files, or other official game assets.
**Play the demo:**<https://coolspring8.github.io/celeste-lite/>
12
+
9
13
## What This Is
10
14
11
15
- A Phaser 3 prototype with fixed-step platformer movement at a 320x180 pixel-art viewport.
12
16
- A TypeScript implementation of Celeste-inspired player movement, including jump timing, dash states, climbing, stamina, refills, spikes, jump-throughs, room transitions, death/respawn flow, and pause/unpause timing.
13
17
- A test-backed mechanics sandbox. The deeper technique coverage lives in [docs/tech-checklist.md](docs/tech-checklist.md).
14
18
- A code-generated visual prototype. Player glyphs, particles, lighting, tiles, and transition effects are created locally rather than copied from Celeste assets.
15
19
16
-
## What This Is Not
20
+
## Scope
21
+
22
+
The goal is to study and implement a narrow slice of Celeste-inspired movement and presentation in a browser-friendly TypeScript codebase. The project leans on reference-backed behavior when the released source material supports it, and keeps local approximations explicit when systems are missing or speculative.
23
+
24
+
The deeper technique coverage lives in [docs/tech-checklist.md](docs/tech-checklist.md).
25
+
26
+
Non-goals:
27
+
28
+
- No official Celeste assets, maps, story content, screenshots, audio, or commercial game files.
29
+
- No claim of complete Celeste engine parity or full entity coverage.
30
+
- No controller or mobile-ready runtime yet. The current playable path is keyboard-first.
31
+
- No claim of exact parity where the local reference surface does not support it.
32
+
33
+
## Technical Notes
34
+
35
+
The prototype runs at a 320x180 pixel-art viewport with 8px tiles, which mirrors Celeste's camera resolution and scale. This resolution integer-scales cleanly to common 16:9 display heights.
36
+
37
+
The code is split around a few main responsibilities:
17
38
18
-
- Not an official Celeste project.
19
-
- Not a Celeste asset, level, story, or content clone.
20
-
- Not a complete recreation of Celeste's engine or entity catalogue.
21
-
- Not currently a controller or mobile-ready game. The runtime is keyboard-first.
22
-
- Not a claim of exact parity where the available reference material does not support it.
39
+
-`src/player/Player.ts`: movement state machine, timers, collision-facing player behavior, assists, and emitted gameplay effects.
-`src/GameScene.ts`: Phaser scene orchestration, fixed-step updates, room flow, pause menus, death/respawn sequences, camera behavior, lighting, and debug overlays.
43
+
-`src/view/`: generated player glyph rendering, hair, particles, pause UI, intro/wipe effects, and death/respawn presentation.
44
+
-`tests/`: focused coverage for mechanics, parity constants, room behavior, input lifecycle, options, lighting, and visual models.
23
45
24
46
## Controls
25
47
@@ -58,7 +80,7 @@ Celeste and related IP belong to their respective owners, including Maddy Makes
58
80
59
81
Reference and inspiration sources include:
60
82
61
-
-[Celeste](https://www.celestegame.com/) by its original creators and team, from[Maddy Makes Games](https://www.mattmakesgames.com/) and [Extremely OK Games](https://exok.com/).
83
+
-[Celeste](https://www.celestegame.com/) by its original creators and team. Related official sites include[Maddy Makes Games](https://www.mattmakesgames.com/) and [Extremely OK Games](https://exok.com/).
62
84
- The publicly released [`Player.cs`](https://github.com/NoelFB/Celeste/blob/master/Source/Player/Player.cs) from [NoelFB/Celeste](https://github.com/NoelFB/Celeste), used as the main technical reference for player movement, states, physics constants, and some visual behavior. That repository presents the released class files as a learning resource and notes that its MIT license applies to the released code, not to the commercial Celeste game or assets.
63
85
- Maddy Thorson's [Monocle Engine](https://github.com/JamesMcMahon/monocle-engine), consulted through a public mirror, which informed parts of the local entity, collider, state machine, actor movement, and virtual input architecture.
64
86
- Noel Berry's public explanation of Madeline's hair implementation on [Reddit](https://www.reddit.com/r/gamedev/comments/9a0cfr/comment/e4rvrg2/) and the [smalleste](https://github.com/CelesteClassic/smalleste/blob/main/smalleste.p8) source, which inspired the optional dynamic hair implementation.
0 commit comments