Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/psiberx/cp2077-tweak-xl

Cyberpunk 2077 mod that allows you to modify TweakDB.
https://github.com/psiberx/cp2077-tweak-xl

Last synced: about 6 hours ago
JSON representation

Cyberpunk 2077 mod that allows you to modify TweakDB.

Awesome Lists containing this project

README

        

# TweakXL

TweakXL is a modding tool and a framework to create mods that modify TweakDB,
a proprietary database of REDengine 4,
containing essential information about game entities and behavior.

- [YAML](https://github.com/psiberx/cp2077-tweak-xl/wiki/YAML-Tweaks) and [RED](https://github.com/psiberx/cp2077-tweak-xl/wiki/RED-Tweaks) formats for manipulating data in a declarative style
- [Script extensions](https://github.com/psiberx/cp2077-tweak-xl/wiki/Script-Extensions) to add complex logic and dynamic changes
- [Hot reloading](https://github.com/psiberx/cp2077-tweak-xl/wiki/Modder-Tools) to speed up development
- Focused on mods compatibility and maintainability

## Getting Started

### Compatibility

- Cyberpunk 2077 2.2
- [redscript](https://github.com/jac3km4/redscript) 0.5.27+

### Installation

1. Install requirements:
- [RED4ext](https://docs.red4ext.com/getting-started/installing-red4ext) 1.26.1+
2. Extract the release archive `TweakXL-x.x.x.zip` into the Cyberpunk 2077 directory.

## Documentation

- [TweakDB](https://github.com/psiberx/cp2077-tweak-xl/wiki/TweakDB)
- [YAML Tweaks](https://github.com/psiberx/cp2077-tweak-xl/wiki/YAML-Tweaks)
- [RED Tweaks](https://github.com/psiberx/cp2077-tweak-xl/wiki/RED-Tweaks)
- [Script Extensions](https://github.com/psiberx/cp2077-tweak-xl/wiki/Script-Extensions)
- [Modder Tools](https://github.com/psiberx/cp2077-tweak-xl/wiki/Modder-Tools)
- [Examples](https://github.com/psiberx/cp2077-tweak-xl/wiki/Examples)