RedFunctions

- Introduction -

There is a whole class of small things a Cyberpunk mod can only do by depending on Cyber Engine Tweaks - not because they need Lua, but because nobody exposed the engine call to Redscript. Checking whether an archive is installed is a good example: pure RedScript mods simply cannot ask.

RedFunctions is a RED4ext plugin that aims to close those gaps, one small native at a time. Archive and resource queries, the real-world clock, jailed file access, the OS clipboard, raw mouse input, runtime-generated archives, and input suppression for overlays - all callable from plain Redscript.

TL;DR - The engine calls RedScript always deserved! (ﾉ◕ヮ◕)ﾉ

- For Mod Authors -

One import, the full surface:

import RedFunctions.*

// archives and resources

RedFunc. ArchiveExists("my_cool_mod") // -> Bool. ".archive" optional, case-insensitive

RedFunc. ArchiveList() // -> array<String>, every mounted mod archive, sorted

RedFunc. ResourceExists("base\\path\\file.xbm") // -> Bool. Does this path resolve, from any source

RedFunc. Version() // -> String, plugin semver

// real-world clock (the os.date / os.time RedScript never had)

RedFunc. RealTimestamp() // -> Double, unix epoch seconds

RedFunc. RealDate() // -> String, local "YYYY-MM-DD HH:MM:SS"

RedFunc. RealDateFormat("%H:%M", false) // -> String, strftime; second arg = UTC

RedFunc. RealClockMs() // -> Uint64, monotonic ms - for durations

// read-only text files, jailed to the game directory

RedFunc. FileExists("r6\\config\\thing.json") // -> Bool

RedFunc. ReadTextFile("r6\\config\\thing.json", 200) // -> array<String>, first N lines (max 2000)

// generated TweakXL files - write .yaml into r6\tweaks, loaded next boot

RedFunc. WriteTweakFile("MyMod/prices.yaml", lines) // -> Bool; parent dirs created

RedFunc. DeleteTweakFile("MyMod/prices.yaml") // -> Bool

// mod state - write .json/.txt into r6\storages, read it back with ReadTextFile

RedFunc. WriteStorageFile("MyMod/state.json", lines) // -> Bool

RedFunc. DeleteStorageFile("MyMod/state.json") // -> Bool

// the OS clipboard - ink text fields never had it

RedFunc. GetClipboardText() // -> String (UTF-8, empty if not text)

RedFunc. SetClipboardText("some text") // -> Bool

// mouse: absolute position (menus) and raw deltas (gameplay)

RedFunc. MouseX01() // -> Float 0.. 1 in the window, -1 = una