spt/assembly-tool
spt/assembly-tool
0
0
Fork 0
mirror of https://github.com/sp-tarkov/assembly-tool.git synced 2025-02-12 13:50:44 -05:00
Code

update README.md

Browse Source
This commit is contained in:
Cj 2025-01-12 01:05:21 -05:00
parent 632fe1bb5e
commit 20ae0c532d
1 changed files with 32 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -1,9 +1,22 @@
# Assembly Tool Command Line
# Commands
This is the command line interface for assembly tool. It can be used to de-obfuscate, re-map, and other smaller utilities.
It can be placed on the system path and accessed from anywhere.
- `addmissingproperties` - This command will add missing properties to the provided mapping.json.
- Param `MappingsPath` - Path to the mapping.json file to be fixed
## Commands
- Note: This is a development command and should not be used unless you know what you're doing. Always make backups when using this command.
---
- `automatch` - This command will Automatically try to generate a mapping object given old type and new type names.
- Param `AssemblyPath` - The absolute path to your assembly, folder must contain all references to be resolved.
- Param `MappingsPath` - Path to your mapping file so it can be updated if a match is found.
- Param `OldTypeName` - Full old type name including namespace `Foo.Bar` for nested classes `Foo.Bar/FooBar`
- Param `NewTypeName` - The name you want the type to be renamed to.
- This command will prompt you to append your created mapping to the mapping file.
- It will then prompt you to run the remap process.
---
- `deobfuscate` - This command will run the de4dot de-obfuscater over the assembly provided. It supports both the
primary game assembly and the launcher assembly.
@ -13,20 +26,9 @@ references needed to be resolved.
---
- `automatch` - This command will Automatically try to generate a mapping object given old type and new type names.
- `AssemblyPath` - The absolute path to your assembly, folder must contain all references to be resolved.
- `MappingsPath` - Path to your mapping file so it can be updated if a match is found.
- `OldTypeName` - Full old type name including namespace.
- `NewTypeName` - The name you want the type to be renamed to.
- This command will prompt you to append your created mapping to the mapping file.
- It will then prompt you to run the remap process.
---
- `remap` - Generates a re-mapped dll provided a mapping file and dll. If the dll is obfuscated, it will automatically de-obfuscate.
- Param `MappingJsonPath` - The absolute path to the `mapping.json` file supports both `json` and `jsonc`.
- Param `AssemblyPath` - The absolute path to the dll generated from the `deobfuscate` command.
- `Dumper` - Generates a dumper zip.
- Param `ManagedDirectory` - The absolute path to your Managed folder for EFT, folder must contain all references to
be resolved. Assembly-CSharp-cleaned.dll, mscorlib.dll, FilesChecker.dll
---
@ -35,6 +37,15 @@ references needed to be resolved.
---
- `Dumper` - Generates a dumper zip.
- Param `ManagedDirectory` - The absolute path to your Managed folder for EFT, folder must contain all references to
be resolved. Assembly-CSharp-cleaned.dll, mscorlib.dll, FilesChecker.dll
- `regensig` - regenerates the signature of a mapping if it is failing
- Param `MappingPath` - The absolute path to mapping.json.
- Param `AssemblyPath` - The absolute path to the assembly you want to regenerate the signature for.
- Param `NewTypeName` - The new type name as listed in the mapping file.
- Param `OldTypeName` - Full old type name including namespace `Foo.Bar` for nested classes `Foo.Bar/FooBar`
---
- `remap` - Generates a re-mapped dll provided a mapping file and dll. If the dll is obfuscated, it will automatically de-obfuscate.
- Param `MappingJsonPath` - The absolute path to the `mapping.json` file supports both `json` and `jsonc`.
- Param `AssemblyPath` - The absolute path to the dll generated from the `deobfuscate` command.