Documentation category

Getting Started

Getting Started is the guided route from "I have the files" to "I can actually play, test, and build with this." These pages are written for the moment where you do not want theory yet. You want the map to open, the character to spawn, the UI to work, inventory to exist, systems to be placed in the world, and the project to feel like a real base instead of a pile of assets.

The Point of This Section

Hyper is modular, but the first pass should not feel like assembling a spaceship blindfolded. This category gives you a practical order: migrate, configure the map, set up the player, connect UI and inventory, prepare the environment, then add gameplay systems one by one.

What You Will Set Up

  • A playable map with the correct GameMode, player classes, navigation, and global actors.
  • A custom character with visual overrides, animation setup, team/identity data, and player-ready configuration.
  • Inventory, UI, datatables, equipment, attributes, environment setup, world map, respawn, water, and first narrative loops.
  • A clean path for adding systems without turning your project into an untestable tangle.

Best Way To Use It

Do not try to integrate every system at once. Get one small slice working, test it, then add the next. The systems are built to work together, but your first project pass should be calm, visible, and easy to verify.