Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 2.5 KB

README_CORE.md

File metadata and controls

39 lines (26 loc) · 2.5 KB

Cpp2IL.Core

The magic behind the madness

This project contains all of the logic which makes Cpp2IL work. It's exposed as a set of semi-user-friendly APIs which you can call.

This documentation is work-in-progress.

Initializing the Library

Cpp2IL.Core in turn depends on LibCpp2IL for interactions with the underlying metadata and binary files. For this reason it must be initialized before most of the other APIs can be invoked to give you any useful information.

This can be achieved via the Cpp2IlApi.InitializeLibCpp2Il function, which takes a number of parameters. There are two overloads for this method - one which takes paths to files on disk, and one which takes a byte array of the content of these files (in case you need to pre-process them to decrypt them, for example).

Beyond those two arguments (for the binary and metadata files) there are three further arguments. The first is the unity version as an integer array. For example, [2020, 3, 1] would be valid here. The array must contain at least 3 elements, being the major, minor, and patch versions of unity. Hotfix versions are ignored and are not required. These are used to determine which il2cpp metadata version to use (24.0 through 24.5, and 27.0 through 27.1 are currently supported, i.e. Unity 2018 and up).

If your use case supports it, there is a utility method, Cpp2IlApi.DetermineUnityVersion, which takes two paths on disk - one to the Game's main executable, which is only used if running on windows, and from which the file version is read and parsed, and one to the GameName_Data folder, which is used as a backup on non-windows platforms and from which the unity version will be read from the globalgamemanagers file.

The final two arguments are boolean flags to enable verbose logging, and to allow the user to manually specify the address of the CodeRegistration and MetadataRegistration structs if they cannot be automatically located. It is advised that both of these options be DISABLED (i.e. false) during normal runtime.

Generating "Dummy" Assemblies

This function requires the library to be initialized.

There is a single function, Cpp2IlApi.MakeDummyDLLs, which takes no arguments and generates + returns a List of Cecil AssemblyDefinitions which you can (but are not required to) use for your own purposes.

These assemblies contain the full type model of the il2cpp application, with all Types, Fields, Properties, Events, and Methods present.

However, the generated methods do NOT have a body (besides a stub one).