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

Demonstration of Astrum in UE4

Demonstration

  1. Create a Player Controller (recommended inheriting from AstrumPlayerControllerBase)
    1. If NOT inheriting from AstrumPlayerControllerBase ensure the class implements the "AstrumInputInterface" (Image Ref)
  2. Set the newly created controller class in AstrumClient (Image Ref | Video Ref)
  3. Create a Player Character (in this case we'll use the Third Person Starter Content) (Video Ref)

    If you don't have the ThirdPerson starter content, follow the following sub-list:

    1. In the Content Browser, click "Add New...",
    2. Click "Add Feature or Content Pack..."
    3. Click "Third Person"
    4. Click "+ Add to Project"
  4. Have Player Controller spawn Player Character on Custom Event (promote to variable and then possess) (Video Ref | Blueprint Ref)
  5. Setup inputs (move input + buttons) (Image Ref | Blueprint Ref)
  6. Setup game mode by implementing the following events (Blueprint Ref)

Note the "Cast to DemoPlayerController" node. This will likely break should you paste the BP bin into your project. Replace the cast node with that of the controller class you made earlier.

Checklist

You should have completed the following:

  • Created a game mode (from configuration page)
    • Inputted the server IP/hostname and port number
    • Selected base controller class
    • Implemented "On Player Connect"
  • Created a player controller
    • Implemented "AstrumInputInterface" interface if NOT inherited from "AstrumPlayerController"
    • Implemented "BeginPlay" to spawn and promote new character
    • Implemented "New VirtualController Input", "New VirtualButton Input" and "On Player Disconnect" events
  • Created player character (from ThirdPersonCharacter)
  • Tested with frontend endpoint
← UsageBrowser Support →
  • Demonstration
  • Checklist
Project Astrum
Docs
Getting StartedDocsTips
This is a academic project run by William Stansfield-Tyler (U1555999@unimail.hud.ac.uk)