Agents.md — Guidance for AI-assisted Development

# Agents.md — Guidance for AI-assisted Development
_An overview of the current repository and its related projects, generated by [AgentPrimer](https://github.com/deanthecoder/AgentPrimer)._
## Summary for Agents
Use this overview as factual context when generating or editing code.  
Avoid unnecessary token use; prefer referencing this document instead of re-parsing source files.
## Agent Instructions (Overview)
- Read this report top-to-bottom to understand the repository structure, technologies, and conventions.
- Look for **Agent note** callouts embedded in specific sections; they contain targeted guidance.
- Keep context usage lean: prefer summaries and interfaces over ingesting full source files.
- Match the English style as reported below.
- Prefer existing frameworks, tests, and naming conventions shown here.
- Check Supported UI Languages when adding UI strings so required translations stay in sync.
- Use the `ripgrep` tool for efficient code searching, if available.
## Repositories (5)
> **Agent note:** Sub-modules and sibling repositories often expose reusable libraries (e.g., extension methods, utilities). Cross-reference these before re-implementing.

  - https://github.com/deanthecoder/G33kBoy   
    Game Boy emulator written in C#.
  - https://github.com/adtennant/GameboyCPUTests (Submodule)  
    Test data for developers of Gameboy emulators.
  - https://github.com/deanthecoder/DTC.Core (Submodule)  
    Core C# library (used by many deanthecoder repos)
  - https://github.com/retrio/gb-test-roms (Submodule)  
    Collection of Game Boy test roms.
  - https://github.com/deanthecoder/DTC.Installer (Submodule)  
    Cross platform script for packaging applications.
## Stats
> **Agent note:** Match the project’s English style for identifiers, comments, and documentation.
> **Agent note:** Use the dominant language(s) and idioms when proposing code.

* Files      : 919
* Languages  : C# (99%)
* English    : American English
## Largest Source Files (8)
> **Agent note:** Avoid ingesting very large files wholesale; focus on public types, key methods, and file headers to preserve tokens.

* 49.99 KB     : `DTC.SM83/Instructions/Instructions.cs`
* 44.20 KB     : `DTC.SM83/Instructions/PrefixedInstructions.cs`
* 43.19 KB     : `DTC.SM83/Devices/ApuDevice.cs`
* 42.88 KB     : `DTC.SM83/PPU.cs`
* 30.00 KB     : `Installer/pack.py`
* 21.53 KB     : `G33kBoy/ViewModels/MainWindowViewModel.cs`
* 19.37 KB     : `DTC.SM83/Devices/BootRom.cs`
* 17.37 KB     : `DTC.Core/DTC.Core/UI/ShaderControl.cs`
## NuGet (18)
> **Agent note:** Prefer solutions using the listed packages and frameworks; avoid introducing new technologies without justification.

* `Avalonia               ` : Avalonia is a cross-platform UI framework for .NET providing a flexible styling system and supporting a wide range of Operating Systems such as Windows, Linux, macOS and with experimental support for Android, iOS and WebAssembly.
* `coverlet.collector     ` : Coverlet is a cross platform code coverage library for .NET, with support for line, branch and method coverage.
* `DialogHost.Avalonia    ` : Avalonia Dialog Host control that provides a simple way to display a dialog with information or prompt the user when information is required
* `DotnetNoise            ` : FastNoise is an open source noise generation library with a large collection of different noise algorithms. This library has been designed for realtime usage from the ground up, so has been optimised for speed without sacrificing noise quality.
* `JetBrains.Annotations  ` : JetBrains.Annotations help reduce false positive warnings, explicitly declare purity and nullability in your code, deal with implicit usages of members, support special semantics of APIs in ASP.NET and XAML frameworks and otherwise increase accuracy of JetBrains Rider and ReSharper code inspections.
* `K4os.Compression.LZ4   ` : Port of LZ4 compression algorithm for .NET
* `Markdig                ` : A fast, powerful, CommonMark compliant, extensible Markdown processor for .NET with 20+ builtin extensions (pipetables, footnotes, definition lists... etc.)
* `Material.Avalonia      ` : This repository is a set of styles that will help you customize your application in an appropriate material design.
* `Material.Icons.Avalonia` : Avalonia control for display material icons from Material.Icons
* `Newtonsoft.Json        ` : Json.NET is a popular high-performance JSON framework for .NET
* `NUnit                  ` : NUnit is a unit-testing framework for all .NET languages.
* `NUnit3TestAdapter      ` : The NUnit3 TestAdapter for Visual Studio, all versions from 2012 and onwards, and DotNet (incl. .Net core), versions .net framework 4.6.2 or higher, .net core 3.1, .net 5 or higher.
* `OpenCvSharp4           ` : OpenCV wrapper for .NET. Since this package includes only core managed libraries, another package of native bindings for your OS is required (OpenCvSharp4.runtime.*).
* `OpenTK.Audio.OpenAL    ` : OpenAL bindings for dotnet from the OpenAL c library.
* `SharpHook              ` : SharpHook provides a cross-platform global keyboard and mouse hook, event simulation, and text entry simulation for .NET.
* `SkiaSharp              ` : SkiaSharp is a cross-platform 2D graphics API for .NET platforms based on Google's Skia Graphics Library.
## Preferences
> **Agent note:** Align with nullable settings, test framework/assertion style, mocking approach, and UI patterns already used in this codebase.

* Nullable : disabled
* Tests    : NUnit
* Mocking  : Unknown
* UI       : Avalonia
## Projects
> **Agent note:** Treat internal projects as core dependencies; follow their naming, layering, and public APIs when extending functionality.

### Top-level
* `G33kBoy.csproj` (net9.0)
* `UnitTests.csproj` (net9.0)
### Internal
* `DTC.Core.csproj` (net8.0) [refs:4]
* `DTC.SM83.csproj` (net9.0) [refs:2]
## READMEs (1238)
> **Agent note:** READMEs often contain background, design intent, and setup steps; consult them when modifying code or documentation.

* `DTC.Core/README.md`
* `Installer/README.md`
* `README.md`
* `external/GameboyCPUTests/README.md`
* `external/GameboyCPUTests/v1/README.md`
* `external/GameboyCPUTests/v2/README.md`