Setting Up A Two-Page Aug

Overview

In order to build your own Aug from the ground up, the following things will make the coding process far easier:

  • Table Realms IDE
  • A background for the Aug
  • An importable .ttf file

Setting Up

  • Open the Table Realms IDE and click the “Create New” button to create a new Lua project. Once the “New Project” window opens up, navigate to where you would like your Aug file to be saved, and give it a name. Once you have saved your project, the Table Realms IDE will open - from there, you can specify the project name within the project itself.
  • To start working on your project, you need to import all the necessary assets and create your Aug’s first stylesheet. These assets include:
    • Lua Base, Components, and Players
    • Images
    • Font
    • Audio (optional)

NOTE: If you attempt to add components to an Aug file without importing the scripts first, it will not work!

You’re now ready to start creating pages for your Aug!

  • Navigate to the the “Pages” section, and click on “Add Page”. Be certain to give the pages appropriate names!
  • On the start page, add a vertical panel stack, and add a button to the stack. The following script needs to be added to the button to communicate an action to the TR model:
SendAction(model.id .. ".ClickedStart");

NOTE: Never leave a page without components. This will break your project in the Table Realms IDE, and you will have to start again from scratch!

  • Don’t forget to save your work - you never know when a BSOD might come along.
  • On the Controller page, add a Horizontal Stack and a single ThumbstickDrawn element.

NOTE: A regular Thumbstick would require a separate image asset, but would function in the same way.

  • Add a button alongside the thumbstick, in the same way as previously.
  • Add a script to the button as previously
SendAction(model.id .. ".ClickedFire");
  • Once your pages are set up, return to the root project file, and specify the default page that the aug will load when the game starts.
  • After saving your Augmentation, it is ready to be uploaded to your preferred engine as a .aug file