You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

92 lines
7.8 KiB

8 years ago
  1. # ILSpy [![NuGet](https://img.shields.io/nuget/v/ICSharpCode.Decompiler.svg)](https://nuget.org/packages/ICSharpCode.Decompiler) ![Build ILSpy](https://github.com/icsharpcode/ILSpy/workflows/Build%20ILSpy/badge.svg?branch=master) [![Mastodon](https://img.shields.io/badge/dynamic/json?label=Mastodon&query=totalItems&url=https%3A%2F%2Fhachyderm.io%2Fusers%2Filspy%2Ffollowers.json&logo=mastodon&style=flat-square)](https://hachyderm.io/@ilspy) [![Bluesky](https://img.shields.io/badge/Bluesky-0285FF?logo=bluesky&logoColor=fff)](https://bsky.app/profile/ilspy.bsky.social) [![ILSpy VS extension](https://img.shields.io/badge/VS%20Extension-ILSpy-blue.svg)](https://visualstudiogallery.msdn.microsoft.com/8ef1d688-f80c-4380-8004-2ec7f814e7de)
  2. ILSpy is the open-source .NET assembly browser and decompiler.
  3. Download: [latest release](https://github.com/icsharpcode/ILSpy/releases) | [latest CI build (master)](https://github.com/icsharpcode/ILSpy/actions?query=workflow%3A%22Build+ILSpy%22+branch%3Amaster+is%3Asuccess+event%3Apush) | [Microsoft Store (RTM versions only)](https://apps.microsoft.com/store/detail/ilspy-fresh/XP8C26VDWLP4T4)
  4. Decompiler Frontends
  5. -------
  6. Aside from the WPF UI ILSpy (downloadable via Releases, see also [plugins](https://github.com/icsharpcode/ILSpy/wiki/Plugins)), the following other frontends are available:
  7. * Visual Studio 2022 ships with decompilation support for F12 enabled by default (using our engine v8.1).
  8. * In Visual Studio 2019, you have to manually enable F12 support. Go to Tools / Options / Text Editor / C# / Advanced and check "Enable navigation to decompiled source"
  9. * [C# for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) ships with decompilation support as well. To enable, activate the setting "Enable Decompilation Support".
  10. * Our Visual Studio 2022 extension [marketplace](https://marketplace.visualstudio.com/items?itemName=SharpDevelopTeam.ILSpy2022)
  11. * Our Visual Studio 2017/2019 extension [marketplace](https://marketplace.visualstudio.com/items?itemName=SharpDevelopTeam.ILSpy)
  12. * Our Visual Studio Code Extension [repository](https://github.com/icsharpcode/ilspy-vscode) | [marketplace](https://marketplace.visualstudio.com/items?itemName=icsharpcode.ilspy-vscode)
  13. * Our Linux/Mac/Windows ILSpy UI based on [Avalonia](http://www.avaloniaui.net/) - check out https://github.com/icsharpcode/AvaloniaILSpy
  14. * Our [ICSharpCode.Decompiler](https://www.nuget.org/packages/ICSharpCode.Decompiler/) NuGet for your own projects
  15. * Our dotnet tool for Linux/Mac/Windows - check out [ILSpyCmd](ICSharpCode.ILSpyCmd) in this repository
  16. * Our Linux/Mac/Windows [PowerShell cmdlets](ICSharpCode.Decompiler.PowerShell) in this repository
  17. Features
  18. -------
  19. * Decompilation to C# (check out the [language support status](https://github.com/icsharpcode/ILSpy/issues/829))
  20. * Whole-project decompilation
  21. * Search for types/methods/properties (learn about the [options](https://github.com/icsharpcode/ILSpy/wiki/Search-Options))
  22. * Hyperlink-based type/method/property navigation
  23. * Base/Derived types navigation, history
  24. * Assembly metadata explorer ([feature walkthrough](https://github.com/icsharpcode/ILSpy/wiki/Metadata-Explorer))
  25. * BAML to XAML decompiler
  26. * ReadyToRun binary support for .NET Core (see the [tutorial](https://github.com/icsharpcode/ILSpy/wiki/ILSpy.ReadyToRun))
  27. * Extensible via [plugins](https://github.com/icsharpcode/ILSpy/wiki/Plugins)
  28. * Additional features in DEBUG builds ([for the devs](https://github.com/icsharpcode/ILSpy/wiki/Additional-Features-in-DEBUG-Builds))
  29. License
  30. -------
  31. ILSpy is distributed under the MIT License. Please see the [About](doc/ILSpyAboutPage.txt) doc for details,
  32. as well as [third party notices](doc/third-party-notices.txt) for included open-source libraries.
  33. How to build
  34. ------------
  35. #### Windows:
  36. - Make sure Windows PowerShell (at least version) 5.0 or [PowerShell](https://github.com/PowerShell/PowerShell) 7+ is installed.
  37. - Clone the ILSpy repository using git.
  38. - Execute `git submodule update --init --recursive` to download the ILSpy-Tests submodule (used by some test cases).
  39. - Install Visual Studio (documented version: 17.8). You can install the necessary components in one of 3 ways:
  40. - Follow Microsoft's instructions for [importing a configuration](https://docs.microsoft.com/en-us/visualstudio/install/import-export-installation-configurations?view=vs-2022#import-a-configuration), and import the .vsconfig file located at the root of the solution.
  41. - Alternatively, you can open the ILSpy solution (ILSpy.sln) and Visual Studio will [prompt you to install the missing components](https://docs.microsoft.com/en-us/visualstudio/install/import-export-installation-configurations?view=vs-2022#automatically-install-missing-components).
  42. - Finally, you can manually install the necessary components via the Visual Studio Installer. The workloads/components are as follows:
  43. - Workload ".NET Desktop Development". This workload includes the .NET Framework 4.8 SDK and the .NET Framework 4.7.2 targeting pack, as well as the [.NET 8.0 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) (ILSpy.csproj targets .NET 8.0, but we have net472 projects too). _Note: The optional components of this workload are not required for ILSpy_
  44. - Workload "Visual Studio extension development" (ILSpy.sln contains a VS extension project) _Note: The optional components of this workload are not required for ILSpy_
  45. - Individual Component "MSVC v143 - VS 2022 C++ x64/x86 build tools" (or similar)
  46. - _The VC++ toolset is optional_; if present it is used for `editbin.exe` to modify the stack size used by ILSpy.exe from 1MB to 16MB, because the decompiler makes heavy use of recursion, where small stack sizes lead to problems in very complex methods.
  47. - Open ILSpy.sln in Visual Studio.
  48. - NuGet package restore will automatically download further dependencies
  49. - Run project "ILSpy" for the ILSpy UI
  50. - Use the Visual Studio "Test Explorer" to see/run the tests
  51. - If you are only interested in a specific subset of ILSpy, you can also use
  52. - ILSpy.Wpf.slnf: for the ILSpy WPF frontend
  53. - ILSpy.XPlat.slnf: for the cross-platform CLI or PowerShell cmdlets
  54. - ILSpy.AddIn.slnf: for the Visual Studio plugin
  55. **Note:** Visual Studio includes a version of the .NET SDK that is managed by the Visual Studio installer - once you update, it may get upgraded too.
  56. Please note that ILSpy is only compatible with the .NET 8.0 SDK and Visual Studio will refuse to load some projects in the solution (and unit tests will fail).
  57. If this problem occurs, please manually install the .NET 8.0 SDK from [here](https://dotnet.microsoft.com/download/dotnet/8.0).
  58. #### Unix / Mac:
  59. - Make sure [.NET 8.0 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) is installed.
  60. - Make sure [PowerShell](https://github.com/PowerShell/PowerShell) is installed (formerly known as PowerShell Core)
  61. - Clone the repository using git.
  62. - Execute `git submodule update --init --recursive` to download the ILSpy-Tests submodule (used by some test cases).
  63. - Use `dotnet build ILSpy.XPlat.slnf` to build the non-Windows flavors of ILSpy (.NET Core Global Tool and PowerShell Core).
  64. How to contribute
  65. -----------------
  66. - Report bugs
  67. - If you want to contribute a pull request, please add https://github.com/icsharpcode/ILSpy/blob/master/BuildTools/pre-commit to your `.git/hooks` to prevent checking in code with wrong formatting. We use tabs and not spaces. The build server runs the same script, so any pull requests using wrong formatting will fail.
  68. Current and past [contributors](https://github.com/icsharpcode/ILSpy/graphs/contributors).
  69. Privacy Policy for ILSpy
  70. ------------------------
  71. ILSpy does not collect any personally identifiable information, nor does it send user files to 3rd party services.
  72. ILSpy does not use any APM (Application Performance Management) service to collect telemetry or metrics.