Merge branch 'master' of https://github.com/Banane9/NeosRenameDirectl…

…yLinkedDynVars

README.md

@@ -1,8 +1,18 @@
-# ModNameGoesHere
+Rename Directly Linked DynVars
+==============================
 
-A [NeosModLoader](https://github.com/zkxs/NeosModLoader) mod for [Neos VR](https://neos.com/) that does x.
+A [NeosModLoader](https://github.com/zkxs/NeosModLoader) mod for [Neos VR](https://neos.com/) that allows changing any directly linked dynamic variables when renaming the Dynamic Variable Space.\\
+Optionally, LogiX string inputs matching `OldName/.*` can be changed too.
+
+This was based on a request from seif1 on the Neos Modding Discord.
 
 ## Installation
 1. Install [NeosModLoader](https://github.com/zkxs/NeosModLoader).
-1. Place [ModNameGoesHere.dll](https://github.com/GithubUsername/RepoName/releases/latest/download/ModNameGoesHere.dll) into your `nml_mods` folder. This folder should be at `C:\Program Files (x86)\Steam\steamapps\common\NeosVR\nml_mods` for a default install. You can create it if it's missing, or if you launch the game once with NeosModLoader installed it will create the folder for you.
-1. Start the game. If you want to verify that the mod is working you can check your Neos logs.
+1. Place [RenameDirectlyLinkedDynVars.dll](https://github.com/Banane9/NeosRenameDirectlyLinkedDynVars/releases/latest/download/RenameDirectlyLinkedDynVars.dll) into your `nml_mods` folder. This folder should be at `C:\Program Files (x86)\Steam\steamapps\common\NeosVR\nml_mods` for a default install. You can create it if it's missing, or if you launch the game once with NeosModLoader installed it will create the folder for you.
+1. Start the game. If you want to verify that the mod is working you can check your Neos logs.
+
+## In Game
+
+Changing the variable names at all, as well as changing matching LogiX string inputs can be toggled in the config.
+
+![Changing the name on a namespace in game](https://github.com/Banane9/NeosRenameDirectlyLinkedDynVars/raw/master/screenshots/Neos_lpvWFl3lGr.gif)