Supremacy

Developed with Unreal Engine 5

Getting Started

To get started, you will need to meet the prerequisites first:

Prerequisites

• Git or GitHub Desktop
• Unreal Engine 5
• Visual Studio 2019

NOTE: It is recommended that you have at least 300GiB of free space to install Unreal Engine 5 and clone the repository.

While you are installing VS2019 or you have already met all those prerequisites, in the Visual Studio Installer that comes along with VS2019, modify the installation to check the following:

• ASP.NET and web development ✅
  • .NET Core 3.1 Runtime (LTS) ✅
• Desktop development with C++ ✅
• Game Development with C++ ✅
  • Unreal Engine Installer (even if you have UE5 installed) ✅

And then, click install.

Git

Note that if you are using Git on Cmd or Bash, you will also need to download Git LFS. Install it and execute the following command on Git Cmd/Bash:

git lfs install

Once Git LFS has been installed and configured by the above step, clone the repository by executing the following command:

NOTE: Cloning the repository can take very long time. If you already have a local copy of supremacy-gameclient, you can skip this clone step. If your local copy of supremacy-gameclient contains auto-generated files that were built on other PC, you will need to regenerate them. See Troubleshooting section on how to clean up the auto-generated files.

git clone https://github.com/ninja-syndicate/supremacy-gameclient.git

After the repository has been cloned, you may want to set your Git username and email by executing the following commands on the repository you have cloned to unless you have already done so.

git config user.name "Your Full Name"
git config user.email "Your Email Address"

Plugins

The following Unreal Engine Plugins need to be installed. Find them in the Library tab of the Epic Launcher, under Vault.

( Note: You'll need to be signed in with the company's Epic Account to have access to paid assets/plugins. )

• Quixel Bridge
• LE Extended Standard Library
• BlueprintWebSocket
• JSONParser
• EasyBallistics Plugin

UnrealJS is also used but is included in the repo. It does however require the V8 library to be installed which can be done via setup.bat. If setup.bat doesn't work due to sh command not being recognised, navigate to Plugins/UnrealJs directory and run install-v8-libs.bat instead.

Once you have finished installing all the necessary plugins, right click Supremacy.uproject, click "Show More Options" if you are using Windows 11, and click "Generate Visual Studio Project files". Then, open the Supremacy.sln, click "Build" in the menu bar and click "Build Solution". Once the project is built, you can simply open up Supremacy.uproject in the repository, and you are ready for the development!

Recommended Workflow

Turn-off Editor Auto Save Option

Since Unreal's blueprints are binary, it is recommended to turn off auto-save option in the Editor Preferences setting. Sometimes, when this auto-save option is enabled, Unreal will save blueprints that are open even if there are no changes. This can make it hard to track which files have actually changed and more time-consuming to resolve merge conflicts.

Make a GitHub Issue and Assign Yourself

Before making changes to the existing files or work on a new feature, make a GitHub issue if it doesn't already exist and assign yourself. This will help others know which conflicts are expected and possibly work on something else meanwhile.

Building

To build the client run update_and_build.bat

Environment Variables

• RunUAT - Set this to the location of your RunUAT.bat file (eg: UnrealEngine\UE_5.0\Engine\Build\BatchFiles\RunUAT.bat)
• SUPREMACY_EOS_ARTIFACT - Get this from 1Password. This needs to be set for Online multiplayer to work

Keybinds

• SHIFT+ENTER : Show Main Menu / Start test match if on specific map (for testing without a server)
• CTRL+SHIFT+ENTER : Start test match and skip the intro animations
• CTRL+SHIFT+R: Load battle from clipboard (text w/ battle commands on each line)
• ENTER : Toggle free camera
• SHIFT+K : Kill random mech
• DELETE : Force restart
• X : Toggle cursor / mouse capture
• T : Set random time of day
• -/+ : Decrease/Increase global time dilation
• CTRL+Q: Possess Red Mountain Mech
• CTRL+W: Possess Boston Mech
• CTRL+E: Possess Zaibatsu Mech
• SHIFT+H: Toggle Health Bars
• SHIFT+z: Force Next Battle Zone
• CTRL+ALT+SHIFT+BACKSPACE: Force Crash
• CTRL+ALT+SHIFT+\: Force Not Responding

Abilities (Numbers or Numpad)

• 1 : Airstrike (on random mech)
• 2 : Nuke (on random mech)
• 3 : Heal (on random mech)
• SHIFT+3 : Shield Buff (on random mech)
• ALT+3 : Ammo (on random mech)
• 4 : Robot Dogs
• 5 : Mini Mech
• ALT+5 : Turret
• 6 : Satellite Overload (on random mech)
• 7 : Landmines (on random mech)
• 8 : EMP (on random mech)
• 9 : Hacker Drone (on random mech)
• SHIFT+9 : Camera Drone (on random mech)
• 0 : Incognito (on random mech)
• SHIFT+0 : Blackout (on random mech)
• F : Fireworks (on random mech)
• G : Move Command (on random mech, to random map spawn point)
• SHIFT+G : Cancel Move Command (on random mech)
• H : Lower Tile (on random mech, NOTE: The Hive map only)

Troubleshooting

Missing C++ files after pulling, warnings/errors or certain things don't work

Unreal sometimes fail to recognise new C++ files if you open up the project after pulling. It sometimes works and sometimes doesn't. So if there were changes to C++ files, often you will have to rebuild the project.

NOTE: Rebuilding the project can take quite some time and storage space, so it is recommended that you have sufficient disk space for it.

Cleaning up auto-generated files

If the problem persists even after rebuilding the project, it could be the case that existing auto-generated folders are causing conflicts. So, close Unreal and try deleting automatically generated folders in the project. These are:

• Binaries
• DerivedDataCache
• Intermediate
• Saved
• Script

And then open up the project again. This will cause those folders to be re-generated.

Coding Standard

• Coding Standard By Unreal
• Recommended Asset Naming Convention

Configs

If you'd like to run the built game-client for development purposes, you can edit GameUserSettings.ini file (found in Supremacy/Saved/Config/Windows/GameUserSettings.ini) to reduce CPU and GPU usage:

Battle Replaying

You can emulate incoming messages from the server to "replay" a previous battle. With a list of battles commands in your clipboard you can use CTRL+SHIFT+R to start a match that uses them.

Each line is a battle command; starting with BATTLE:INIT, each line after that starts with the delay in seconds followed by a |.