Add project docs, MIT license, and AI dev guidelines

2026-07-26 14:11:18 +00:00
parent 0dc103275f
commit cbb77576bb
3 changed files with 112 additions and 0 deletions
@@ -0,0 +1,50 @@
+# FrogFPS
+
+A Godot 4.7 + Mono (.NET 8) FPS game project.
+
+## Tech Stack
+
+- **Engine:** Godot 4.7 (Forward Plus)
+- **Language:** C# (.NET 8)
+- **Physics:** Jolt Physics
+- **IDE:** VS Code / Rider recommended
+
+## Getting Started
+
+### Prerequisites
+
+- Godot 4.7+ with .NET SDK installed
+- .NET 8 SDK
+
+### Build & Run
+
+```bash
+# Open in Godot Editor (recommended)
+godot --path .
+
+# Or build from CLI
+dotnet build FrogFPS.sln
+```
+
+## Project Structure
+
+```
+.
+├── Base.tscn          # Root scene node
+├── FrogFPS.csproj     # .NET project file
+├── FrogFPS.sln        # Solution file
+├── project.godot      # Godot project config
+└── icon.svg           # Project icon
+```
+
+## AI Development Notes
+
+This project is set up for AI-assisted development. Key conventions:
+
+- C# scripts follow Godot 4 patterns (`[Tool]`, `Node3D`/`CharacterBody3D` base classes)
+- Scene files are in `.tscn` format (text-based, version-controlled)
+- See `CONTRIBUTING.md` for coding standards and AI interaction guidelines
+
+## License
+
+MIT License — see [LICENSE](LICENSE) for details.