Update README.md

Author: gijsgroenewegen

README.md

@@ -1,4 +1,34 @@
-# By Nichiren
-INSTALLING
+# PyroProgression
+A Cube World steam release mod that adds an alpha like XP and levelling playstyle.
 
-Download CubeModLoader.fip from https://github.com/thetrueoneshots/Cube-World-Mod-Launcher/releases and place it in your Cube World folder (should be Steam\steamapps\common\Cube World). Make a folder called "mods" (without quotes) in your Cube World folder and put `.dll` found in this repository's release in that mods folder.
+## Table of contents
+1. [Introduction](#introduction)
+2. [Description](#description)
+    1. [Features](#features)
+3. [Installation](#installation)
+4. [Changelog](#changelog)
+
+## Introduction
+The idea of adding XP and leveling to Cube World release has been there since the since a few days after the release probably. However, in the past 3 years (since the release), nobody has really attempted to creature such as mod as it involves more that just adding XP and levels. The modding scene was not quite far enough or did not want to put in all the effort to make such a mod. Now, 3 years later, we are finally there. Special thanks to `PyroThunderzz` for convincing me to get started with this mod, enthousiastically bringing in ideas and watching my modding streams. *I guess you have your own mod named after you now...* Big thanks to `S.` and `2 AZ ToufouMaster` for helping me during the development with testing and feedback. On top of that I would like to thank all playtesters of the mod (`CaterpillarCreditUnion`, `Coldurs`, `spenny`, `Shlomopoco`, `Nerah`, `mharr`, `Tabs` and last but definitely not least my man `TheBagel3`), for helping me point out a seemingly infinite amount of bugs.
+
+## Description
+This is a mod that adds XP when killing enemies, levels and scaling of the player, enemies and gear. And all that in a hopefully balanced, intuitive and integrated way. I hope to get you as exited as we were making this mod. Note that this mod does not do anything to the existing region lock. It is balanced around being region locked, but you can still have loads of fun with different region lock mods as they are not game breaking.
+
+### Features
+- XP is gained based on the level, star rating and type of enemy **if and only if you or your pet kills the creature**. *(This means having the actual last damaging hit)*
+- Gaining XP will fill up the XP-bar and your character will Level Up if the treshold is reached.
+- On level up, your health will be restored to full.
+- Each level gives extra stats on your health, damage, crit, haste, armor, resistance and stamina.
+- Each region further away from your starting region *(set automatically)* increases the level of creatures and gear there.
+  - The first region has enemies from LV 1 - 10, and each region afterwards has the levels of their creatures increased by 10.
+- Gear has a level, independent of star rating, which adds stats. A higher level has a higher chance of being better than a lower level, but this does not have to be the case!
+- Gear cost is scaled with region distance.
+- Gold bags give 100 gold base gold and is scaled with region distance.
+- You can only equip gear that is a maximum of 5 levels higher than your current level.
+- Gold drops are scaled by enemy level.
+
+## Installation
+Download the latest version of `PyroProgression_v.x.x.zip` from the latest release from [the release page](https://github.com/thetrueoneshots/PyroProgression/releases). If this `.zip` file includes a `CubeModLoader.fip` you will have to put that file in the same directory as your `cubeworld.exe`. If such a file is not added, you can get the latest modloader release from [the modloader release page](https://github.com/thetrueoneshots/Cube-World-Mod-Launcher/releases). You will have to create a new folder called mods in the folder where your `cubeworld.exe` is located if you do not have one already. You will have to put the `PyroProgression_v.x.x.dll` there. That is all there is to it! Enjoy playing
+
+## Changelog
+- `[v.1.0]` First official release for the PyroProgression mod.