diff --git a/README.md b/README.md index deee471..7c26e5e 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,34 @@ # GWF_PowerUpInjector -Ever wanted to introduce powerups into an already made GWF workshop map? Now you can with the GWF Powerup Injector. It allows you to select any downloaded workshop map, inject powerup spawners at procedural locations, and save. +Ever wanted to introduce powerups into an existing GWF Workshop map? Now you can with the **GWF PowerUp Injector**. It allows you to select any downloaded Workshop map, inject powerup spawners at procedurally chosen locations, and save. -# License/Disclaimer +# License / Disclaimer -GWF_PowerUpInjector is licensed under the General Public License 3.0, you are free to use GWF_PowerUpInjector, both it and its source code, under the terms of the GPL. GWF_PowerUpInjector is distributed in the hope it will be useful and enjoyed, but it comes WITHOUT ANY WARRANTY, without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, see the LICENSE file for more information. +GWF_PowerUpInjector is licensed under the **GNU General Public License v3.0 (GPL-3.0)**. You are free to use GWF_PowerUpInjector (and its source code) under the terms of the GPL. GWF_PowerUpInjector is distributed in the hope that it will be useful and enjoyed, but it comes **WITHOUT ANY WARRANTY**; without even the implied warranty of **MERCHANTABILITY** or **FITNESS FOR A PARTICULAR PURPOSE**. See the LICENSE file for more information. -This repo is in no shape or form associated with Blacklight Interactive or Team17 and the developers. These tools are developed to allow users enhance the already enjoyable experience of Golf With Your Friends. +This repository is not associated with Blacklight Interactive, Team17, or the developers. These tools are developed to allow users to enhance the already enjoyable experience of *Golf With Your Friends*. # Instructions 1. Download the latest release of the tool. -2. Extract and run GWF_PowerupInjector.exe -3. Enter the path to your Steam directory - - Only needs done if the tool doesn't find the Steam directory automatically. -4. Select the workshop map from the left list -5. Navigate to the PowerUps section and click "Generate". -6. Load the map as usual within Golf With Your Friends +2. Extract and run `GWF_PowerUpInjector.exe`. +3. Enter the path to your Steam directory. + - This is only needed if the tool doesn't find the Steam directory automatically. +4. Select the Workshop map from the list on the left. +5. Navigate to the **PowerUps** section and click **Generate**. +6. Load the map as usual within *Golf With Your Friends*. # Problems and Troubleshooting -- Currently the application appends powerups to the current map. This means clicking the 'Generate' button multiple times would double the amount in the map each time. If you do this and wish to revert the map there are two options: - a) Re-download (un-subscribe and re-subscribe in Steam) the map. - - OR +- Currently, the application appends powerups to the current map. This means clicking **Generate** multiple times will add duplicate powerups each time. If this happens and you want to revert the map, you have two options: - b) Restore the Map.old file in the Steam workshop directory (Ex: C:\Program Files (x86)\Steam\steamapps\workshop\content\431240\[MAP_ID]). + a) Re-download the map (unsubscribe and re-subscribe in Steam). + + **OR** + + b) Restore the `Map.old` file in the Steam Workshop directory + (e.g., `C:\Program Files (x86)\Steam\steamapps\workshop\content\431240\[MAP_ID]`). # Notes -- This was developed for the Steam version of Golf With Your Friends. \ No newline at end of file + +- Developed for the Steam version of *Golf With Your Friends*.