Installing NimForUE

Two ways to install NimForUE

Using NimForUE template: This is the recommended way to install NimForUE. It will install NimForUE and all of its dependencies. You can then use NimForUE to create a new project.
Adding NimForUE to an existing project: If you already have a project and want to add NimForUE to it, you can do so by adding NimForUE as a plugin.

Using NimForUE template

NimForUE is Nim plugin for UE5 that provides native performance, hot reloading, and full interop between C++ and Blueprints. With this plugin, you can extend any UE class in Nim and then further extend it in Blueprint without restarting the editor. This allows for seamless integration with common UE workflows, allowing you to take advantage of the power of Nim in your UE projects.

Make sure you have Unreal Engine 5.2 installed and you are using Nim devel (choosenim devel)

Clone the repository and its submodules:

git clone https://github.com/jmgomez/NimTemplate.git --recurse-submodules

Navigate to the NimForUE directory:
```
cd NimTemplate/Plugins/NimForUE
```
Set up nue, the NimForUE build tool using nimble: nimble nue
Setup NimForUE by running ./nue setup. This will build the project and all the necessary Nim files.
Open NimTemplate.uproject (or run ./nue starteditor)
Click play, click into the viewport to control the character. You’re all set!

Adding NimForUE to an existing project

Consider watching a detailed video tutorial on how to add NimForUE to an existing project here.

Make sure you have Nim installed. The required version is devel as NimForUE uses some features that are not yet in the stable version. Avoid using choosenim.
Clone the repo inside YourGame/Plugins
Run nimble nuesetup from YourGame/Plugins/NimForUE