Exernality Documentation

Overview

Exernality is a upcoming Roblox executor with a focus on speed, stability, and security. It is designed to be a drop-in replacement for existing executors, with a familiar structure!

Installation

Download the latest release and unzip anywhere. Run Exernality.exe, then join a Roblox game and hit Inject. Scripts can be run from the Editor

Workspace

On first run a workspace folder is created at %LOCALAPPDATA%\Exernality. Scripts, logs, and files are stored here.

Your first script

Join a game, run as admin, hit Inject, then Ctrl+Enter in the Editor.

Example

local plr = game:GetService("Players").LocalPlayer print("hi from", plr.Name)

getgenv

Shared executor globals; values persist across script runs.

function getgenv(): table

getrenv

Roblox's own globals, the ones game scripts see.

function getrenv(): table

getsenv

Returns the environment table of the calling script. Alias: getmenv.

function getsenv(): table

getreg

Returns the Lua registry (index LUA_REGISTRYINDEX). Alias: getregistry.

function getreg(): table

getgc

Returns every collectable object currently tracked by the Luau GC. Pass true to include tables in the result.

function getgc(includeTables: boolean?): {any}

filtergc

Filters GC objects by type and attributes; returns one match or a list.

function filtergc(type: string, filter: table, first: boolean?): any

getidentity

Returns the current thread's Roblox identity (0-8). Aliases: getthreadidentity, getthreadcontext.

function getidentity(): number

setidentity

Sets the current thread's Roblox identity. Aliases: setthreadidentity, setthreadcontext.

function setidentity(level: number)

identifyexecutor

Executor name and version. Also: getexecutorname, getexecutorversion.

function identifyexecutor(): string, string

setclipboard

Places text onto the Windows clipboard. Aliases: toclipboard, setrbxclipboard.

function setclipboard(text: string)

setfpscap

Sets Roblox's target frame rate cap. Aliases: setfps, SetFps.

function setfpscap(fps: number)

getfpscap

Returns the current FPS cap. Aliases: getfps, GetFps.

function getfpscap(): number

queue_on_teleport

Runs a script after teleport. Alias: queueonteleport. Clear with clearqueueonteleport.

function queue_on_teleport(source: string)

require

Executor-side require that bypasses ModuleScript's normal require restrictions and works with asset IDs.

function require(module: ModuleScript | number): any

multiinstance

Drops this client's hold on Roblox's one-client-at-a-time lock, so the next Roblox you open starts instead of handing itself to this one. Returns true and how many handles it closed, or false and the reason. Aliases: multi_instance, closesingleton. The Multi instance setting does the same thing for every client Exernality attaches to; each client then listens on its own port from 6969 up, and the Clients panel picks the one your scripts run on.

function multiinstance(): boolean, number | string

newcclosure

Wraps f with a C identity, needed by anti-tamper stack walks.

function newcclosure(f: function): function

newlclosure

New closure forwarding to f; guarantees an L-closure for debug APIs.

function newlclosure(f: function): function

iscclosure

True if f is a C closure. Alias: is_c_closure.

function iscclosure(f: function): boolean

islclosure

True if f is a Lua closure. Alias: is_l_closure.

function islclosure(f: function): boolean

isexecutorclosure

True if f was made by Exernality. Aliases: checkclosure, isourclosure.

function isexecutorclosure(f: function): boolean

isnewcclosure

True if f was produced by newcclosure.

function isnewcclosure(f: function): boolean

checkcaller

True when the caller is the executor, not a game script. Alias: check_caller.

function checkcaller(): boolean

clonefunction

Returns a deep copy of a function whose identity differs from f. Modifications to one do not affect the other.

function clonefunction(f: function): function

hookfunction

Redirects target through hook and returns the original. Alias: replaceclosure.

function hookfunction(target: function, hook: function): function

restorefunction

Undoes a previous hookfunction on the target. Alias: restorefunc.

function restorefunction(hooked: function)

isfunctionhooked

True if f has an active hook.

function isfunctionhooked(f: function): boolean

hookproto

Swaps a closure's compiled prototype. More invasive than hookfunction.

function hookproto(target: function, replacement: function)

restoreproto

Reverts a prior hookproto.

function restoreproto(target: function)

loadstring

Compiles Luau source into a callable function. Returns nil, errorMessage on syntax errors.

function loadstring(source: string, chunkname: string?): function?, string?

getrawmetatable

Returns the raw metatable of t, bypassing __metatable.

function getrawmetatable(t: any): table?

setrawmetatable

Sets the metatable of t, ignoring readonly protection.

function setrawmetatable(t: any, mt: table)

hookmetamethod

Hooks one metamethod (__index, __namecall, ...) and returns the original.

function hookmetamethod(t: any, event: string, hook: function): function

isreadonly

True if t is frozen.

function isreadonly(t: table): boolean

setreadonly

Locks or unlocks a table against writes. Also available as make_readonly / make_writeable.

function setreadonly(t: table, readonly: boolean)

getnamecallmethod

Inside a __namecall hook, returns the name of the method currently being called.

function getnamecallmethod(): string?

setnamecallmethod

Inside a __namecall hook, redirects the call to a different method name before invocation.

function setnamecallmethod(name: string)

isuntouched

True if the table is untouched since script start. Pair with setuntouched.

function isuntouched(value: any): boolean

debug.getconstants

Returns the constants table baked into f's prototype.

function debug.getconstants(f: function): {any}

debug.getconstant

Returns a single constant by 1-based index.

function debug.getconstant(f: function, index: number): any

debug.setconstant

Replaces a constant in-place. Type of value must match the original.

function debug.setconstant(f: function, index: number, value: any)

debug.getupvalues

Returns the captured upvalues of f.

function debug.getupvalues(f: function): {any}

debug.setupvalue

Sets an upvalue by index.

function debug.setupvalue(f: function, index: number, value: any)

debug.getproto

Returns a nested prototype from f; all closures sharing it when active is true.

function debug.getproto(f: function, index: number, active: boolean?): function | {function}

debug.getprotos

Returns every child prototype declared inside f.

function debug.getprotos(f: function): {function}

debug.getstack

Returns the value at a stack slot in the given call frame. Omit index for the whole slice.

function debug.getstack(level: number, index: number?): any

debug.setstack

Writes a stack slot.

function debug.setstack(level: number, index: number, value: any)

debug.getinfo

Metadata for a function or stack frame: source, line, name, params, nups.

function debug.getinfo(levelOrFunc: number | function): table

debug.getregistry

Equivalent to top-level getreg.

function debug.getregistry(): table

debug.getmetatable

Bypasses __metatable shrouding. Companion setmetatable writes it back.

function debug.getmetatable(value: any): table?

getinstances

Returns every Instance in memory, including those unparented from the DataModel.

function getinstances(): {Instance}

getnilinstances

Returns only Instances whose Parent is currently nil.

function getnilinstances(): {Instance}

getscripts

Every LocalScript / ModuleScript currently loaded.

function getscripts(): {LuaSourceContainer}

getrunningscripts

Only scripts that are actively executing.

function getrunningscripts(): {LuaSourceContainer}

getloadedmodules

ModuleScripts whose result is cached by Roblox's require.

function getloadedmodules(): {ModuleScript}

getcallingscript

Returns the script associated with the current thread, or nil if there is no owning script.

function getcallingscript(): Instance?

getscriptbytecode

Returns the raw compiled bytecode of a script. Alias: dumpstring.

function getscriptbytecode(script: LuaSourceContainer): string

getscripthash

Returns a stable hash of a script's bytecode.

function getscripthash(script: LuaSourceContainer): string

getscriptclosure

Compiles source and returns the main closure without running it. Alias: getscriptfunction.

function getscriptclosure(script: LuaSourceContainer): function

decompile

Returns pseudocode for the compiled bytecode of a script.

function decompile(script: LuaSourceContainer): string

gethiddenproperty

Reads a non-scriptable property. Second return value indicates whether the property was hidden.

function gethiddenproperty(inst: Instance, property: string): any, boolean

sethiddenproperty

Writes a non-scriptable property. Returns whether the property was hidden.

function sethiddenproperty(inst: Instance, property: string, value: any): boolean

isscriptable

True if a property is currently marked scriptable.

function isscriptable(inst: Instance, property: string): boolean

setscriptable

Toggles scriptable-ness of a property. Returns the previous state.

function setscriptable(inst: Instance, property: string, scriptable: boolean): boolean

cloneref

Returns a distinct reference to the same underlying Instance, used to defeat identity comparisons.

function cloneref(inst: Instance): Instance

compareinstances

True if two references (including cloned ones) point to the same underlying Instance.

function compareinstances(a: Instance, b: Instance): boolean

gethui

Returns a hidden UI container that game scripts cannot see. Parent your UIs here to protect them from cleanup.

function gethui(): Instance

getconnections

Each returned Connection exposes Enable, Disable, Fire, and the underlying Function.

function getconnections(signal: RBXScriptSignal): {Connection}

firesignal

Invokes every listener attached to signal with the supplied arguments.

function firesignal(signal: RBXScriptSignal, ...)

firetouchinterest

Simulates a Touch/TouchEnded event between two parts. state = 0 fires Touched, state = 1 fires TouchEnded.

function firetouchinterest(a: BasePart, b: BasePart, state: number)

fireclickdetector

Fires the MouseClick event of a ClickDetector.

function fireclickdetector(cd: ClickDetector, distance: number?)

fireproximityprompt

Triggers a proximity prompt as if the player had held the interaction key.

function fireproximityprompt(pp: ProximityPrompt)

getsignalarguments

Argument names and types of a signal. Companion: getsignalargumentsinfo.

function getsignalarguments(signal: RBXScriptSignal): {any}

getsignalwhitelist

Returns the list of remote signals allowed to be replicated to server.

function getsignalwhitelist(): {string}

getrendersteppedlist

Returns every function currently registered on RunService.RenderStepped.

function getrendersteppedlist(): {function}

cansignalreplicate

True if firesignal against this signal will replicate to the server.

function cansignalreplicate(signal: RBXScriptSignal): boolean

replicatesignal

Fires signal and forces the invocation to replicate.

function replicatesignal(signal: RBXScriptSignal, ...)

readfile

Returns the contents of a file as a string.

function readfile(path: string): string

writefile

Overwrites path with data. Creates parent directories as needed.

function writefile(path: string, data: string)

appendfile

Appends data to the end of a file.

function appendfile(path: string, data: string)

listfiles

Returns the names of the entries in a folder.

function listfiles(path: string): {string}

isfile

True if path refers to an existing file.

function isfile(path: string): boolean

isfolder

True if path refers to an existing folder.

function isfolder(path: string): boolean

makefolder

Creates a folder (and any missing parents).

function makefolder(path: string)

delfile

Deletes a file.

function delfile(path: string)

delfolder

Recursively deletes a folder and everything inside.

function delfolder(path: string)

loadfile

Compiles a file into a callable function without running it. Returns nil, err on syntax errors.

function loadfile(path: string): function?, string?

dofile

Reads and executes a file in-place.

function dofile(path: string)

getcustomasset

rbxasset:// URI for a workspace file, usable in image/sound/mesh properties.

function getcustomasset(path: string): string

request

HTTP client. Options: Url, Method, Body, Headers. Returns Success, StatusCode, Headers, Body. Alias: http_request.

function request(options: table): table

HttpGet

Simple GET that returns the response body. Also bound as the global game:HttpGet. Aliases: httpget, http_get.

function httpget(url: string): string

getobjects

Loads Roblox assets from an asset ID URL. Bound as game:GetObjects. Aliases: getobjects, get_objects.

function getobjects(assetId: string): {Instance}

WebSocket.connect

Opens a WebSocket with Send, Close, OnMessage, and OnClose.

function WebSocket.connect(url: string): WebSocketClient

isrbxactive

True when the Roblox window has focus. Aliases: isgameactive, iswindowactive.

function isrbxactive(): boolean

mouse1click

Simulates a left mouse-button click.

function mouse1click()

mouse1press

Presses (but does not release) the left mouse button.

function mouse1press()

mouse1release

Releases the left mouse button.

function mouse1release()

mouse2click / mouse2press / mouse2release

Right-button equivalents of the mouse1* family.

function mouse2click()

mousemoveabs

Moves the cursor to absolute screen coordinates.

function mousemoveabs(x: number, y: number)

mousemoverel

Moves the cursor by a delta.

function mousemoverel(dx: number, dy: number)

mousescroll

Scrolls the wheel by delta ticks.

function mousescroll(delta: number)

keypress

Presses a virtual-key code. Alias: keyclick.

function keypress(keyCode: number)

keyrelease

Releases a virtual-key code.

function keyrelease(keyCode: number)

keytap

Press-and-release convenience.

function keytap(keyCode: number)

messagebox

Shows a native Windows message box; returns the button ID pressed.

function messagebox(text: string, caption: string, flags: number?): number

crypt.encrypt

Encrypts with AES or Blowfish modes. Returns base64 ciphertext and IV.

function crypt.encrypt(data: string, key: string, iv: string?, mode: string?): string, string

crypt.decrypt

Reverses crypt.encrypt.

function crypt.decrypt(data: string, key: string, iv: string, mode: string?): string

crypt.hash

Hashes with MD5, SHA1, SHA224, SHA256, SHA384, SHA512, or the SHA3_* variants.

function crypt.hash(data: string, algorithm: string): string

crypt.hmac

Returns an HMAC digest using the given hash algorithm.

function crypt.hmac(data: string, key: string, algorithm: string): string

crypt.generatebytes

Returns count cryptographically-secure random bytes, base64-encoded.

function crypt.generatebytes(count: number): string

crypt.generatekey

Returns a 32-byte random key, base64-encoded, suitable for AES-256.

function crypt.generatekey(): string

crypt.random

Cryptographically-secure integer in [min, max].

function crypt.random(min: number, max: number): number

crypt.base64encode / decode

Base64 encode/decode, also exposed as base64encode and base64decode globals.

function crypt.base64encode(data: string): string

lz4compress / lz4decompress

LZ4 round-trip. Available at the top level and as crypt.lz4compress / crypt.lz4decompress.

function lz4compress(data: string): string

cache.invalidate

Drops an Instance's cache handle; later lookups return a fresh userdata.

function cache.invalidate(inst: Instance)

cache.iscached

True if the Instance is currently cached.

function cache.iscached(inst: Instance): boolean

cache.replace

Replaces one cache entry with another. Every Lua reference to inst now resolves to replacement.

function cache.replace(inst: Instance, replacement: Instance)

rconsolecreate

Allocates a Windows console window for print output.

function rconsolecreate()

rconsoleprint

Writes text to the rconsole. No newline is appended.

function rconsoleprint(text: string)

rconsolesettitle

Sets the console window's title.

function rconsolesettitle(title: string)

rconsoledestroy

Closes the console window.

function rconsoledestroy()

Drawing.new

Creates a drawing object: Line, Text, Image, Circle, Square, Quad, or Triangle.

function Drawing.new(type: string): DrawingObject

cleardrawcache

Destroys every existing drawing object.

function cleardrawcache()

isrenderobj

True if value is a Drawing object.

function isrenderobj(value: any): boolean

getrenderproperty

Reads a property by name. Equivalent to indexing the object directly.

function getrenderproperty(obj: DrawingObject, property: string): any

setrenderproperty

Writes a property.

function setrenderproperty(obj: DrawingObject, property: string, value: any)

run_on_actor

Compiles source and executes it inside the actor's isolated VM.

function run_on_actor(actor: Actor, source: string, ...)

isparallel

True if the current thread is running in an actor's parallel VM.

function isparallel(): boolean

create_comm_channel / get_comm_channel / destroy_comm_channel

Named message channels for passing data between actor VMs.

function create_comm_channel(): number, BindableEvent