From b9de299118d8f74622f2ec41b20354c92cb46385 Mon Sep 17 00:00:00 2001
From: strongleong <nikita_chul@mail.ru>
Date: Sun, 6 Feb 2022 23:42:59 +1100
Subject: [PATCH] Updated `README.md`

---
 README.md | 97 ++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 56 insertions(+), 41 deletions(-)

diff --git a/README.md b/README.md
index 9e32db7..ac4ff58 100644
--- a/README.md
+++ b/README.md
@@ -1,52 +1,67 @@
-ScrapModLoader
+WIP ScrapModLoader
 ==============
 
 This applications is for managing mods for Scrapland.
 
+**WARNING! THIS PROJECT IS IN DEVELOPMENT. ALL WRITTEN IN THIS DOCUMENT IS SUBJECT TO CHANGE**
+
+
+## How to use
+
+ScrapModLoader after first start will create `Scrapland Mods` folder in User's `Document` folder
+and scans yours installed programs for any Scrapland instalation. If it could not find any you will be promt with error message.
+
+You can specify Scrapland installation location in settings.
+
+By default this app will search for mods in `Scrapland Mods` in User's `Document` folder, 
+and you can put all your mods in there, or add any folder you want in 
+settings and app will search for mods there.
+
+ScrapModLoader supports both original and remastered versions of Scrapland.
+
+
 ## How To Make Mod
 
-Mod for Scrapland is a *.sm file that basically is a zip arhive with following content:
+For now mod for Scrapland is a *.sm file that basically is a zip arhive with following content:
 
-| Filename    | Description										|
-|-------------|-------------------------------------------------|
-| icon.png    | Icon for mod that will show up in mod loader	|
-| meta.ini    | Information about mod							|
-| data.packed | Container with all mod game assets				|
+| Filename			 | Description									|
+|--------------------|----------------------------------------------|
+| icon.png			 | Icon for mod that will show up in mod loader	|
+| config.xml		 | Information about mod						|
+| <filename\>.packed | Container with all mod game assets			|
 
-### meta.ini structure
-```ini
-[Miscellaneous]
-Title="Mod Title"
-Description="A mod description"
+### meta.ini sample
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<ScrapMod>
+	<Title>Mod Title</Title>
+	<Description>Mod Desciption</Description>
 
-Category=A category
-Version=1.0
-RequiredLauncher=1.0
-RequiredGame=1.1
+	<Category>Category</Category>
+	<Version>1.0</Version>
+	<RequiredLauncher>1.0</RequiredLauncher>
+	<RequiredGame>1.1</RequiredGame>
+	
+	<Author name="Author1" website="https://example.com" />
+	<Author name="Author2" />
+	
+	<Credits group="Mod author">
+		<Credit name="Author1" />
+	</Credits>
+	<Credits group="Some credit" >
+		<Credit name="Credit1" />
+		<Credit name="Credit2" />
+		<Credit name="Credit3" />
+	</Credits>
+</ScrapMod>
+```
 
-AuthorGroup=Group 1
-AuthorGroup=Group 2
+## TODO:
 
-[Author]
-Name=Mod author
-Website=http://example.com
-
-[Author]
-Group=Group 1
-Name=Mod author
-
-[Author]
-Group=Group 2
-Name=Another author
-
-[Setting]
-Name=setting
-Title=Setting titile
-Tooltip=Some setting
-Type=Int
-Min=1
-Max=10
-Default=2
-File=scripts/char/ditritus.py
-Placeholder=<speed>
-```
\ No newline at end of file
+ - [X] Support for custom *.packed
+ - [X] Supoprt for Scrapland Remastered
+ - [ ] Support for custom game files (i.e. `\Traslation\` files or custom `QuickConsole.py`)
+ - [ ] Recompiling *.py to *.pyc
+ - [ ] Mod settings.
+ - [ ] More meta info in `config.xml`
+ - [ ] More mods :wink:
\ No newline at end of file