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

Using Astrum in UE4

Tips (forethought)

To create a game using Astrum you must first plan out HOW your game will function, and HOW it will utilise the framework.

Think of the following:

  1. Plan out the usage
    1. In game actors
      1. List out "actors" in your game.
      2. What will the players be controlling?
    2. Virtual HUD behavior
      1. Plan out Virtual HUD states (main menu, pause menu, main gameplay, so on).
      2. When will your players be allowed to play?
      3. Will there be different UI depending on variables (different teams/characters)?

Controller Access Endpoint

To access the controller endpoint to control your instance of Astrum go to /controller.html

E.g. 127.0.0.1:8081/controller.html or 34.244.8.2/controller.html

← ConfigurationDemonstration →
  • Tips (forethought)
  • Controller Access Endpoint
Project Astrum
Docs
Getting StartedDocsTips
This is a academic project run by William Stansfield-Tyler (U1555999@unimail.hud.ac.uk)