Skip to content

Commit 4a8bf67

Browse files
committed
docs: CV-ready README with badges, highlights, gallery
1 parent 409df87 commit 4a8bf67

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
# UnityProject
22

3+
[![Unity](https://img.shields.io/badge/Unity-2022.3.11f1-black)](https://unity.com/releases/editor/whats-new/2022.3.11)
4+
[![CI](https://github.com/mgierschdev/unity-restaurant-simulation/actions/workflows/unity-tests.yml/badge.svg)](https://github.com/mgierschdev/unity-restaurant-simulation/actions/workflows/unity-tests.yml)
5+
[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
6+
[![Mode](https://img.shields.io/badge/Mode-Offline--only-blue.svg)](#secrets--security)
7+
8+
## Elevator pitch
9+
Offline-first 2D isometric restaurant/tycoon prototype for Unity: grid-based placement, NPC state machines, editor debug tools, and CI-backed tests.
10+
11+
## Highlights
12+
- Isometric grid + pathfinding utilities for place/move/rotate objects.
13+
- NPC state machine for clients/employees with table assignment and service flow.
14+
- Editor debug panels (grid + state machine) to inspect runtime state.
15+
- Offline-only build with service stubs guarded and placeholders for IDs/keys.
16+
- Unity Test Runner suites (EditMode/PlayMode) and CI workflow.
17+
18+
## Tech stack
19+
- Unity 2022.3.11f1 LTS, URP, Input System.
20+
- C# gameplay and editor scripts; GitHub Actions for tests.
21+
22+
## What I built
23+
- Grid, pathfinding, and object placement systems (`Assets/Scripts/Game/Grid`, `Assets/Scripts/Util/PathFinding`).
24+
- NPC/state-machine flow for clients and employees (`Assets/Scripts/Game/Controllers`, `Assets/Scripts/Game/Players`).
25+
- Editor debug tooling for grid and FSM introspection (`Assets/Editor`).
26+
- Offline-hardening, security placeholders, CI test runner integration.
27+
328
## 1. What this repository is
429
A Unity 2D isometric management game project with gameplay, UI, and editor tooling in C#; it is not a packaged build or a backend service. Evidence: `Assets/Scripts`, `Assets/Scenes/LoadScene.unity`, `Assets/Scenes/GameScene.unity`.
530

@@ -15,8 +40,8 @@ Run locally:
1540
- Open the project in Unity Hub, then open `Assets/Scenes/LoadScene.unity` and press Play (scenes listed in `ProjectSettings/EditorBuildSettings.asset`).
1641

1742
Run tests:
18-
- Unity Test Runner in the editor using EditMode and PlayMode tests under `Assets/Scripts/Tests`.
19-
- CLI test command: Unknown; would be confirmed by CI scripts or a test runner script (none found).
43+
- CLI: `./ci/unity-test.sh` (expects Unity on PATH).
44+
- Editor: Unity Test Runner using EditMode and PlayMode tests under `Assets/Scripts/Tests`.
2045

2146
Troubleshooting:
2247
- Networked services are disabled by default (`Settings.DisableNetwork = true` in `Assets/Scripts/Settings.cs`); enable only if Unity Services are configured.
@@ -198,3 +223,12 @@ Canonical commands:
198223
- build: Use `BuildScript.PerformAndroidBuild()` / `BuildScript.PerformIOSBuild()` from `Assets/Editor/BuildScript.cs` (no CLI wrapper documented).
199224
- run: Open `Assets/Scenes/LoadScene.unity` in Unity and press Play.
200225
- test: Use Unity Test Runner (GUI).
226+
227+
## 14. Gallery
228+
Add screenshots or GIFs under `Docs/media/` and reference them here:
229+
- `Docs/media/gameplay-1.png`
230+
- `Docs/media/editor-grid.png`
231+
- `Docs/media/npc-state.gif`
232+
233+
## 15. Changelog
234+
See [CHANGELOG.md](CHANGELOG.md) for milestone history.

0 commit comments

Comments
 (0)