Skip to main content

Minimal Setup

  • areas folder
    • .tmx map files, default.tmx required
    • See Areas
  • assets folder
    • Tilesets, textures, audio, animations, packages
    • See Assets
  • scripts folder
    • Lua files. Entry scripts are read from scripts/*/main.lua for script projects, and scripts/*.lua for single file scripts
    • See Lua API
  • Server executable

Run the server through a command prompt or terminal and join on 127.0.0.1:8765

Use -h to see more options and research port forwarding or server hosting if you want to share your server with others over the internet

Port Forwarding Alternatives

  • PLAYIT.GG
    • Routes up to 4 TCP / UDP ports through a sharable URL.
    • Running the playit program should guide you through creating an account and setting up an "Agent"
    • To forward Hub OS, you'll need to create a new tunnel.
      • Tunnel Type: UDP
      • Description: Hub OS server https://hubos.dev
      • Origin Port: 8765