Update README

biorand · Oct 29, 2022 · ec2c6d1 · ec2c6d1
1 parent 7965eca
commit ec2c6d1
Show file tree

Hide file tree

Showing 27 changed files with 46 additions and 3 deletions.
diff --git a/IntelOrca.Biohazard/Program.cs b/IntelOrca.Biohazard/Program.cs
@@ -73,7 +73,7 @@ public static void Generate(RandoConfig config, string re2Path)
                 bgmRandomiser.Randomise(new Rng(config.Seed + 3));
             }
 
-            File.WriteAllText(Path.Combine(modPath, "manifest.txt"), "[MOD]\nName = BIOHAZARD 2: RANDOMIZER\n");
+            File.WriteAllText(Path.Combine(modPath, "manifest.txt"), "[MOD]\nName = BioRand: A Resident Evil Randomizer\n");
         }
 
         public static void GenerateRdts(RandoConfig config, string originalDataPath, string modPath)

diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ted John
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,8 +1,27 @@
+# BioRand: A Resident Evil Randomizer
+A new randomizer for the classic Resident Evil games for PC. Supports sophisticated key item placement, randomized non-key items, randomized enemies, randomized NPCs with matching random voices and random background music. All highly configurable and easy to share seeds and configurations.
 
+The randomizer currently only supports the Sourcenext port of Resident Evil 2 with the Classic REbirth patch.
+
+<a href="https://openrct2.io">
+    <img src="docs/images/screenshot.png" style="width: 256px;" alt="BioRand screenshot"/>
+</a>
+
+## How to use
+
+1. Download the latest release from https://github.com/IntelOrca/biorand/releases.
+2. Extract all the files to a directory of your choice.
+3. Run `biorand.exe` and type or browse for your RE2 game directory under the generate box. If browsing, select your `bio2 1.10.exe` file.
+4. Configure your settings, click `seed` for a random seed and then click generate.
+5. Run RE2 and select the mod: "BioRand: A Resident Evil Randomizer" from the list.
+
+## Reporting issues
+Please report any bugs, crashes or suggestions by raising an issue on https://github.com/OpenRCT2/OpenRCT2/issues.
+Include the seed you were using in your report.
 
 ## Features
 
-### Door randomization
+### Door randomization (coming soon)
 All doors will be changed to link to different rooms. A graph is constructed to provide an alternative route through the game, key items must still be picked up and doors must still be unlocked.
 
 ### Key item randomization
@@ -42,3 +61,6 @@ Randomizes all NPCs in the game and their voice lines. Voice lines are picked ba
 
 All background music tracks are shuffled. Music is shuffled by genre, so danger tracks are swapped with other danger tracks, calm tracks are swapped with other calm tracks.
 Some rooms contining only ambient sound effects, such as the power room in the basement are replaced with music tracks.
+
+## License
+BioRand is licensed under the MIT License.
diff --git a/biorand/MainWindow.xaml.cs b/biorand/MainWindow.xaml.cs
@@ -341,7 +341,7 @@ private bool ShowGamePathWarning()
         private void ShowGenerateCompleteMessage()
         {
             var title = "Randomization Complete!";
-            var msg = "The Randomizer mod has successfully been generated. Run the game and choose \"BIOHAZARD 2: RANDOMIZER\" from the mod selection.";
+            var msg = "The Randomizer mod has successfully been generated. Run the game and choose \"BioRand: A Resident Evil Randomizer\" from the mod selection.";
             MessageBox.Show(this, msg, title, MessageBoxButton.OK, MessageBoxImage.Information);
         }
     }

diff --git a/docs/images/screenshot.png b/docs/images/screenshot.png
diff --git a/docs/images/map_factory_1.png → docs/rdt/images/map_factory_1.png b/docs/images/map_factory_1.png → docs/rdt/images/map_factory_1.png
diff --git a/docs/images/map_factory_2.png → docs/rdt/images/map_factory_2.png b/docs/images/map_factory_2.png → docs/rdt/images/map_factory_2.png
diff --git a/docs/images/map_factory_3.png → docs/rdt/images/map_factory_3.png b/docs/images/map_factory_3.png → docs/rdt/images/map_factory_3.png
diff --git a/docs/images/map_factory_4.png → docs/rdt/images/map_factory_4.png b/docs/images/map_factory_4.png → docs/rdt/images/map_factory_4.png
diff --git a/docs/images/map_lab_b1.png → docs/rdt/images/map_lab_b1.png b/docs/images/map_lab_b1.png → docs/rdt/images/map_lab_b1.png
diff --git a/docs/images/map_lab_b2.png → docs/rdt/images/map_lab_b2.png b/docs/images/map_lab_b2.png → docs/rdt/images/map_lab_b2.png
diff --git a/docs/images/map_lab_b3.png → docs/rdt/images/map_lab_b3.png b/docs/images/map_lab_b3.png → docs/rdt/images/map_lab_b3.png
diff --git a/docs/images/map_lab_b4.png → docs/rdt/images/map_lab_b4.png b/docs/images/map_lab_b4.png → docs/rdt/images/map_lab_b4.png
diff --git a/docs/images/map_lab_b5.png → docs/rdt/images/map_lab_b5.png b/docs/images/map_lab_b5.png → docs/rdt/images/map_lab_b5.png
diff --git a/docs/images/map_rpd_1f.png → docs/rdt/images/map_rpd_1f.png b/docs/images/map_rpd_1f.png → docs/rdt/images/map_rpd_1f.png
diff --git a/docs/images/map_rpd_2f.png → docs/rdt/images/map_rpd_2f.png b/docs/images/map_rpd_2f.png → docs/rdt/images/map_rpd_2f.png
diff --git a/docs/images/map_rpd_3f.png → docs/rdt/images/map_rpd_3f.png b/docs/images/map_rpd_3f.png → docs/rdt/images/map_rpd_3f.png
diff --git a/docs/images/map_rpd_b1.png → docs/rdt/images/map_rpd_b1.png b/docs/images/map_rpd_b1.png → docs/rdt/images/map_rpd_b1.png
diff --git a/docs/images/map_sewage_disposal_area.png → docs/rdt/images/map_sewage_disposal_area.png b/docs/images/map_sewage_disposal_area.png → docs/rdt/images/map_sewage_disposal_area.png
diff --git a/docs/images/map_sewers_b1.png → docs/rdt/images/map_sewers_b1.png b/docs/images/map_sewers_b1.png → docs/rdt/images/map_sewers_b1.png
diff --git a/docs/images/map_sewers_b2.png → docs/rdt/images/map_sewers_b2.png b/docs/images/map_sewers_b2.png → docs/rdt/images/map_sewers_b2.png
diff --git a/docs/images/map_streets_1.png → docs/rdt/images/map_streets_1.png b/docs/images/map_streets_1.png → docs/rdt/images/map_streets_1.png
diff --git a/docs/images/map_streets_2.png → docs/rdt/images/map_streets_2.png b/docs/images/map_streets_2.png → docs/rdt/images/map_streets_2.png
diff --git a/docs/images/map_train.png → docs/rdt/images/map_train.png b/docs/images/map_train.png → docs/rdt/images/map_train.png
diff --git a/docs/images/map_transport.png → docs/rdt/images/map_transport.png b/docs/images/map_transport.png → docs/rdt/images/map_transport.png
diff --git a/docs/rdt_claire.txt → docs/rdt/rdt_claire.txt b/docs/rdt_claire.txt → docs/rdt/rdt_claire.txt
diff --git a/docs/rdt_leon.txt → docs/rdt/rdt_leon.txt b/docs/rdt_leon.txt → docs/rdt/rdt_leon.txt