Tutorial : Getting Started

#Tutorial 00 : Getting Started

This tutorial will show you how to obtain RUL and how to set it up for use in your project.

Obtaining the source and binary files

First, clone or download the version of RUL you would like to use. The git repository contains the source code, a Visual Studio / Monodevelop solution file (.sln) as well as the compiled dll with an XML documentation file in the RUL/bin/Release directory.
If you would rather compile the source yourself, simply open the solution with your preferred IDE and compile the library with the appropriate settings.

Using RUL with Visual Studio or Monodevelop

To use the library with XNA or MonoGame, simply right-click the References folder in the project view and click on "AddReference". Use the "Browse" button to find the dll you downloaded or compiled and click "OK". The library should now be available in your project and show up with the rest of your references.
Use the using keyword in order to include the RUL namespace in your code.

Using RUL with Unity

In order to use a library with Unity, you need to copy the .dll into your project's Asset folder. Don't forget to do the same with the XML documentation. You can then simply use the using keyword in order to include the RUL namespace in your code.
Check out this page for more information.
If you get any Unity errors when trying to include RUL in your project, you may need to recompile RUL for Unity. See this tutorial for instructions.