Installing Astrum in UE4

Prerequisites

To use the Project Astrum client in Unreal Engine, you must have the following installed (info on how to install these will be detailed below):

The following three are ONLY for local hosting installations.

Unreal Engine 4.23.1

Unreal Engine 4.23.1 can be downloaded via the Epic Games Launcher which can be installed here.

Now:

  • Open Unreal Engine,
  • Create a project (in any folder location),
  • Open newly created project,
  • Close down the Unreal Engine,

Astrum UE4 Client & SocketIO UE4 Client

SocketIO UE4 Client is BUNDLED with Astrum UE4 Client, and can be downloaded via this link.

Now:

  • Unpack the 7z file using 7zip,
  • In project folder (created earlier), extract "Plugins" folder into project root,
  • Inside project "Content" folder, extract "Astrum" and "Demo" folders,
  • Verify that your project folder structure is as follows:
├── Binaries/
├── Config/
├── Content/
│   ├── *Astrum/*
│   └── *Demo/* (optional)
├── Intermediate/
├── *Plugins/*
│   └── socketio-client-ue4/
│       ├── Binaries/
│       ├── Config/
│       ├── SocketIOClient.uplugin
│       └── ......
├── Saved/
└── {project-name}.uproject

NOTE: When opening the Unreal Engine project for the first time after installing Astrum, you may need to re-build SocketIOClient (a dependency of Astrum).

Astrum Server/Client (skip if running on cloud provider/remotely)

The following are ONLY for local hosting installations.

You can download/pull both Astrum Server/Client from GitHub into INDIVIDUAL FOLDERS.

Now, once projects are downloaded in different folders:

  • In Astrum Server folder directory use command npm install,
    • Wait...
    • Enter Astrum Client directory
  • In Astrum Client folder directory use command npm install,
    • Wait...
Configuration →