Browse Source

Update readme

habeebweeb 4 years ago
parent
commit
84fcc7fa1b
6 changed files with 44 additions and 16 deletions
  1. 44 16
      README.md
  2. BIN
      img/example_kankyo.png
  3. BIN
      img/example_scene.png
  4. BIN
      img/screeny.jpg
  5. BIN
      img/screeny2.jpg
  6. BIN
      img/screeny3.jpg

+ 44 - 16
README.md

@@ -1,25 +1,53 @@
-# ModMM
+# ModifiedMM
 
-Make MultipleMaids great again.
+All the good stuff from [modifiedMM](https://git.coder.horse/meidomustard/modifiedMM) but with a new scene manager.
 
-Decompiled version of 22.2 with some edits.
+## Features
 
-## Edits done
+* A more visual focused UI
+* Save both scenes and kankyo (backgrounds) to PNG files
+* Create folders for simple grouping of scenes/kankyo
+* No limits for number of scenes/kankyo (aside from available hard drive space)
 
-* Removed EXE filters
-* Split `MultipleMaids.cs` into partial classes for easier editing
-* Removed constructor and moved variable initialization into class body
-* Formatted code with CodeFormatter
-* RAM fix by a fellow anon
-* Fix for COM3D2 1.32.1
-* Read BGs and Prop Items from PhotoMode instead of having them hardcoded
+## Installation
 
-## Note
+Grab the latest release over [here](https://git.coder.horse/habeebweeb/modifiedMM/releases)
 
-The code is still messy and requires a lot of editing.
+Place `COM3D2.MultipleMaids.Plugin.dll` in your game's `Sybaris\UnityInjector` folder.
 
-Credits go to the original dev of MultipleMaids.
+## Usage
 
-### Message to original author
+Since the scene manager is a replacement for the save manager, it can be accessed through the same methods.
 
-Learn to code, mate.
+## First Run Conversion
+
+Opening the scene manager for the first time will convert all your scenes and kankyo to png files and will put them in `COM3D2\Mod\MultipleMaidsScene` and `COM3D2\Mod\MultipleMaidsKankyo` respectively.
+
+The conversion process will add this
+
+```
+[scenemanager]
+converted=true
+```
+
+to your `MultipleMaids.ini` config file which is used only by the scene manager so that it does not run the conversion process again. The conversion process does not modify your ini in any other way.
+
+### Example Scene
+
+![Example Scene](img/example_scene.png)
+
+### Example Kankyo
+
+![Example Kankyo](img/example_kankyo.png)
+
+## Converting PNG Scenes Back to an Ini
+
+A converter and instructions on how to use it can be found over [here](https://github.com/habeebweeb/MultipleMaids.SceneSaveConverter/releases/latest). 
+
+## Screenshots
+
+![Scene Manager](img/Screeny.jpg)
+
+![Scene Management](img/Screeny2.jpg)
+
+![Kankyo Manager](img/Screeny3.jpg)

BIN
img/example_kankyo.png


BIN
img/example_scene.png


BIN
img/screeny.jpg


BIN
img/screeny2.jpg


BIN
img/screeny3.jpg