Av3boy / Av3boy/SharpEngine

Minimal deliverables, overriding default values & settings

Open
#144 0 comments 0 reactions 0 assignees View on GitHub
core enhancement maintainability spike
Dominant language
C#
Stars
6
Forks
0
Avg merge
1h 1m
Merged PRs (30d)
2

Description

The codebase currently has things like default shaders and images. We should come up with a way on how we want to handle those in the future.

To actually deliver a NuGet package with as much content stripped away as possible, so that the user can download only the things that they need, those default things may be redundant.

If we move the defaults into a separate NuGet package, we will get build errors saying those shader variable names are missing.

We need to come up with which of these is the best solution:
- Let the user set those default textures.
- Immediately upon object creation specify the texture of an object.
- Make the engine throw an exception about missing files.

We could leverage the Dependency Injection system to set a IDefaults interface with these values?

Similarly, we need to populate the ISettings interface.
Currently we have default settings which our windows use.

We also need to extend the window creation DI service so that the user is able to pass those settings as a Func.

------------------------

When building our NuGet packages, things like loggers we might want to strip away.
To achieve that we might want to consider adding a compiler directive like #If LoggerEnabled and initialize that directive inside the .csproj by checking if the SharpEngine.Telemetry and Microsoft.Logging.Extensions libraries are present.

Contributor guide

Open the contributing guide

Research direction

Start by mapping the current default shaders, images, IDefaults and ISettings interfaces, then inspect the window-creation DI service. Review the NuGet packaging setup and the .csproj logging dependencies before choosing an approach. Done means the default resources and settings strategy, window settings injection, and optional logger packaging behavior are specified and implemented.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
build-system, game-dev
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.