Retro.Debug.Data.Provider
                               
                            
                                0.1.4-alpha
                            
                        
                    See the version list below for details.
dotnet add package Retro.Debug.Data.Provider --version 0.1.4-alpha
NuGet\Install-Package Retro.Debug.Data.Provider -Version 0.1.4-alpha
<PackageReference Include="Retro.Debug.Data.Provider" Version="0.1.4-alpha" />
<PackageVersion Include="Retro.Debug.Data.Provider" Version="0.1.4-alpha" />
<PackageReference Include="Retro.Debug.Data.Provider" />
paket add Retro.Debug.Data.Provider --version 0.1.4-alpha
#r "nuget: Retro.Debug.Data.Provider, 0.1.4-alpha"
#:package Retro.Debug.Data.Provider@0.1.4-alpha
#addin nuget:?package=Retro.Debug.Data.Provider&version=0.1.4-alpha&prerelease
#tool nuget:?package=Retro.Debug.Data.Provider&version=0.1.4-alpha&prerelease
Retro Debug Data Provider
This project goal is to provide as much debugging support as possible for retro assemblers and possibly compilers starting with KickAssembler.
Current services
- Debug file (.dbg) parsing provided by IKickAssemblerDbgParser.
- Byte dump file (.dmp) parsing provided by IKickAssemblerByteDumpParser.
- Compiler invocation (NOTE: Kick Assembler requires java installed on computer, OpenJDK is fine) provide by IKickAssemblerCompiler.
- Converting Kick Assembler specific data into universal model provided by IKickAssemblerProgramInfoBuilder.
- Universal model - for different assemblers and compilers (early version, might change in future) with top class AssemblerAppInfo.
I will add more services and more support types along the path.
This is a .NET 8+ cross-platform library.
Dependency injection support
All service classes have matching interface. Register them manually or run IoCRegistrar.AddDebugDataProvider extension method on IServiceCollection instance like:
public static IServiceCollection Configure(this IServiceCollection services)
{
    services.AddDebugDataProvider();
}
Debug file parser
Get debug data model by calling
var model = await IKickAssemblerDbgParser.LoadFileAsync("PATH_TO_DBG_FILE", ct)
Byte dump file parser
Get byte dumb model by calling
var model = await IKickAssemblerByteDumpParser.LoadFileAsync("PATH_TO_BYTE_DUMP_FILE", ct)
Compiler invocation
Unified model converter
Convert Kick Assembler specific debug model to universal one by calling
var universalModel = await IKickAssemblerProgramInfoBuilder.BuildAppInfoAsync("PROJECT_DIRECTORY", debugData, ct)
where debugData argument is output from Debug file parser.
Build from sources
Clone repository.
Since Kick Assembler binaries are not included in this repository, it's required to download them and manual install them: in src/Righthand.RetroDbgDataProvider/Righthand.RetroDbgDataProvider subdirectory create directory binaries/KickAss and place inside Kick Assembler files KickAss.cfg and KickAss.jar.
| Product | Versions Compatible and additional computed target framework versions. | 
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. | 
- 
                                                    net8.0- Antlr4.Runtime.Standard (>= 4.13.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
 
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated | 
|---|---|---|
| 0.3.0-alpha | 90 | 3/15/2025 | 
| 0.2.0-alpha | 85 | 11/30/2024 | 
| 0.1.5-alpha | 97 | 9/30/2024 | 
| 0.1.4-alpha | 93 | 9/24/2024 | 
| 0.1.3-alpha | 85 | 9/1/2024 | 
| 0.1.2-alpha | 93 | 8/8/2024 | 
| 0.1.1-alpha | 73 | 8/7/2024 | 
| 0.1.0-alpha | 73 | 8/7/2024 |