64 lines
1.8 KiB
Markdown
64 lines
1.8 KiB
Markdown
# Voider
|
|
|
|
A game project built with Godot 4.5 and C#.
|
|
|
|
## Libraries
|
|
|
|
This project uses the following custom libraries:
|
|
- **EinSoftworks.Utilities** - Math and utility functions
|
|
- **EinSoftworks.Events** - Event system for game communication
|
|
- **EinSoftworks.Input** - Input management system
|
|
- **EinSoftworks.StateManagement** - State machine system
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
voider/
|
|
├── Scenes/ # Game scenes (.tscn files)
|
|
│ ├── Core/ # Core entry points
|
|
│ │ └── Main.tscn
|
|
│ ├── Levels/ # Game levels/stages
|
|
│ ├── Player/ # Player entity scenes (prefabs)
|
|
│ ├── Enemies/ # Enemy entity scenes (prefabs)
|
|
│ ├── UI/ # UI screens and menus
|
|
│ └── Testing/ # Test scenes
|
|
│ └── LibraryTest.tscn
|
|
├── Scripts/ # C# scripts
|
|
│ ├── Core/ # Core game systems
|
|
│ │ ├── Main.cs
|
|
│ │ └── EventManager.cs
|
|
│ ├── Player/ # Player-related scripts
|
|
│ ├── Enemies/ # Enemy scripts
|
|
│ ├── UI/ # UI scripts
|
|
│ └── Testing/ # Test and debug scripts
|
|
│ └── LibraryTest.cs
|
|
└── Docs/ # Documentation
|
|
```
|
|
|
|
### Scene Organization
|
|
|
|
- **Levels/**: Actual game levels where gameplay happens
|
|
- **Player/Enemies/**: Reusable entity scenes (like prefabs) that get instantiated into levels
|
|
- **UI/**: Menu screens, HUD, dialogs
|
|
- **Core/**: Main entry point and core game scenes
|
|
- **Testing/**: Development and testing scenes
|
|
```
|
|
|
|
## Development
|
|
|
|
### Building
|
|
```bash
|
|
dotnet build
|
|
```
|
|
|
|
### Running
|
|
Open the project in Godot 4.5 and press F5 to run.
|
|
|
|
### Testing Libraries
|
|
Run the `Scenes/Testing/LibraryTest.tscn` scene (F6) to test all integrated libraries.
|
|
See `Docs/LIBRARY_TEST.md` for details.
|
|
|
|
## License
|
|
|
|
TBD
|