🛡️ Vanguard Framework

A modding API & toolset for Solarpunk (Cyberwave, UE5)
Version v1.1.1  •  Requires UE4SS for Solarpunk  •  ✅ Steam & Game Pass

✨ What is it?

Vanguard Framework is a Lua scripting layer built on top of RE-UE4SS for Solarpunk. It gives you a structured API that other mods can build on, plus a full set of in-game console commands for direct use.

It exposes modules to control the player, world, airship, inventory, world devices and more — all without PAK files, new assets, or any change to game files.

💡 Install it and you're ready to go. Open the console with ~ and type vf help to see everything.

🎮 What you can do

• 🏃 Player — movement speed, home point, teleport.
• 🌍 World — time of day, weather, skip night, pause.
• 🚁 Airship — refill battery, repair hull, teleport to cockpit, summon the ship.
• 👥 Multiplayer — co-op player list, teleport to / summon players.
• 🎒 Inventory & Items — give any of 298 items, set quantities, stack-size overrides, chest expansions.
• 🔧 Tools — durability multipliers (x1 → x10, or infinite).
• ⚙️ World Devices — Ore Drills, Batteries, Sprinklers, Fuel Generators, Solar Panels, Windmills, Wooden & Sky Turbines, Electric & Fuel Furnaces, Transport Drones, plus BuildAnywhere.
• 🎛️ Cheats & toggles — refill stats, grow plants, free build/craft, fly mode, infinite survival stats.
• ⌨️ Keyboard Shortcuts — 25 keybinds across 4 toggleable groups.

• vf player — Movement speed, home point, teleport
• vf world — Time of day, weather, skip night, pause
• vf airship — Battery refill, hull repair, status, tp, pull/call
• vf multiplayer — Co-op player list, tp, pull/call
• vf item — Give items, list all 298 known items
• vf inv — Slot giving, quantity set, stack overrides, chest expansions
• vf tool — Tool durability overrides (x1–x10, infinite) and status
• vf cheat / vf cheattoggle / vf cheatdev — Survival refill, grow plants, free build/craft, fly, infinite stats
• vf shortcuts — Enable/disable keyboard shortcut groups
• vf device — Control all supported world devices + BuildAnywhere
• vf config — Persistent key/value settings
• vf gameplay — Apply preset configs (requires Vanguard Gameplay)
• vf debug — Inventory dump, class finder, item cache rebuild, CDO dump

🧩 Build your own mod on top of it

Drop a Scripts/vanguard_api.lua file in your mod folder. The Framework auto-discovers and loads it at startup, passing the full VF API as the first argument:

-- YourMod/Scripts/vanguard_api.lua
local VF = ...
local M = {}

VF.Events.On("PlayerReady", function(char)
    local speed = VF.Config.Get("yourmod.speed", 800)
    VF.Player.SetSpeed(speed)
end)

M.HandleCommand = function(Parameters, OutputDevice)
    -- handle your own vf subcommands here if needed
end

return M

Available modules: VF.Player, VF.World, VF.Airship, VF.Inventory, VF.Devices, VF.Shortcuts, VF.Config, VF.Events, VF.Utils, VF.Debug.

📦 Installation

1. Install UE4SS for Solarpunk in the game's binaries folder (Win64 on Steam, WinGDK on Game Pass).
2. Extract the download and copy VanguardFramework/ into ue4ss/Mods/VanguardFramework/.
3. Launch the game. The UE4SS log should show: [VF] Vanguard Framework loaded successfully!
4. Open the console (~) and type vf help to verify.

📖 Documentation

The docs/ folder ships with full references:

• docs/api.md — Full API reference (start here to build a mod on top of the framework).
• docs/commands.md — Complete command reference with syntax, arguments and examples.
• docs/items.md — Full list of all 298 items for vf item give.
• docs/technical.md — Technical notes, confirmed class names, field reference for Solarpunk UE 5.7.1.

⚠️ What it does NOT do

• Add new items, meshes, textures, crops, animals, islands or recipes (those need PAK files).
• Synchronize changes in multiplayer — all modifications are local to the client running the mod.

🚧 In active development

Solarpunk launched on June 8, 2026, and both the game and this framework are updated frequently. Command syntax and API signatures may change between versions; breaking changes are documented in the changelog. Found a bug or a class name that changed after a game update? Please report it in the comments.