SabreTools/BinaryObjectScanner
1
0
Fork 0
mirror of https://github.com/SabreTools/BinaryObjectScanner.git synced 2026-02-04 05:35:49 +00:00
Code Issues 295 Packages Projects Releases 20 Wiki Activity

Slight documentation cleanup

Browse Source
This commit is contained in:
Matt Nadareski
2025-09-21 18:59:29 -04:00
parent 18ce24400a
commit b06512e292
2 changed files with 0 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
Coding Guide.md
View File

@@ -358,7 +358,6 @@ This section contains information on project and class organization principles t
| Project | Description | | Project | Description |
| --- | --- | | --- | --- |
| `BinaryObjectScanner` | One file per class. See below for details on subdirectories. | | `BinaryObjectScanner` | One file per class. See below for details on subdirectories. |
| `BinaryObjectScanner/_EXTERNAL` | One directory per external project. |
| `BinaryObjectScanner/FileType` | One file per file type. | | `BinaryObjectScanner/FileType` | One file per file type. |
| `BinaryObjectScanner/GameEngine` | At least one file per game engine. Partial classes allowed. | | `BinaryObjectScanner/GameEngine` | At least one file per game engine. Partial classes allowed. |
| `BinaryObjectScanner/Interfaces` | One file per interface. | | `BinaryObjectScanner/Interfaces` | One file per interface. |

1
Developer Guide.md
View File

@@ -22,7 +22,6 @@ Researching copy protections and packers can be a massive undertaking. Some can
| Tool / Method | Description | | Tool / Method | Description |
| --- | --- | | --- | --- |
| `InfoPrint.exe [--json] <path>` | The `--info` option on the test executable is a really good way of getting started with investigation. The output of `InfoPrint` contains nearly all immediately parsable information from any executable that has a wrapper defined in `BinaryObjectScanner.Wrappers`. In general, the newer the executable format, the more information will be immediately available. For the most basic of protections and packers, this may be as far as you need to go for your research. Additionally, the `--json` flag allows for a formatted JSON output of the information for later parsing. This is only available in .NET 6+ builds. |
| `ProtectionScan.exe [--debug] <path>` | Running `ProtectionScan.exe` without any options runs the existing set of packer and protection checks. The output of this will be all detected packers and protections on the given file, with optional debug information where applicable. This is helpful in research because a protection you are investigating may be related to (or obscured by) another existing packer or protection. Having this information will make it easier to filter the results of `InfoPrint.exe <path>` as well. | | `ProtectionScan.exe [--debug] <path>` | Running `ProtectionScan.exe` without any options runs the existing set of packer and protection checks. The output of this will be all detected packers and protections on the given file, with optional debug information where applicable. This is helpful in research because a protection you are investigating may be related to (or obscured by) another existing packer or protection. Having this information will make it easier to filter the results of `InfoPrint.exe <path>` as well. |
| **Add and debug** | This starts getting into more serious territory. Creating a skeleton for the packer or protection that you want to add and then messing around in code is a great way to start seeing what sort of stuff the library can see that's not normally output. See the table below for extension properties and methods that you may use in addition to the models defined in `BinaryObjectScanner.Models`. | | **Add and debug** | This starts getting into more serious territory. Creating a skeleton for the packer or protection that you want to add and then messing around in code is a great way to start seeing what sort of stuff the library can see that's not normally output. See the table below for extension properties and methods that you may use in addition to the models defined in `BinaryObjectScanner.Models`. |
| **Hex Editor / External Programs** | As an advanced port of call, using a hex editor and external protection scanning programs (sometimes in conjunction) can help you get a better idea of the protection you're looking into. For example, **TheRogueArchivist** used that combination to narrow down the exact check for a very stubborn protection. | | **Hex Editor / External Programs** | As an advanced port of call, using a hex editor and external protection scanning programs (sometimes in conjunction) can help you get a better idea of the protection you're looking into. For example, **TheRogueArchivist** used that combination to narrow down the exact check for a very stubborn protection. |