Update readme (#355)

* Update Readme.md

* add logo and shields

* remove config/manifest section, add uninstall notes

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 - 2021 Aleksander Waage (AmazingAlek), Ricardo Lopes (Raicuparta), Henry Pointer (_nebula / misternebula), and TAImatem.
+
+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.

OWML.sln

@@ -60,6 +60,13 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OWML.Temp", "src\OWML.Temp\
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OWML.ExampleAPI", "src\SampleMods\OWML.ExampleAPI\OWML.ExampleAPI.csproj", "{F56A9B0D-420F-493F-9B53-0CCD218A895E}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{C7F76E72-1CF2-4C0D-8A39-3D13EB868119}"
+	ProjectSection(SolutionItems) = preProject
+		LICENSE = LICENSE
+		owmllogo.png = owmllogo.png
+		Readme.md = Readme.md
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

Readme.md

@@ -1,3 +1,10 @@
+![logo](owmllogo.png)
+![GitHub](https://img.shields.io/github/license/amazingalek/owml?style=flat-square)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/amazingalek/owml?style=flat-square)
+![GitHub Release Date](https://img.shields.io/github/release-date/amazingalek/owml?label=last%20release&style=flat-square)
+![GitHub all releases](https://img.shields.io/github/downloads/amazingalek/owml/total?style=flat-square)
+![GitHub release (latest by date)](https://img.shields.io/github/downloads/amazingalek/owml/latest/total?style=flat-square)
+
 # Outer Wilds Mod Loader
 
 OWML is the mod loader and mod framework for Outer Wilds. It patches Outer Wilds to load mods, and provides mods a framework to interact with the game. OWML is inspired by SMAPI for Stardew Valley.
@@ -16,17 +23,26 @@ With Outer Wilds Mod Manager (recommended):
 2. Use the Mod Manager to install OWML and mods, and start the game.
 
 Manual install:
-1. Download OWML and extract the zip file anywhere you want.
-2. [Download Outer Wilds mods](https://outerwildsmods.com/mods) and put them in the Mods folder, each mod in a separate folder.
+1. Download latest OWML release and extract the zip file anywhere you want.
+2. [Download Outer Wilds mods](https://outerwildsmods.com/mods) and put them in the `mods` folder, each mod in a separate folder.
 3. Start the game with OWML.Launcher.exe.
 
+## Uninstall
+- If using Outer Wilds Mod Manager, first refer to it's uninstall guide.
+- If not, delete OWML folder.
+- Verify integrity of game files - OWML edits the game code to load itself, so verification is needed to remove the changes.
+  - Steam : Right click on game > Properties > Local files > Verify integrity of game files
+  - Epic : Three dots next to game > Verify
+
+If you want to keep mod data intact but still play without mods, verifying the game files is enough. Just make sure to run the game through Steam/Epic, *not* OWML.Launcher.exe.
+
 ## For modders
 
 Refer to the sample mods in the source code for examples. These mods are not included in releases.
 
 ### Get started
 
-1. Create a C# class library project targeting .Net Framework 3.5.
+1. Create a C# class library project targeting .Net Framework 4.0.
 2. Install the [OWML Nuget package](https://www.nuget.org/packages/OWML/).
 3. Reference the following files in {gamePath}\OuterWilds_Data\Managed:
     * Assembly-CSharp.dll
@@ -36,60 +52,25 @@ Refer to the sample mods in the source code for examples. These mods are not inc
 	
 For more info, see [For modders](https://github.com/amazingalek/owml/wiki/For-modders).
 
-## Configuration
-
-OWML is configured in the in-game MODS menu, or in OWML.Config.json:
-
-|Key|Description|
-|---|-----------|
-|gamePath|The path to the game files. OWML will try to locate the game automatically.|
-|debugMode|If enabled, a lot more information is written to the console. Intended for developers.|
-|combinationsBlockInput|If this is true, mod input combinations will block game input.|
-
-Each mod is defined in a manifest.json file:
-
-|Key|Description|
-|---|-----------|
-|filename|The filename of the DLL containing the ModBehaviour class.|
-|author|The name of the author.|
-|name|The name of the mod.|
-|uniqueName|Usually {author}.{uniqueName}.|
-|version|The version number.|
-|owmlVersion|The version of OWML the mod was built for.|
-|dependencies|Array of dependency names. Make sure to use the unique name.|
-
-Each mod can be configured in the in-game MODS menu, or in config.json:
-
-|Key|Description|
-|---|-----------|
-|enabled|Whether or not the mod will be loaded. Default: true.|
-|requireVR|Whether or not the mod requires VR to work. Default: false.|
-|settings|An object of mod-specific settings. Default: empty.|
-
-Example:
-~~~~
-{
-  "enabled": true,
-  "requireVR": false,
-  "settings": {
-    "enableMusic": true,
-    "foo": "bar",
-    "lol": 1337
-  }
-}
-~~~~
-
-More info about config can be found [here](https://github.com/amazingalek/owml/wiki/For-modders#mod-config).
-
 ## Compatibility
 
-* Compatible with all versions of Outer Wilds.
-* Custom menus only work with the latest version of Outer Wilds - 1.0.7.
+|Version|Compatible|
+|-|-|
+|1.1.10|Yes|
+|1.1.9|Unknown|
+|1.1.8|Unknown|
+|1.0.0 - 1.0.7|No|
 
-## Feedback
+OWML is compatible with Echoes of the Eye, and works on both Epic and Steam installations.
 
-I'm working tightly with the mod community to improve OWML and aid in mod development. 
-I'm Alek on the [Outer Wilds Discord](https://discord.gg/csKYR3w).
+## Feedback and Support
+
+OWML is developed by the same people making the mods!
+On the [Outer Wilds Discord](https://discord.gg/csKYR3w), we are (in purple role colors) :
+- alek
+- Raicuparta
+- _nebula
+- TAImatem
 
 Feature requests, bug reports and PRs are welcome on GitHub.
 
@@ -98,7 +79,7 @@ Feature requests, bug reports and PRs are welcome on GitHub.
 Authors:
 * [AmazingAlek](https://github.com/amazingalek)
 * [Raicuparta](https://github.com/Raicuparta/)
-* [Mister_Nebula](https://github.com/misternebula)
+* [_nebula](https://github.com/misternebula)
 * [TAImatem](https://github.com/TAImatem)
 
 Special thanks to:
@@ -106,12 +87,12 @@ Special thanks to:
 * [Outer Wilds on Discord](https://discord.gg/csKYR3w)
 * [Outer Wilds on Reddit](https://www.reddit.com/r/outerwilds)
 * Inspired by (and some code from) [SMAPI](https://smapi.io)
+* OWML logo banner by _nebula
 
 Dependencies:
 * [dnpatch](https://github.com/ioncodes/dnpatch)
 * [dnlib](https://github.com/0xd4d/dnlib)
-* [Harmony](https://github.com/pardeike/Harmony)
-* [Json.Net.Unity3D](https://github.com/SaladLab/Json.Net.Unity3D)
+* [HarmonyX](https://github.com/BepInEx/HarmonyX)
 * [ObjImporter](https://wiki.unity3d.com/index.php?title=ObjImporter)
 * [NAudio-Unity](https://github.com/WulfMarius/NAudio-Unity)
 * [Gameloop.Vdf](https://github.com/shravan2x/Gameloop.Vdf)