How To Use

Choose your integration:

CLI Tool

Download and run BitMono from the command line.

Download

Get BitMono from GitHub releases:

  • .NET 8 apps: BitMono-v0.25.3-CLI-net8.0-win-x64.zip

  • .NET Framework apps: BitMono-v0.25.3-CLI-net462-win-x64.zip

  • Unity/Mono: Use the .NET Framework version

Usage

BitMono.CLI -f MyApp.exe

More options:

BitMono.CLI -f MyApp.exe -l Dependencies -o MyObfuscatedApp -p FullRenamer,StringEncryption

Available options:

  • -f, --file: File to obfuscate (required)

  • -l, --libraries: Dependencies folder (default: libs)

  • -o, --output: Output folder (default: output)

  • -p, --protections: Which protections to use

  • --protections-file: Custom protections config file

  • --criticals-file: Custom criticals config file

  • --logging-file: Custom logging config file

  • --obfuscation-file: Custom obfuscation config file

  • -n, --output-name: Custom output file name (default: same as input)

  • --no-watermark: Turn off watermarking

  • --strong-name-key: Path to strong name key (.snk) file for assembly signing

Setup

Put your files like this:

my_project/
├── MyApp.exe
└── libs/
    ├── SomeLibrary.dll
    └── AnotherLibrary.dll

The libs folder has your app’s dependencies. BitMono needs these to understand your code.

.NET Global Tool

Install and use BitMono as a global .NET tool.

Installation

dotnet tool install --global BitMono.GlobalTool

Usage

Same as CLI tool, just run BitMono instead of BitMono.CLI.

Configuration

BitMono uses these config files:

protections.json - Which protections to use:

{
  "Protections": [
    {
      "Name": "AntiILdasm",
      "Enabled": false
    },
    {
      "Name": "AntiDe4dot",
      "Enabled": false
    },
    {
      "Name": "FullRenamer",
      "Enabled": true
    },
    {
      "Name": "StringsEncryption",
      "Enabled": false
    },
    {
      "Name": "BitDotNet",
      "Enabled": true
    },
    {
      "Name": "BitMono",
      "Enabled": true
    }
  ]
}

Note

The order of protections in the configuration determines their execution order. Packers (like BitDotNet and BitMono) always run last, regardless of their position in the configuration.

criticals.json - What NOT to obfuscate:

{
  "UseCriticalAttributes": true,
  "CriticalAttributes": [
    {
      "Namespace": "UnityEngine",
      "Name": "SerializeField"
    }
  ],
  "UseCriticalModelAttributes": true,
  "CriticalModelAttributes": [
    {
      "Namespace": "System",
      "Name": "SerializableAttribute"
    }
  ],
  "UseCriticalInterfaces": true,
  "CriticalInterfaces": [
    "IRocketPlugin",
    "IOpenModPlugin"
  ],
  "UseCriticalBaseTypes": true,
  "CriticalBaseTypes": [
    "RocketPlugin*",
    "OpenModUnturnedPlugin*"
  ],
  "UseCriticalMethods": true,
  "CriticalMethods": [
    "Awake",
    "Start",
    "Update",
    "OnDestroy"
  ],
  "UseCriticalMethodsStartsWith": true,
  "CriticalMethodsStartsWith": [
    "OV_"
  ]
}

This file controls what gets excluded from obfuscation:

  • CriticalAttributes - Exclude members with specific attributes

  • CriticalModelAttributes - Exclude types with serialization attributes

  • CriticalInterfaces - Exclude types that inherit specific interfaces

  • CriticalBaseTypes - Exclude types that inherit specific base types (supports glob patterns)

  • CriticalMethods - Exclude methods by exact name

  • CriticalMethodsStartsWith - Exclude methods that start with specific strings

You can use glob patterns (*) in base types and method patterns.

obfuscation.json - General settings:

{
  "Watermark": true,
  "OutputDirectoryName": "output",
  "OutputFileName": null
}

  • OutputFileName: Custom output file name (e.g., "Protected.dll"). When set, uses the exact name ignoring watermark suffix.

Most settings have sensible defaults. You only need to change them if you want something different.

Unity Integration

BitMono includes Unity integration that automatically obfuscates your assemblies during the Unity build process. The integration hooks into Unity’s build pipeline and runs BitMono CLI to protect your game code.

Note

IL2CPP is not supported yet, however is planned to be supported in the future.

Installation

Download the Unity Integration

  1. Go to the latest BitMono release on GitHub

  2. For your Unity version, download the archive with both package formats:

    • File name pattern: BitMono-Unity-v<version>-Unity<unityVersion>.zip

    • Example: BitMono-Unity-v1.2.3-Unity2021.3.45f1.zip

    The archive contains:

    • BitMono-Unity-v<version>-Unity<unityVersion>.unitypackage (classic package)

    • BitMono-Unity-UPM-v<version>-Unity<unityVersion>.tgz (Unity Package Manager tarball)

Install (choose one)

Option A — Import .unitypackage (recommended for most users)

  1. Extract the downloaded .zip

  2. In Unity: Assets → Import Package → Custom Package

  3. Select BitMono-Unity-v<version>-Unity<unityVersion>.unitypackage

  4. Click Import

Option B — Install via Unity Package Manager (UPM)

  1. Extract the downloaded .zip

  2. In Unity: Window → Package Manager

  3. Click the + dropdown → Add package from tarball…

  4. Select BitMono-Unity-UPM-v<version>-Unity<unityVersion>.tgz

  5. Confirm installation

Project Structure

After importing, your project will contain:

Assets/
├── BitMono.Unity/
│   ├── Editor/
│   │   ├── BitMonoBuildProcessor.cs    # Build hook implementation
│   │   ├── BitMonoConfig.cs            # Configuration ScriptableObject
│   │   ├── BitMonoConfigInspector.cs   # Unity Inspector UI
│   │   └── BitMono.Unity.Editor.asmdef # Assembly definition
│   ├── BitMonoConfig.asset             # Your configuration file
│   └── package.json                    # Unity Package Manager metadata
└── BitMono.CLI/
    ├── BitMono.CLI.exe                 # The actual obfuscation tool
    ├── protections.json                # Protection settings
    ├── obfuscation.json                # Obfuscation settings
    └── criticals.json                  # What not to obfuscate

Configuration

  1. In Unity, go to Window → BitMono → Configuration

  2. Check Enable Obfuscation to turn on BitMono

  3. That’s it! BitMono will automatically protect your code during builds

The integration comes with sensible defaults. You only need to change settings if you want something different.

Usage

Just build your project normally:

  1. Go to File → Build Settings → Build

  2. BitMono automatically obfuscates your code during the build

  3. Your final build contains protected code

That’s it! No extra steps needed.

Troubleshooting

For detailed troubleshooting information, see the troubleshooting guide.

NuGet Package Integration (For Developers)

Note

This section is for developers who want to integrate BitMono into their own obfuscation tools or build custom solutions. For regular users, the CLI tool or Unity integration are recommended.

BitMono is also available as NuGet packages, allowing you to integrate obfuscation capabilities directly into your own applications or build custom obfuscation tools.

Available Packages

Core Components:

Host & Utilities:

Configuration

When using NuGet packages, you’ll need to configure BitMono programmatically or through configuration files. See the developer documentation for detailed configuration options.

Dependencies

BitMono NuGet packages may use nightly versions of AsmResolver. If you encounter dependency resolution issues, see the NuGet configuration guide for setup instructions.

Next Steps