https://github.com/filip-drabinski/godot.dependencyinjection
Godot.DependencyInjection
https://github.com/filip-drabinski/godot.dependencyinjection
dependency-injection godot godot-engine godot-game-engine godotengine
Last synced: 2 months ago
JSON representation
Godot.DependencyInjection
- Host: GitHub
- URL: https://github.com/filip-drabinski/godot.dependencyinjection
- Owner: Filip-Drabinski
- License: mit
- Created: 2023-04-23T15:47:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-15T09:53:02.000Z (about 1 year ago)
- Last Synced: 2025-01-31T04:25:22.023Z (3 months ago)
- Topics: dependency-injection, godot, godot-engine, godot-game-engine, godotengine
- Language: C#
- Homepage:
- Size: 85 KB
- Stars: 59
- Watchers: 4
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: license
Awesome Lists containing this project
README
# Godot.DependencyInjection
Godot.DependencyInjection is a lightweight and easy-to-use dependency injection framework for the [Godot](https://godotengine.org/) game engine, specifically tailored for C#. It aims to help developers create more modular, testable, and maintainable game projects using the Godot engine.
## Features
- Easy to set up and use
- Supports property, field, and method injection
- Provides member dependency injection for usage with resources
- Utilizes standard C# dependency injection abstractions
- Supports transient, scoped, and singleton lifetimes
## Installation
You can install the package via [NuGet](https://www.nuget.org/packages/Godot.DependencyInjection) or clone the repository and add a project reference to the solution created by Godot.
## Usage
```csharp
using Godot.DependencyInjection.Services.Input;
public partial class RegularNode : Node2D
{
[Inject]
public IInputService inputService;
[Inject]
public IService Service { get; set; }
[Inject]
public IService[] Services1 { get; set; }
[Inject]
public IEnumerable Services2 { get; set; }
[Export]
[InjectMembers]
public CustomResource Resource { get; set; }
[Inject]
public void Inject(IService service, IService[] services1, IEnumerable services2)
{
// ***
}
}
```
## Configuration
1. Create a script for dependency manager:
```csharp
public partial class DependencyInjectionNode : DependencyInjectionManagerNode
{
}
```
2. Add the script to Project -> Project Settings -> Autoload.
3. Create a `Node` and script for dependency registration:
```csharp
public partial class DependencyRegistrationNode : Node, IServicesConfigurator
{
public void ConfigureServices(IServiceCollection services)
{
services.AddGodotServices();
services.AddTransient();
}
}
```
4. Add dependency registration node to scene
## Remarks
Please note that this project is in its early stages of development and may require significant improvements. The framework is functional but may not be suitable for production use in its current state. Any feedback, suggestions, or contributions to improve the framework are highly appreciated.
## Contributing
I'm currently in the process of reevaluating the architecture and scope of the project, so only pull requests containing changes to documentation might be merged. If you have any ideas for code improvements, please create a new issue instead.
## Support
If you have any questions, issues, or suggestions, please create a new issue on the GitHub repository.
## License
This project is licensed under the MIT License. See the [LICENSE](license) file for more information.