Skip to content

Commit df52d08

Browse files
committed
Update readme, remove unused cases
1 parent 66d48ed commit df52d08

File tree

2 files changed

+43
-46
lines changed

2 files changed

+43
-46
lines changed

BinaryObjectScanner/Scanner.cs

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -457,10 +457,8 @@ private static List<string> PerformPathCheck(IPathCheck impl, string? path, List
457457
{
458458
case AACSMediaKeyBlock obj: return new FileType.AACSMediaKeyBlock(obj);
459459
case BDPlusSVM obj: return new FileType.BDPlusSVM(obj);
460-
// case CIA obj => new FileType.CIA(obj),
461460
case LinearExecutable obj: return new FileType.LinearExecutable(obj);
462461
case MSDOS obj: return new FileType.MSDOS(obj);
463-
// case N3DS obj: return new FileType.N3DS(obj);
464462
case NewExecutable obj: return new FileType.NewExecutable(obj);
465463
case PlayJAudioFile obj: return new FileType.PLJ(obj);
466464
case PortableExecutable obj: return new FileType.PortableExecutable(obj);
@@ -469,9 +467,7 @@ private static List<string> PerformPathCheck(IPathCheck impl, string? path, List
469467
// Fall back on the file type for types not implemented in Serialization
470468
return fileType switch
471469
{
472-
// WrapperType.CIA => new FileType.CIA(),
473470
WrapperType.LDSCRYPT => new FileType.LDSCRYPT(),
474-
// WrapperType.N3DS => new FileType.N3DS(),
475471
WrapperType.RealArcadeInstaller => new FileType.RealArcadeInstaller(),
476472
WrapperType.RealArcadeMezzanine => new FileType.RealArcadeMezzanine(),
477473
WrapperType.SFFS => new FileType.SFFS(),

README.md

Lines changed: 43 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,17 @@ For the most recent stable build, download the latest release here: [Releases Pa
2121

2222
For the latest WIP build here: [Rolling Release](https://github.com/SabreTools/BinaryObjectScanner/releases/tag/rolling)
2323

24-
**NOTE**: If you used the executable information printing functionality in previous releases, that has been extracted as a separate program and included in the [SabreTools.Serialization repository](https://github.com/SabreTools/SabreTools.Serialization). It was formerly included there as a reference program but has since been renamed to **InfoPrint**. This was done to ensure that the latest information printing would be available instead of waiting for it to bubble up to BinaryObjectScanner.
24+
**NOTE**: If you used the extraction functionality in previous releases, that has been separated into a standalone program called **[ExtractionTool](https://github.com/SabreTools/SabreTools.Serialization)**.
25+
26+
**NOTE**: If you used the information printing functionality in previous releases, that has been separated into a standalone program called **[InfoPrint](https://github.com/SabreTools/SabreTools.Serialization)**.
2527

2628
## Compatibility Notes
2729

2830
Binary Object Scanner strives to have both full compatibility for scanning across .NET versions as well as across OSes. Unfortunately, this is not always the case. Please see the below list for known compatibility issues.
2931

3032
- **7-zip archive** - Extraction is only supported on .NET Framework 4.6.2 and higher due to `SharpCompress` support limitations
3133
- **bzip2 archive** - Extraction is only supported on .NET Framework 4.6.2 and higher due to `SharpCompress` support limitations
32-
- **MoPaQ** - Extraction is only supported in Windows x86 builds running .NET Framework 4.5.2 and higher due to native DLL requirements
34+
- **MoPaQ** - Extraction is only supported in Windows x86 and x64 builds running .NET Framework 4.5.2 and higher due to native DLL requirements
3335
- **PKZIP and derived files (ZIP, etc.)** - Extraction is only supported on .NET Framework 4.6.2 and higher due to `SharpCompress` support limitations
3436
- **RAR archive** - Extraction is only supported on .NET Framework 4.6.2 and higher due to `SharpCompress` support limitations
3537
- **xz archive** - Extraction is only supported on .NET Framework 4.6.2 and higher due to `SharpCompress` support limitations
@@ -194,50 +196,49 @@ Below is a list of game engines detected by BinaryObjectScanner. The two columns
194196

195197
Below is a list of container formats that are supported in some way:
196198

197-
| Format Name | Information Printing | Detection | Extraction | Notes |
198-
| --- | --- | --- | --- | --- |
199-
| 7-zip archive | No | Yes | Yes | Via `SharpCompress` |
200-
| AACS Media Key Block | Yes | Yes | N/A | BluRay and HD-DVD variants detected |
201-
| BD+ SVM | Yes | Yes | N/A | |
202-
| BFPK custom archive format | Yes | Yes | Yes | |
203-
| bzip2 archive | No | Yes | Yes | Via `SharpCompress` |
204-
| Compound File Binary (CFB) | Yes* | Yes | Yes | Only CFB common pieces printable |
205-
| gzip archive | No | Yes | Yes | |
206-
| Half-Life Game Cache File (GCF) | Yes | Yes | Yes | |
207-
| Half-Life Level (BSP) | Yes | Yes | Yes | |
208-
| Half-Life Package File (PAK) | Yes | Yes | Yes | |
209-
| Half-Life Texture Package File (WAD3) | Yes | Yes | Yes | |
210-
| Half-Life 2 Level (VBSP) | Yes | Yes | Yes | |
211-
| INI configuration file | No | No | No | Used in other detections currently |
212-
| InstallShield Archive V3 (Z) | No | Yes | Yes | |
213-
| InstallShield CAB | Yes | Yes | Yes | |
214-
| Linear Executable | No | No | No | Skeleton only |
215-
| Link Data Security encrypted file | No | Yes | No | |
216-
| Microsoft cabinet file | Yes | Yes | Yes* | Does not support LZX or Quantum compression |
217-
| Microsoft LZ-compressed files | No | Yes | Yes | |
218-
| MoPaQ game data archive (MPQ) | No | Yes | Yes* | Via `StormLibSharp`, Windows x86 only, .NET Framework 4.5.2 and above |
219-
| MS-DOS Executable | Yes | Yes | No | Incomplete |
220-
| New Exectuable | Yes | Yes | No | Incomplete |
221-
| Nintendo 3DS cart image | Yes | Yes | No | |
222-
| Nintendo CIA archive | Yes | Yes | No | |
223-
| Nintendo DS/DSi cart image | Yes | Yes | No | |
224-
| NovaLogic Game Archive Format (PFF) | Yes | Yes | Yes | |
225-
| PKZIP and derived files (ZIP, etc.) | No | Yes | Yes | Via `SharpCompress` |
226-
| PlayJ audio file (PLJ) | Yes* | Yes | No | Undocumented file format, many fields printed |
227-
| Portable Executable | Yes | Yes | No* | Some packed executables are supported |
228-
| Quantum archive (Q) | Yes | No | No | |
229-
| RAR archive (RAR) | No | Yes | Yes | Via `SharpCompress` |
230-
| SGA game archive | Yes | Yes | Yes | |
231-
| StarForce Filesystem file (SFFS) | No | Yes | No | Skeleton only |
232-
| Tape archive (TAR) | No | Yes | Yes | |
233-
| Valve Package File (VPK) | Yes | Yes | Yes | |
234-
| XBox Package File (XZP) | Yes | Yes | Yes | |
235-
| xz archive (XZ) | No | Yes | Yes | Via `SharpCompress` |
199+
| Format Name | Reported | Extracted | Notes |
200+
| --- | --- | --- | --- |
201+
| 7-zip archive | No | Yes | Via `SharpCompress` |
202+
| AACS Media Key Block | Yes | N/A | BluRay and HD-DVD variants detected |
203+
| BD+ SVM | Yes | N/A | |
204+
| BFPK custom archive format | No | Yes | |
205+
| bzip2 archive | No | Yes | Via `SharpCompress` |
206+
| Compound File Binary (CFB) | No | Yes | |
207+
| gzip archive | No | Yes | |
208+
| Half-Life Game Cache File (GCF) | No | Yes | |
209+
| Half-Life Level (BSP) | No | Yes | |
210+
| Half-Life Package File (PAK) | No | Yes | |
211+
| Half-Life Texture Package File (WAD3) | No | Yes | |
212+
| Half-Life 2 Level (VBSP) | No | Yes | |
213+
| INI configuration file | No | N/A | Used in other detections currently |
214+
| InstallShield Archive V3 (Z) | No | Yes | |
215+
| InstallShield CAB | No | Yes | |
216+
| Linear Executable | No* | No | No existing checks |
217+
| Link Data Security encrypted file | Yes | No | |
218+
| Microsoft cabinet file | No | Yes* | Does not support LZX or Quantum compression |
219+
| Microsoft LZ-compressed files | No | Yes | |
220+
| MoPaQ game data archive (MPQ) | No | Yes* | Via `StormLibSharp` |
221+
| MS-DOS Executable | No* | No | No existing checks |
222+
| New Exectuable | Yes | Yes | Subset of extractions implemented |
223+
| NovaLogic Game Archive Format (PFF) | No | Yes | |
224+
| PKZIP and derived files (ZIP, etc.) | No | Yes | Via `SharpCompress` |
225+
| PlayJ audio file (PLJ) | Yes | No | Undocumented file format |
226+
| Portable Executable | Yes | Yes | Subset of extractions implemented |
227+
| Quantum archive (Q) | No | No | Extraction disabled due to compatibility issues |
228+
| RAR archive (RAR) | No | Yes | Via `SharpCompress` |
229+
| RealArcade Installer (.rgs) | Yes | No | |
230+
| RealArcade Mezzanine (.mez) | Yes | No | |
231+
| SGA game archive | No | Yes | |
232+
| StarForce Filesystem file (SFFS) | Yes | No | |
233+
| Tape archive (TAR) | No | Yes | |
234+
| Valve Package File (VPK) | No | Yes | |
235+
| XBox Package File (XZP) | No | Yes | |
236+
| xz archive (XZ) | No | Yes | Via `SharpCompress` |
236237

237238
## Contributions
238239

239240
Contributions to the project are welcome. Please follow the current coding styles and please do not add any keys or legally dubious things to the code. Thank you to all of the testers, particularly from the MPF project who helped get this rolling.
240241

241242
## Special Thanks
242243

243-
I want to give a special thanks to [TheRogueArchivist](https://github.com/TheRogueArchivist) who has gone above and beyond helping both fix existing checks as well as add new ones.
244+
I want to give a special thanks to [TheRogueArchivist](https://github.com/TheRogueArchivist) and [HeroponRikiBestest](https://github.com/HeroponRikiBestest) who have gone above and beyond helping both fix existing checks as well as add new ones.

0 commit comments

Comments
 (0)