Source Control

Depending on whether you come from a React Native or Unreal Engine background, you may be familiar with slightly different source control software.

React Native for Unreal Engine plugin

The rnue plugin is currently distributed to integraiton partners via a GitHub repository.

Typical workflows in each ecosystem

React Native only teams

React Native projects can use git for source control. A forge is a web application that hosts and manages git repositories.

git is excellent for repositories containing mostly text, and offers powerful diffing, patching and flexible branching workflows.

git handles text files well. Unreal Engine projects also contain large binary assets, which need different storage and locking workflows.

git-lfs stores large binary files outside the main git object store. Teams must add separate tools when they need locking or media review.

Unreal Engine only teams

In the gaming and 3D world one of the primary requirements from source control software is the ability to handle binary file workflows.

Unreal Engine projects contain binary assets such as images, materials, and Blueprints. These assets need suitable storage, locking, and review workflows.

Working with both React Native & Unreal Engine

With the above tendencies in mind we can define the challenges and constraints of a workflow that combines team members and software from both ecosystems:

• rnue will come from a git repository
• The native portion of your React Native code that interfaces with C++ code in Unreal Engine will likely feel most at home in a git repository
• Your Unreal Engine team will likely prefer to work with a well established source control software that supports workflows for binary content

Should we attempt automatic synchronization?

Though most of the game source control software offer some sort of git sync capability, it is often gated behind an enterprise license or does not work reliably.

The options that work well are:

1. Create a series of explicit scripts written in either Bash/PowerShell or a scripting language like Python that pull changes from git, only storing a version tag. The downside of this method is that it requires some additional orchestration when the time comes to create CI/CD workflows. The upside of this method is that nobody can ever accidentally modify the native modules and rnue plugin, eroding the notion of a single source of truth in the project.
2. Store a copy of the rnue Unreal plugin and the various native modules that bridge JavaScript and C++ in the same repository the game is using, and manually reconcile divergences from git. The downside is that it can create unnecessary conflicts if team members edit in both places. The upside is that it skips the need for additional steps during CI/CD and release workflows

This guide uses the first option because it keeps git as the source of truth.

A typical workflow therefore is: