null/promiscuity
2
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update GEMINI documentation to reflect Godot 4.6 and expanded project structure

Browse Source
This commit is contained in:
null 2026-05-12 16:52:57 -05:00
parent 84afc199fa
commit 3f3136c453
3 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
GEMINI.md
View File

@ -4,8 +4,8 @@ This project is a multi-layered application consisting of a Godot-based game and
## Project Structure ## Project Structure
- `game/`: The Godot 4.5 game project. - `game/`: The Godot 4.6 game project.
- `microservices/`: ASP.NET Core 8.0 microservices providing backend logic (Auth, Character, Inventory, Locations, etc.). - `microservices/`: ASP.NET Core 8.0 microservices providing backend logic (Auth, Character, Crafting, Inventory, Locations, Mail, and World).
- `.gitea/workflows/`: CI/CD pipelines for deploying microservices to Kubernetes. - `.gitea/workflows/`: CI/CD pipelines for deploying microservices to Kubernetes.
## Core Mandates ## Core Mandates
@ -17,7 +17,7 @@ This project is a multi-layered application consisting of a Godot-based game and
## Getting Started ## Getting Started
- **Microservices**: Each microservice can be run individually or via the `micro-services.sln` solution file. They require a MongoDB instance (default: `mongodb://127.0.0.1:27017`). - **Microservices**: Each microservice can be run individually or via the `micro-services.sln` solution file. They require a MongoDB instance (default: `mongodb://127.0.0.1:27017`).
- **Game**: Open `game/project.godot` in Godot Engine 4.5+. - **Game**: Open `game/project.godot` in Godot Engine 4.6+.
## Shared Conventions ## Shared Conventions

15
game/GEMINI.md
View File

@ -1,10 +1,10 @@
# Godot Game Development - GEMINI.md # Godot Game Development - GEMINI.md
This directory contains the Godot 4.5 game project for "Promiscuity". This directory contains the Godot 4.6 game project for "Promiscuity".
## Core Mandates ## Core Mandates
- **Engine Version**: Godot 4.5 (Forward Plus). - **Engine Version**: Godot 4.6 (Forward Plus).
- **Language**: GDScript is the primary scripting language. C# is enabled but used only when performance or specific library needs arise. - **Language**: GDScript is the primary scripting language. C# is enabled but used only when performance or specific library needs arise.
- **Naming Conventions**: - **Naming Conventions**:
- Files/Folders: `snake_case.gd`, `snake_case.tscn`. - Files/Folders: `snake_case.gd`, `snake_case.tscn`.
@ -14,8 +14,12 @@ This directory contains the Godot 4.5 game project for "Promiscuity".
- **Autoloads**: Use the established singletons for global state and services: - **Autoloads**: Use the established singletons for global state and services:
- `AuthState`: JWT authentication and session. - `AuthState`: JWT authentication and session.
- `CharacterService`: API calls for character management. - `CharacterService`: API calls for character management.
- `SelectedCharacter`: Tracking the currently active character.
- `QuestManager`: Game quest progression. - `QuestManager`: Game quest progression.
- `DialogSystem`: UI dialog and interaction. - `DialogSystem`: UI dialog and interaction.
- `TeleportState`: Handling transitions between levels.
- `MenuMusic` / `MenuSfx`: Audio management.
- `SimpleGrass`: Singleton for grass rendering.
- **Node Paths**: Prefer `unique names` (%NodeName) or `@onready` variables for node references. Avoid fragile string paths. - **Node Paths**: Prefer `unique names` (%NodeName) or `@onready` variables for node references. Avoid fragile string paths.
## Asset Pipeline ## Asset Pipeline
@ -30,8 +34,13 @@ This directory contains the Godot 4.5 game project for "Promiscuity".
- `Characters/`: Player and NPC scenes. - `Characters/`: Player and NPC scenes.
- `Levels/`: Game world/environments. - `Levels/`: Game world/environments.
- `UI/`: Menus, HUDs, and UI components. - `UI/`: Menus, HUDs, and UI components.
- `Interaction/`: Interactive objects and systems (e.g., RadialCommandMenu).
- `Projectiles/`: Projectiles like fireballs.
- `Quests/`: Quest-related scenes and logic.
- `Vehicles/`: Controllable vehicles.
- `CardGame/`: Minigame components.
- `assets/`: Raw assets (textures, models, audio). - `assets/`: Raw assets (textures, models, audio).
- `addons/`: Third-party plugins (e.g., `simplegrasstextured`). - `addons/`: Third-party plugins (e.g., `simplegrasstextured`, `godot_mcp`).
## Best Practices ## Best Practices

2
microservices/GEMINI.md
View File

@ -39,4 +39,4 @@ Each microservice follows a standard layout:
- Update `DOCUMENTS.md` whenever you change a database schema or API request/response shape. - Update `DOCUMENTS.md` whenever you change a database schema or API request/response shape.
- Ensure `Dockerfile` and `k8s/` manifests are kept in sync with code changes. - Ensure `Dockerfile` and `k8s/` manifests are kept in sync with code changes.
- All microservices are unified under the `micro-services.sln` solution file. - All microservices are unified under the `micro-services.sln` solution file. Use this for global refactoring or cross-service debugging.