Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #321

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@ Uses [LibCpp2IL](LibCpp2IL) for the initial parsing and loading of metadata stru
build artifacts if you want to do something yourself with IL2CPP metadata, and is released under the MIT license. The
link above will take you to the documentation for LibCpp2IL.

### Development Branch Notes

Cpp2IL is currently undergoing a major rewrite. This branch represents work in progress, and is subject to change.

At present, the ability to dump IL for method bodies has been disabled. If you need this, you can try an [older release](https://github.com/SamboyCoding/Cpp2IL/releases/tag/2022.0.7) (with [older README](https://github.com/SamboyCoding/Cpp2IL/tree/new-analysis)). Support has always been experimental, you may be better off using [il2cppdumper](https://github.com/Perfare/Il2CppDumper?tab=readme-ov-file), then using a dissassembler it makes scripts for.

### Development Branch Notes

CI builds for developers can be obtained from [My Nuget Feed](https://nuget.samboy.dev/).

The command-line interface has been simplified, going from a lot of command line options to a concept of output formats
Expand Down Expand Up @@ -86,9 +88,9 @@ The release files can be downloaded from the Actions tab if you are signed into
which always point to the latest successful CI build. Note that the .NET Framework build is provided for compatibility with
wine/proton.

- [Windows Native Build](https://nightly.link/SamboyCoding/Cpp2IL/workflows/dotnet-core/development/Cpp2IL-net6-win-x64.zip)
- [Linux Native Build](https://nightly.link/SamboyCoding/Cpp2IL/workflows/dotnet-core/development/Cpp2IL-net6-linux-x64.zip)
- [Mac Native Build](https://nightly.link/SamboyCoding/Cpp2IL/workflows/dotnet-core/development/Cpp2IL-net6-osx-x64.zip)
- [Windows Native Build](https://nightly.link/SamboyCoding/Cpp2IL/workflows/dotnet-core/development/Cpp2IL-net7-win-x64.zip)
- [Linux Native Build](https://nightly.link/SamboyCoding/Cpp2IL/workflows/dotnet-core/development/Cpp2IL-net7-linux-x64.zip)
- [Mac Native Build](https://nightly.link/SamboyCoding/Cpp2IL/workflows/dotnet-core/development/Cpp2IL-net7-osx-x64.zip)
- [.NET Framework 4.7.2 Windows Build](https://nightly.link/SamboyCoding/Cpp2IL/workflows/dotnet-core/development/Cpp2IL-Netframework472-Windows.zip)


Expand All @@ -112,7 +114,7 @@ If you do not wish for the output to be coloured, set the Environment Variable `

## Credits

This application is built primarily using .NET 6.0, but a .NET Framework 4.7.2 build is also published for legacy purposes.
This application is built primarily using .NET 7.0, but a .NET Framework 4.7.2 build is also published for legacy purposes.

It uses the following libraries, for which I am very thankful:

Expand All @@ -128,11 +130,6 @@ It uses the following libraries, for which I am very thankful:
- [IndexRange](https://github.com/bgrainger/IndexRange) to port System.Index and System.Range back to netstandard2.0.
- [Nullable](https://github.com/manuelroemer/Nullable) to port nullable attributes back to netstandard2.0.

In addition to the above, the GUI Project uses:
- [Avalonia](https://github.com/AvaloniaUI/Avalonia) as a GUI framework.
- [AvaloniaEdit](https://github.com/AvaloniaUI/AvaloniaEdit/) for the text editor.
- [TextMateSharp](https://github.com/danipen/TextMateSharp) for the syntax highlighting.

Finally, the OrbisPkg plugin uses [LibOrbisPkg](https://github.com/maxton/LibOrbisPkg), which is licensed under the LGPL, version 3.

Cpp2IL is (very loosely, at this point) based off of [Il2CppDumper](https://github.com/Perfare/Il2CppDumper), which I forked
Expand Down