UnrealSharp
  • Home
  • FAQ
  • Getting Started
    • Setup
    • Your First Script
    • Debugging
    • Packaging
  • Documentation
    • Classes
      • Properties
        • C++ Functions As C# Properties
        • C++ Properties with Getters/Setters
      • Functions
        • Flags
        • MetaData
      • Default Actor Components
      • Helper Methods
    • Structs
    • Enums
    • Interfaces
    • Delegates
    • Collections
      • TArray
      • TNativeArray
      • TSet
      • TMap
    • Multiplayer
      • Replicated Properties
      • RPCs (Remote Procedure Calls)
      • Replicated UObjects
    • Primary Data Assets
      • Loading Assets
    • Trace Channels
    • Static Variables
      • FWorldStaticVar<T>
      • FGameStaticVar<T>
    • Logging
    • Async
    • Gameplay Tags
      • Gameplay Tag Container
    • Extension / Mixin Methods
    • Subsystems
    • Module Lifecycle
  • Links
    • Github Repository
    • Roadmap
    • Discord
Powered by GitBook
On this page
  • Prerequisites
  • Clone UnrealSharp to your project
  • Generate Project Files
  • Compiling UnrealSharp
  • Launching UnrealSharp
  • Quick Access to UnrealSharp’s editor features
  • Project Setup Completed
  1. Getting Started

Setup

Get setup and running with your first project using UnrealSharp

PreviousFAQNextYour First Script

Last updated 1 day ago

Prerequisites

C++ Project (For compiling the plugin)

Unreal Engine 5.3 - 5.5

Install

Clone UnrealSharp to your project

Clone repo and place UnrealSharp in the ProjectRootDirectory/Plugins folder (make the Plugins folder if it doesn’t exist) in your Unreal Engine project.

git clone https://github.com/UnrealSharp/UnrealSharp.git

Generate Project Files

Right click on your projects UProject file and generate project files.

Compiling UnrealSharp

Compile the plugin as any other Unreal Engine plugin using the IDE of your choice.

Avoid compiling the plugin by clicking on the .uproject file. It introduces several issues, such as outdated binaries even when the source code has changed, which complicates debugging and support.

Launching UnrealSharp

Launch your Unreal Engine project through the solution file or .uproject. Once Unreal Engine has fully opened, this prompt should appear:

Press Yes and the Create C# Project menu should appear like this:

You can choose a custom project name, and the project will be located in the ProjectRootFolder/Script directory. Subdirectories within Script are also supported, allowing you to organize your project files in any folder structure you prefer.

By default it’ll create a new folder for each new project!

Quick Access to UnrealSharp’s editor features

If you lose track or need to start over, you can easily access the project setup feature again.

Navigate to the top of the editor viewport and you’ll find the UnrealSharp logo. Click on New C# Project and you’re back on track.

Project Setup Completed

Once the project is created and the solution opens, you will see two projects in the Solution Explorer.

ProjectGlue: This project contains the automatically generated glue code that is related to your project’s API. It is critical to the interop process, and it will be regenerated with each build. Therefore, do not modify or directly use this project. Any changes made here will be overwritten.

.NET 9.0 SDK
this