Skip to content

Project Structure

Astral✨ edited this page Feb 1, 2025 · 2 revisions
/
β”œβ”€β”€ .github                                 # GitHub Config Files
β”‚   β”œβ”€β”€ ISSUE_TEMPLATE                      # Issue Templates
β”‚   β”œβ”€β”€ workflows                           # Workflow to build the project after every commit
β”‚   β”œβ”€β”€ CONTRIBUTING.md                     # Contribution Guidelines
β”‚   └── PULL_REQUEST_TEMPLATE.md            # Pull Request Template
β”œβ”€β”€ src
β”‚Β Β  β”œβ”€β”€ AUnlocker.cs                        # Main Mod File where Harmony is initialized to apply all patches
β”‚Β Β  β”œβ”€β”€ AUnlocker.csproj                    # C# Project File, contains PackageReferences and project info
β”‚Β Β  β”œβ”€β”€ AccoutPatches.cs                    # Code to patch Account-related features
β”‚Β Β  β”œβ”€β”€ ChatPatches.cs                      # Code to patch Chat-related features
β”‚Β Β  β”œβ”€β”€ CosmeticsPatches.cs                 # Code to patch Cosmetics-related features
β”‚Β Β  └── OtherPatches.cs                     # Code to patch other features
β”œβ”€β”€ .gitignore                              # Specifies untracked files that git should ignore
β”œβ”€β”€ AUnlocker.sln                           # Microsoft Visual Studio Solution file
β”œβ”€β”€ LICENSE                                 # License
β”œβ”€β”€ README.md                               # Information on Features, Releases and Installation
β”œβ”€β”€ build.cake                              # Build Script for GitHub actions (build automation)
β”œβ”€β”€ icon.png                                # Banner Image displayed on README.md
└── nuget.config                            # Configure NuGet package sources 

Releases:

/
β”œβ”€β”€ BepInEx
β”‚   β”œβ”€β”€ core                                # Core BepInEx assemblies
β”‚   β”œβ”€β”€ config                              # Config files, where AUnlocker.cfg is located. This folder is generated the first time you run the game.
β”‚   β”œβ”€β”€ patchers                            # Preload-time patchers that modify assemblies before the game loads them. More info: https://docs.bepinex.dev/articles/dev_guide/preloader_patchers.html
β”‚   └── plugins                             # Installed mod dlls (including AUnlocker.dll)
β”œβ”€β”€ dotnet                                  # .NET runtime files. BepInEx runs on the .NET Framework.
β”œβ”€β”€ .doorstop_version                       # Tells you which version of Doorstop is installed
β”œβ”€β”€ changelog.txt                           # Info on which BepInEx version you have and what has been changed
β”œβ”€β”€ doorstop_config.ini                     # Configuration for Doorstop
β”œβ”€β”€ steam_appid.txt                         # With this, you can launch the game from the .exe
└── winhttp.dll                             # Unity Doorstop, used to run C# code before Unity. It uses DLL Hijacking by overriding the system winhttp library. 
Clone this wiki locally