This project is a collection of experimental systems and patterns that I created to serve as the foundation of my Godot game projects written in C#.
The framework is a Godot addon, and should be located in the addons directory of a Godot project. E.g. PROJECT_ROOT/addons/godotegp-framework.
IMAGE
The first component of the framework is an extendable Logger class providing useful coloured output to the Godot console. It includes timestamp including milliseconds ticks passed and current date & time, the name of the class which called the log request, the log level, the logged message, and an optional data dump of a variable or object.
Logging with the LoggerManager is my replacement to using GD.Print(), so that I don't have to worry about formatting a useful log string every time. Instead, it's just as simple as this: LoggerManager.LogDebug("Godot ftw!").
I use my own logger exclusively instead of GD.Print().
Different logging levels are available:
LoggerManager.LogTrace("this is a trace message and will print the file path and line number")LoggerManager.LogDebug("the best kind of log!")LoggerManager.LogInfo("something informational")LoggerManager.LogWarning("a warning")LoggerManager.LogError("something went wrong")LoggerManager.LogCritical("something went really wrong")
The current log level can be configured, suppressing any logs lower than the configured level. The default for a Debug build is Trace, while the default for a Release build is Info.
Each logging method supports 4 parameters, the last 2 being the data dump name and the data/object to dump. It's then rendered out like this at the end of the line: dataName=dataContent.
LoggerManager.LogDebug("Godot ftw!", "", "dataName", someObjectToDump)
Under the hood the object is being serialised and printed as JSON.
The Logging.Destination namespace includes IDestination allowing implementation of a custom logging destination, such as a filesystem log or a remote logging destination.
Different classes can have different destination groups configured, allowing for a tailored logging configuration.
The included destination implementations are DefaultConsole and GodotConsole.
The Logging.Formatter namespace includes IFormatter, allowing implementation of custom pre- and post- text formatting steps on each component, including setting the final formatting string.
The included formatter implementations are TextFormatter for non-colourized output, and GodotRichFormatter building on-top of the TextFormatter providing Godot colourised output.
The main component offered by the framework is the ServiceRegistry class which provides lazy-loading access to Godot Node instances inheriting from the Service class. Services are persistent, single instance nodes designed to provide access to Managers/Handlers/Configurations from anywhere in the project.
Creating a service is easy, it just needs to extend GodotEGP.Service.Service, and then you get and create an instance automatically like so: ServiceRegistry.Get<YourServiceClass>().
Various other components are included, and it's recommended to explore the code base.