psiberx / cp2077-red-hot-tools

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Red Hot Tools

This plugin aims to help in the Cyberpunk 2077 mods development, offering the following features:

  • Hot reload archives, scripts and tweaks
  • See scripts validation and binding errors
  • Prevent game from starting if scripts compilation fails
  • Inspect entities and world nodes

For greater convenience it integrates with other tools:

  • WolvenKit: Pack & reload archives from the editor with a press of a button
  • Visual Studio Code: Reload scripts and tweaks from the editor using context menu or hotkeys
  • Cyber Engine Tweaks: Reload assets using in-game menu and inspect world nodes and entities

Getting Started

Compatibility

Installation

  1. Install requirements:
  2. Extract the release archive RedHotTools-x.x.x.zip into the Cyberpunk 2077 directory.
  3. (Optional) Install CET UI: Extract the archive RedHotTools-x.x.x-CET.zip into the Cyberpunk 2077 directory.
  4. (Optional) Install VS Code extension: Drag the red-hot-vscode-x.x.x.vsix onto your VS Code extension bar.

Visual Studio Code

With extension installed, when editing scripts or tweaks files in VS Code, you'll get new editor commands in the menu to hot reload the scripts or tweaks. As any other command they can also be bound to hotkeys.

Limitations

  • Struct fields are not reinitialized (if you change the fields of a struct and an instance of that struct exists during hot reload, this can lead to issues)
  • Handlers for scriptable systems requests aren't registered on scripts load, if you add a new handler you have to reload the game session

About

License:MIT License


Languages

Language:C++ 72.0%Language:Lua 23.6%Language:Python 3.7%Language:TypeScript 0.8%