diff --git a/README.md b/README.md index 15cdd6b..e82a406 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,24 @@ https://robertsspaceindustries.com/orgs/LUG This script is designed to help you optimize your system to run Star Citizen as smoothly as possible. It presents options to check your system for optimal settings and helps you change them as needed to prevent game crashes. -It also includes an easy way for you to wipe your `USER` folder as is recommended after major version updates. It will back up your exported keybinds, delete your `USER` folder, then restore your keybinds. +It also gives you a fast and easy way to wipe your `USER` folder as is recommended by CIG after major version updates. It will back up your exported keybinds, delete your `USER` folder, then restore your keybind file(s). -To export your keybinds from within the game, go to: -`Options->Keybindings->Control Profiles->Save Control Settings` +## Options: + +`Check vm.max_map_count for optimal performance` +- We recommend setting this to 16777216 to give the game access to sufficient memory. +- The helper will offer to set it for you or show you the commands to do it yourself. + +`Delete my USER folder and preserve my keybinds` +- The helper will make backups of any exported keybinds, delete your Star Citizen USER folder, then restore your keybind files. +- To export your keybinds from within the game, go to: `Options->Keybindings->Control Profiles->Save Control Settings` +- To re-import your keybinds from within the game, select them from the list: `Options->Keybindings->Control Profiles` + +`Delete my shaders only` +- Sometimes all you need to do between major version updates is delete your shaders directory. + +`Delete my DXVK cache` +- A troubleshooting step that sometimes helps fix various issues + +`Switch the helper between LIVE and PTU` +- Toggle between targeting LIVE or PTU for all of the above options. Defaults to LIVE on each run.