Skip to main content

Installation

TPScript ships as a source plugin with no prebuilt binary required - Unreal's build tool compiles it for you on first launch. It is tested on Unreal Engine 5.8 for Windows and macOS.

Requirements​

  • Unreal Engine 5.8 (tested; older 5.x versions generally work but 5.8 is the reference).
  • A C++ project. Your project must have a Source/ folder (i.e. it must be a code project, not a pure Blueprint project). If yours is Blueprint-only, add a blank C++ class once to create the Source/ folder.
  • A C++ toolchain for your platform (Visual Studio on Windows, Xcode or Clang on macOS).
  1. On Fab, click Add to get TPScript into your library.
  2. In the Epic Games Launcher, open Library → Fab Library.
  3. Find TPScript UE5 and click Install to Engine, picking your installed engine version.
  4. Open (or create) your C++ project.
  5. Go to Edit → Plugins, search for TPScript, and enable TPScript UE5.
  6. Restart the editor when prompted.

You'll now have a TPScript section in the Tools menu and a toolbar button in the Level Editor.

Option B - Manual (zip / source)​

  1. Download the TpscriptUE5 plugin folder (from the zip or this repo's Plugins/ directory).

  2. Copy the TpscriptUE5 folder into your project's Plugins/ directory:

    <YourProject>/
    Plugins/
    TpscriptUE5/
    ...
    Source/
    YourProject.uproject
  3. Create a TPScripts/ folder in your project root if it doesn't exist.

  4. Open the project. The editor will detect the new plugin and compile it automatically.

  5. Use the TPScript panel (Tools → Open TPScript Panel) or the Tools → Run Regeneration menu item to start generating.

Verifying it installed​

After the editor loads, check for the TPScript entries under Tools in the main menu, and the TPScript tile in the «Play» toolbar. If you open Edit → Plugins you'll see TPScript UE5 listed as Enabled.

Uninstalling​

  1. Close the editor first (required).
  2. Remove the plugin:
    • Project install: delete Plugins/TpscriptUE5.
    • Engine install: uninstall via the Epic Games Launcher (Fab Library).
  3. Your .tps files in TPScripts/ are kept (they're just plain text).
  4. Generated C++ lives in Source/<Module>/TpsGenerated and Source/TpscriptKit - these are safe to delete if you no longer need the generated gameplay.

The bundled demo module​

The plugin ships with a demo module whose sources come from bundled corpus files, so the examples work out of the box - you can open the panel's Examples tab immediately without any setup. Copy an example into your own project's TPScripts/ folder to turn it into a real, editable mechanic.

Next step​

Follow the Quick Start guide to write and regenerate your first actor.