Remove Main scene and script, add StateManagement library, update project structure documentation
This commit is contained in:
29
README.md
29
README.md
@@ -6,21 +6,32 @@ A game project built with Godot 4.5 and C#.
|
||||
|
||||
This project uses the following custom libraries:
|
||||
- **EinSoftworks.Utilities** - Math and utility functions
|
||||
- **EinSoftworks.Input** - Input management system
|
||||
- **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 game scenes
|
||||
│ │ └── Main.tscn
|
||||
│ ├── Player/ # Player scenes
|
||||
│ ├── Enemies/ # Enemy scenes
|
||||
│ ├── UI/ # UI scenes
|
||||
│ └── Testing/ # Test scenes
|
||||
│ └── LibraryTest.tscn
|
||||
├── Scripts/ # C# scripts
|
||||
├── Resources/ # Game resources
|
||||
│ ├── Textures/ # Images and sprites
|
||||
│ ├── Audio/ # Sound effects and music
|
||||
│ └── Fonts/ # Font files
|
||||
├── Prefabs/ # Reusable scene prefabs
|
||||
└── UI/ # User interface scenes
|
||||
│ ├── 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
|
||||
```
|
||||
|
||||
## Development
|
||||
@@ -33,6 +44,10 @@ 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
|
||||
|
||||
Reference in New Issue
Block a user