Open Sesame Compiler For Unity === A custom Roslyn compiler and editor extension to access internals/privates for Unity. In other words, you can access to **any internals/privates** in other assemblies, **without reflection**. Let's say, **"Open sesame!"** ![](https://user-images.githubusercontent.com/12690315/71837979-255d0880-30fb-11ea-99bc-3bb96b77cfa6.gif) ![](https://user-images.githubusercontent.com/12690315/70616819-a804bc00-1c52-11ea-8ea3-e24f94f6467d.gif) [![](https://camo.githubusercontent.com/40130808d6321a2c331a79e1057be8ad2e18293b/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f636f6d2e636f666665652e6f70656e2d736573616d652d636f6d70696c65723f6c6162656c3d6f70656e75706d2672656769737472795f7572693d68747470733a2f2f7061636b6167652e6f70656e75706d2e636f6d)](https://openupm.com/packages/com.coffee.open-sesame-compiler/) [![](https://camo.githubusercontent.com/9699b5ad4093c64150c5431ccd234077a587456e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f6d6f622d73616b61692f4f70656e536573616d65436f6d70696c6572466f72556e6974793f696e636c7564655f70726572656c6561736573)](https://github.com/mob-sakai/OpenSesameCompilerForUnity/releases) << [Description](https://github.com/mob-sakai/OpenSesameCompilerForUnity/raw/upm/#description) | [Installation](https://github.com/mob-sakai/OpenSesameCompilerForUnity/raw/upm/#installation) | [Usage](https://github.com/mob-sakai/OpenSesameCompilerForUnity/raw/upm/#usage) | [Contributing](https://github.com/mob-sakai/OpenSesameCompilerForUnity/raw/upm/#contributing) >> ### What's new? [See changelog ](https://github.com/mob-sakai/OpenSesameCompilerForUnity/blob/upm/CHANGELOG.md) ### Do you want to receive notifications for new releases? [Watch this repo ](https://github.com/mob-sakai/OpenSesameCompilerForUnity/subscription) ### Support me on GitHub! [![become_a_sponsor_on_github](https://user-images.githubusercontent.com/12690315/66942881-03686280-f085-11e9-9586-fc0b6011029f.png)](https://github.com/users/mob-sakai/sponsorship)

## Description > _Then Ali Baba climbed down and went to the door concealed among the bushes, and said, "Open, Sesame!" and it flew open._ This package allows to access to **any internals/privates** in other assemblies, **without reflection**. For details about `IgnoresAccessChecksToAttribute`, see [No InternalsVisibleTo, no problem – bypassing C# visibility rules with Roslyn](https://www.strathweb.com/2018/10/no-internalvisibleto-no-problem-bypassing-c-visibility-rules-with-roslyn/). #### Features * Easy to use * this package is out of the box. * Allow to access to any internal/private elements (types/members) in other assemblies, **without reflection** * Create instance * Get/set fields or properties * Call method * Create extension method that contains private access * etc. * Processes only `AssemblyDefinitionFile` you configured * Add/remove the scripting define symbols for each `AssemblyDefinitionFiles` * Support C#8 * Support `.Net 3.5`, `.Net 4.x` and `.Net Standard 2.0` * `dotnet` is not required * Publish as dll * Published dll works **without this package**. * Portable mode * Without publishing, make the assembly available to access to internals/privates in other assemblies, even in projects that do not have this package installed. * The best option when distributing as a package. #### NOTE: Unsupported Features * Set/get value into readonly field * Use reflection * IDE support * Use [Csc-Manager](https://github.com/pCYSl5EDgo/Csc-Manager) to modify your [VisualStudio Code](https://code.visualstudio.com/download) and [C# extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp). * `csc-manager enable-vscode`: Show internals/privates in other assembly. * `csc-manager disable-vscode`: Hide them.

## Installation #### Requirement * Unity 2018.3 or later #### Using OpenUPM This package is available on [OpenUPM](https://openupm.com). You can install it via [openupm-cli](https://github.com/openupm/openupm-cli). ``` openupm add com.coffee.open-sesame-compiler ``` #### Using Git Find the `manifest.json` file in the `Packages` directory in your project and edit it to look like this: ```json { "dependencies": { "com.coffee.open-sesame-compiler": "https://github.com/mob-sakai/OpenSesameCompilerForUnity.git", ... }, } ``` To update the package, change suffix `#{version}` to the target version. * e.g. `"com.coffee.open-sesame-compiler": "https://github.com/mob-sakai/OpenSesameCompilerForUnity.git#1.0.0",` Or, use [UpmGitExtension](https://github.com/mob-sakai/UpmGitExtension) to install and update the package.

## Usage 1. Select a `AssemblyDefinitionFile` in project view 2. Configure setting for the assembly in inspector view: ![](https://user-images.githubusercontent.com/12690315/73439891-bab68a00-4393-11ea-9928-a286c9c3e6e0.png) * **Open Sesame**: Use OpenSesameCompiler instead of default csc to compile this assembly. In other words, allow this assembly to access to internals/privates to other assemblies without reflection. * **Settings**: how/hide the detail settings for this assembly. * **Modify Symbols**: When compiling this assembly, add/remove semicolon separated symbols. Symbols starting with '!' will be removed. **NOTE: This feature is available even when 'Open Sesame' is disabled** * **Portable Mode**: Make this assembly available to access in internals/privates to other assemblies, even in projects that do not have `Open Sesame Compiler` package installed. * **Publish**: Publish this assembly as dll to the parent directory. * **Help**: Open help page on browser. 1. Enjoy!

## Demo 1. Clone demo branch in this repo and open it with Unity 2018.3 or later ``` git clone -b demo https://github.com/mob-sakai/OpenSesameCompilerForUnity.git ``` 2. The project has some inaccessible compilation errors ![](https://user-images.githubusercontent.com/12690315/71837690-6274cb00-30fa-11ea-949f-5f60b1a1dbcd.png) 3. Do not worry, they are proper errors. The demo project access to internals/privates: ```cs // EditorApplication.CallDelayed is an internal-static method in UnityEditor assembly. EditorApplication.CallDelayed(() => Debug.Log("delayed"), 1); ``` 4. Select `Assets/Tests/Coffee.OpenSesame.Test.asmdef` in project view and activate 'Open Sesame' in inspector view ![](https://user-images.githubusercontent.com/12690315/71837979-255d0880-30fb-11ea-99bc-3bb96b77cfa6.gif) 5. Run all edit mode tests in test runner view (`Windows > General > Test Runner`). The compilation error is gone, but some tests that depend on symbols will not pass. ![](https://user-images.githubusercontent.com/12690315/71838489-483bec80-30fc-11ea-9af4-83e2ddd7d894.png) ```cs [Test] public void DefineSymbols() { const string log = "OSC_TEST is defined."; LogAssert.Expect(LogType.Log, log); #if OSC_TEST // <- not defined! Debug.Log(log); #endif } [Test] public void RemoveSymbols() { const string log = "TRACE is not defined."; LogAssert.Expect(LogType.Log, log); #if !TRACE // <- defined automatically by Unity! Debug.Log(log); #endif } ``` 6. Enable `symbols` to modify scripting define symbols for this assembly. Then edit `Modify Symbols` to `OSC_TEST;!TRACE`. This means *"add `OSC_TEST` symbol and remove `TRACE` symbol for this assembly."* ![](https://user-images.githubusercontent.com/12690315/71839029-9a314200-30fd-11ea-8596-d1a6ea188741.png) 1. All tests pass! ![](https://user-images.githubusercontent.com/12690315/71839100-c2b93c00-30fd-11ea-86a7-a2f1aac0a4cc.png) For more details, see [the article 1 (Japanese)](https://qiita.com/mob-sakai/items/f3bbc0c45abc31ea7ac0) and [the article 2 (Japanese)](https://qiita.com/mob-sakai/items/a24780d68a6133be338f).

## Contributing ### Issues Issues are very valuable to this project. - Ideas are a valuable source of contributions others can make - Problems show where this project is lacking - With a question you show where contributors can improve the user experience ### Pull Requests Pull requests are, a great way to get your ideas into this repository. See [CONTRIBUTING.md](https://github.com/mob-sakai/OpenSesameCompilerForUnity/blob/upm/blob/develop/CONTRIBUTING.md). ### Support This is an open source project that I am developing in my spare time. If you like it, please support me. With your support, I can spend more time on development. :) [![](https://user-images.githubusercontent.com/12690315/50731629-3b18b480-11ad-11e9-8fad-4b13f27969c1.png)](https://www.patreon.com/join/mob_sakai?) [![](https://user-images.githubusercontent.com/12690315/66942881-03686280-f085-11e9-9586-fc0b6011029f.png)](https://github.com/users/mob-sakai/sponsorship)

## License * MIT ## Author [mob-sakai](https://github.com/mob-sakai) ## See Also * GitHub page : https://github.com/mob-sakai/OpenSesameCompilerForUnity * Releases : https://github.com/mob-sakai/OpenSesameCompilerForUnity/releases * Issue tracker : https://github.com/mob-sakai/OpenSesameCompilerForUnity/issues * Change log : https://github.com/mob-sakai/OpenSesameCompilerForUnity/blob/upm/CHANGELOG.md * [No InternalsVisibleTo, no problem – bypassing C# visibility rules with Roslyn](https://www.strathweb.com/2018/10/no-internalvisibleto-no-problem-bypassing-c-visibility-rules-with-roslyn/) * Nuget version: https://www.nuget.org/packages/OpenSesameCompiler * asmdefScriptingDefines([@pCYSl5EDgo](https://github.com/pCYSl5EDgo)) : https://github.com/pCYSl5EDgo/asmdefScriptingDefines * Csc-Manager([@pCYSl5EDgo](https://github.com/pCYSl5EDgo)) : https://github.com/pCYSl5EDgo/Csc-Manager ## Special Thanks * Special thanks to [@pCYSl5EDgo](https://github.com/pCYSl5EDgo), your ideas contributed to improve this package.