Cheats

A registry of debug cheats with a built-in window for Unreal Engine.

👀 Summary

NsCheats is a registry of debug cheats with a built-in window. Game systems register buttons, toggles, number fields, text fields, pickers, and debug text. A developer opens the window during play and uses the cheats.

NsCheats is for development builds. In a Shipping build, the registry, the window, and the console commands compile out. NsCheats does not replicate, and it does not give an in-game UMG widget.

📦 Features

• Seven entry types: Buttons, toggles, number fields, text fields, pickers, debug text, and button rows.
• C++ builder: Register a full section of cheats in one call chain.
• Blueprint support: Register entries, and implement the provider interface, in Blueprint.
• Provider discovery: At start, the subsystem registers the game instance and world subsystems that implement the provider interface and already exist.
• Tabs, sections, and search: The window sorts entries into tabs and sections, with a search box.
• Owner cleanup: Entries of a destroyed owner leave the registry.
• Console commands: Open or close the window, log the registry, or run a console command.
• Built-in cheats: Log the registry, log the player location, and toggle stat fps and stat unit.

⚙️ Requirements

Unreal Engine 5.7+

🛠️ Installation

1. Clone or download this repository.
2. Copy the NsCheats folder into the Plugins folder of your project.
3. For C++, add "NsCheatsRuntime" to the module dependencies in Build.cs.
4. Generate the project files and enable the plugin.

🚀 Getting Started

Implement INsCheatProviderInterface on the object that owns the cheats:

#include "NsCheatsSubsystem.h"

void UMyEconomySubsystem::RegisterCheats_Implementation(UNsCheatsSubsystem* CheatsSubsystem)
{
    CheatsSubsystem->ForProvider(this, TEXT("Economy"))
        .Section(TEXT("Coins"))
        .Button(TEXT("Economy.AddCoins"), INVTEXT("Add 1000 coins"),
            FNsCheatExecuteDelegate::CreateUObject(this, &UMyEconomySubsystem::AddDebugCoins))
        .Toggle(TEXT("Economy.FreePlay"), INVTEXT("Free play"),
            FNsCheatGetBoolDelegate::CreateLambda([this]() { return bFreePlay; }),
            FNsCheatSetBoolDelegate::CreateLambda([this](bool bValue) { bFreePlay = bValue; }));
}

Then call RegisterProvider(this) on the UNsCheatsSubsystem of the game instance. Do this in BeginPlay for an actor or a component, and call UnregisterProvider(this) in EndPlay.

Run ns.Cheats.Toggle in the console to open the window.

🧩 Entry Types

🔧 API

• UNsCheatsSubsystem – The game instance subsystem that owns the entries, the providers, the console commands, and the window.
• INsCheatProviderInterface – One function, RegisterCheats(UNsCheatsSubsystem*), for C++ and Blueprint.
• FNsCheatBuilder – The C++ builder that ForProvider(Owner, Tab) returns.
• FNsCheatEntry – One entry: id, label, description, tab, section, sort order, type, owner, and delegates.
• RegisterProvider / UnregisterProvider – Add or remove a provider and its entries.
• ExecuteEntry(Id) – Run the action of an entry from code.
• OpenCheatUI / CloseCheatUI / ToggleCheatUI – Show or hide the window.
• DumpRegisteredCheats – Log all entries and return the list as a string.

🚧 Limits

• The window is a separate Slate window, not a widget in the game viewport.
• The plugin does not replicate. A cheat runs on the machine where you use it.
• ButtonRow has no Blueprint registration function.
• Automatic discovery runs one time, at start. Other providers must call RegisterProvider.

📚 Documentation

Contact

E-mail LinkedIn GitHub Bluesky