diff --git a/README.md b/README.md new file mode 100644 index 0000000..856507c --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# CyberEngineTweaks Mod Manager + +## Features + +- A Mod Manager for CyberEngineTweaks based mods +- Enable/Disable CyberEngineTweaks based mods inside game with a single click +- Open the interface by pressing `Ctrl + Shift + C` + +The default key is set to `C`. You can change it at Line 19 in the `init.lua` file. You can find Key Codes at https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes + +```lua +Hotkey = 0x43 -- Change Hotkey Here. +``` + +## Installation + +This mod requires **CyberEngineTweaks** Mod. Please Install it first. https://github.com/yamashi?tab=repositories + +Put `cet_mod_manager` folder inside `\Cyberpunk 2077\bin\x64\plugins\cyber_engine_tweaks\mods\` + +Restart the game. Or reload Mods from the CyberEngineTweaks Console. + +## Usage + +1. To use it, you just simply press `Ctrl + Shift + C` to open the inertface. + +2. Press the button `Scan` to scan your installed mods. + +3. Tick/untick the checkbox in front of the mod name to enable/disable them. + +4. Press the `Reload ALL Mods` button on the console to reload the mods. + +## Uninstallation + +1. Before you uninstall this mod, make sure you have **re-enabled** all the mods. + +2. Remove the `cet_mod_manager` folder from `\Cyberpunk 2077\bin\x64\plugins\cyber_engine_tweaks\mods\` + +3. Restart the game. Or reload Mods from the CyberEngineTweaks Console. + + *To uninstall CyberEngineTweaks please follow its uninstall instruction. + +## Known Bug + +None + +## Credits + +- yamashi's CyberEngineTweaks https://github.com/yamashi?tab=repositories +- WhySoSerious for answering every question I had about lua https://github.com/WSSDude420 +- Development Team behind CyberEngineTweaks and and RED4extSDK +- CP77 Modding Tools Discord Community https://discord.gg/cp77modding