dseeni / nimtemplate

NimTemplate

Template project for NimForUE: https://github.com/jmgomez/NimForUE

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.

Getting Started in Windows:

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

1. Clone the repository and its submodules:

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

2. Navigate to the NimForUE directory:

cd NimTemplate/Plugins/NimForUE

3. Set up nue, the NimForUE build tool using nimble:

nimble nue

4. Setup NimForUE by running ./nue setup

This will build the project and all the necessary Nim files.

5. Open NimTemplate.uproject (or run ./nue starteditor)

6. Click play, click into the viewport to control the character. You're all set!