Skip to content

Commit 0629dc5

Browse files
committed
Add ARCHITECURE.md and cursor rule for it
1 parent ed128e8 commit 0629dc5

4 files changed

Lines changed: 84 additions & 1 deletion

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
alwaysApply: true
3+
---
4+
- Before you do anything, check `ARCHITECTURE.md` for the file structure.
5+
- Keep `ARCHITECTURE.md` updated to reflect the latest file structure structure.

.cursor/rules/update-progress.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ description: Always keep progress updated
33
alwaysApply: true
44
---
55
- Before you do anything, check `PROGRESS.md` for what is already done.
6-
- After you do anything, update `PROGRESS.md` afterwards to keep track of what is done. Keep the wording simple. Skip test related progress.
6+
- After you do anything, update `PROGRESS.md` afterwards to keep track of what is done. Keep the wording simple. Skip test related progress and redundant items.
77
- This serves as long-term context.

ARCHITECTURE.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
python_mini_metro/
2+
|- .cursor/
3+
| |- rules/
4+
| | |- run-tests-after-changes.mdc
5+
| | |- update-architecture.mdc
6+
| | |- update-game-rules.mdc
7+
| | \- update-progress.mdc
8+
|- .github/
9+
| \- workflows/
10+
| \- test.yml
11+
|- src/
12+
| |- agent_play.py
13+
| |- config.py
14+
| |- env.py
15+
| |- main.py
16+
| |- mediator.py
17+
| |- travel_plan.py
18+
| |- type.py
19+
| |- utils.py
20+
| |- entity/
21+
| | |- get_entity.py
22+
| | |- holder.py
23+
| | |- metro.py
24+
| | |- padding_segment.py
25+
| | |- passenger.py
26+
| | |- path.py
27+
| | |- path_segment.py
28+
| | |- segment.py
29+
| | \- station.py
30+
| |- event/
31+
| | |- convert.py
32+
| | |- event.py
33+
| | |- keyboard.py
34+
| | |- mouse.py
35+
| | \- type.py
36+
| |- geometry/
37+
| | |- circle.py
38+
| | |- cross.py
39+
| | |- diamond.py
40+
| | |- line.py
41+
| | |- pentagon.py
42+
| | |- point.py
43+
| | |- polygon.py
44+
| | |- rect.py
45+
| | |- shape.py
46+
| | |- star.py
47+
| | |- triangle.py
48+
| | |- type.py
49+
| | \- utils.py
50+
| |- graph/
51+
| | |- graph_algo.py
52+
| | \- node.py
53+
| \- ui/
54+
| |- button.py
55+
| |- path_button.py
56+
| \- viewport.py
57+
|- test/
58+
| |- test_agent_play.py
59+
| |- test_coverage_utils.py
60+
| |- test_env.py
61+
| |- test_gameplay.py
62+
| |- test_geometry.py
63+
| |- test_graph.py
64+
| |- test_main.py
65+
| |- test_mediator.py
66+
| |- test_path.py
67+
| |- test_station.py
68+
| \- test_viewport.py
69+
|- .gitignore
70+
|- .pre-commit-config.yaml
71+
|- ARCHITECTURE.md
72+
|- environment.yml
73+
|- GAME_RULES.md
74+
|- PROGRESS.md
75+
|- pyproject.toml
76+
|- README.md
77+
\- requirements.txt

PROGRESS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,4 @@
3737
- Updated `GAME_RULES.md` line/station progression and passenger spawning timing details to match current implementation.
3838
- Added rare one-of-a-kind station shapes (diamond, pentagon, star) and shape rendering support.
3939
- Added station-pool generation logic so unique shapes can only appear after the 10th station slot and at most once each per run.
40+
- Updated `ARCHITECTURE.md` to reflect the latest project file structure.

0 commit comments

Comments
 (0)