Project Astrum

Project Astrum

  • Installation

›Getting Started

Getting Started

  • Installation
  • Configuration
  • Usage
  • Demonstration
  • Browser Support

Guides

  • Framework
  • VirtualElements Guide
  • Quirks

API

  • AstrumClient (Actor Component)
  • AstrumPlayerControllerBase (PlayerController)
  • AstrumPlayerCharacter (Actor)
  • VirtualElement (Object)
  • VirtualButton (VirtualElement)
  • VirtualAnalogue (VirtualElement)
  • VirtualText (VirtualElement)
  • VirtualImage (VirtualElement)

Enumerations

  • AstrumEnumHUDHorizonalAlignment (Enumeration)
  • AstrumEnumHUDVerticalAlignment (Enumeration)
  • AstrumEnumEventRecipient (Enumeration)

References

  • Software Used

Configuring Astrum UE4 Client in UE4

Setting up Astrum UE4 Client

  • It is recommended that the Astrum Client be put into the project's GameMode.
  1. Open your new Unreal Engine Project.

  2. If starting from a fresh project, create a new GameMode from GameModeBase Class, or open any pre-existing GameMode Class.

  3. Add a "Astrum Client" component into the GameMode.

Place an "AstrumClient" actor component into the GameMode of your choice.

  • The following step can differ depending on if your instance of Astrum Server is running locally or on a hosted cloud provider.
  1. Add the server hostname/IP address and port into the default "Server Address and Port" string variable.

Add the server hostname/IP address and port into the default "Server Address and Port" string variable.

NOTE: The default port for Astrum Server is 4321

Testing configuration

How do I test the configuration of my Astrum instance?

  1. Inside your GameMode, create a reference to the "AstrumClient".
  2. Then create a "Connect" node.
  3. (optional) Should you wish to test the connection to the Astrum Server, create a "Test Connection" node. The following steps will result in a similar configuration of nodes to this.

The following steps will result in a similar configuration of nodes to this.

Advanced Tips

Adding Custom Events

You may only register and use custom events if you have access to the AstrumServer/AstrumClient source code and can edit it.

  • Use "Add Custom Astrum Event" node to register events created in the source code. Use "Add Custom Astrum Event" node to register events created in the source code.
← InstallationUsage →
  • Setting up Astrum UE4 Client
  • Testing configuration
  • Adding Custom Events
Project Astrum
Docs
Getting StartedDocsTips
This is a academic project run by William Stansfield-Tyler (U1555999@unimail.hud.ac.uk)