Add project structure: directories, Main scene, and README
This commit is contained in:
38
README.md
Normal file
38
README.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# 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.Input** - Input management system
|
||||
- **EinSoftworks.Events** - Event system for game communication
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
voider/
|
||||
├── Scenes/ # Game scenes (.tscn files)
|
||||
├── 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
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
### Building
|
||||
```bash
|
||||
dotnet build
|
||||
```
|
||||
|
||||
### Running
|
||||
Open the project in Godot 4.5 and press F5 to run.
|
||||
|
||||
## License
|
||||
|
||||
TBD
|
||||
Reference in New Issue
Block a user