To compile the source code into the ORKFramework.dll used by your Unity project, you need to set up the references in MonoDevelop.

The references are set up in the Solution View of MonoDevelop.


In the Framework project of the ORK Framework Gameplay solution, either double click References or right click and select Edit References. This will open the reference editor.


You need to add three references:

  • UnityEngine.dll
    Can be found in your Unity installation folder.
    Windows: Editor/Data/Managed/UnityEngine.dll
    Mac OSX: Unity.app/Contents/Frameworks/UnityEngine.dll
  • UnityEngine.UI.dll
    Can be found in your Unity installation folder.
    Windows: Editor/Data/UnityExtensions/Unity/GUISystem/Standalone/UnityEngine.UI.dll
    Mac OSX: Unity.app/Contents/UnityExtensions/Unity/GUISystem/Standalone/UnityEngine.UI.dll
  • ORKFrameworkCore.dll
    Comes with the ORK Framework package.
    After import, it can be found in your Unity project in Assets/ORK Framework/DLL/.

Since this is most likely the first time you’re adding them, you need to select the .Net Assembly tab and locate the DLL files in the file browser. Add them by either double clicking or selecting them and clicking on the Add button. Once you’ve added all three DLLs, you can confirm the changes by clicking on OK. Please note that you also need to have the System reference in the project, this should already be added by default.

Your solution view should now look like this:


You’re now able to compile the project.

When the compilation has been successfull, you can find the ORKFramework.dll in bin/Release/ in the solution’s folder.

Copy the ORKFramework.dll into your Unity project to Assets/ORK Framework/DLL/ and replace the already existing one.

Tip: Automatic distribution

You can use Custom Commands in MonoDevelop to automatically place the newly compiled DLL in your project.

This can be done using batch files that’ll copy the DLL for you – the batch file can be executed as a custom command after building the DLL. You can add custom commands in the Project Options of the Framework project. You can open the options by double clicking on the project (or by double clicking and selecting Options).