Formatted Documentation

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.{hjson,md}]
+charset = utf-8
+indent_style = space
+indent_size = 4

Documentation/Changelog.md

@@ -0,0 +1,58 @@
+
+# Changelog
+
+<br>
+
+## 1.3   <kbd>  Coming Soon™  </kbd>
+
+-   Yamato rework
+
+-   New Mech
+
+-   New Ship
+
+<br>
+<br>
+
+## 1.2
+
+-   Mech weapon now in the database
+
+-   Reaver ship was re-textured
+
+-   Minor balance tweaks
+
+<br>
+<br>
+
+## 1.1  
+
+-   Mod updated to the newest build `100`  
+
+-   Added Russian localisation
+
+    *Добавлена русская локализация.*
+
+-   Buffed Sister attack-speed, raising her <br>
+    combat and healing capabilities while <br>
+    not making them over-powered.  
+
+-   Lowered build cost for Sister Ship Pad
+
+-   Updated sprites for Yamato Construction <br>
+    Facility (Meltdown Ship Pad) and Reaver bullets.  
+
+-   Reaver weapon rework.
+
+    Raised bullet velocity, no <br>
+    longer keeps ship velocity.  
+
+-   Yamato weapon rework.
+
+    Behaves like real meltdown beam, holding itself. 
+
+    When ship is idle, beam will start sweeping in an arc.  
+
+-   I finally figured out how GitHub works.  
+
+<br>

Documentation/Ships & Mechs/Reaver.md

@@ -0,0 +1,30 @@
+
+# Reaver Ship  
+
+Heavy assault gunship, designed <br>
+for air-ground support actions.
+
+Armed with heavy A100 minigun <br>
+at the cost of weak construction <br>
+and mining projectors.
+
+While ***Reaver*** is gunship's official <br>
+name, people often call it ***Black*** <br>
+***Pearl*** or ***Flying Dutchman***.
+
+Now this ship is literally associated <br>
+with legends of space pirates.  
+
+<br>
+
+| Stat | Value 
+|:----:|:-----:
+| Weapon | `A100`
+| Weapon Damage | `14`
+| Health | `1250`
+| Mine Speed | `150%`
+| Drill Power | `100%`
+| Build Power | `50%`
+| Storage | `120`
+
+<br>

Documentation/Ships & Mechs/Sister.md

@@ -0,0 +1,25 @@
+
+# Sister Ship
+
+Alternative construction ship model <br>
+which trades damage for ability to <br>
+heal buildings.
+
+Unlike Tau Class Mech, Sister Class Ship <br>
+has advantage in mobility, although <br>
+lacks durability and battle capabilities.
+
+<br>
+
+| Stat | Value 
+|:----:|:-----:
+| Weapon | `Structural` <br> `Projector`
+| Weapon Damage | `7`
+| Weapon Healing | `2%`
+| Health | `175`
+| Mine Speed | `125%`
+| Drill Power | `100%`
+| Build Power | `100%`
+| Storage | `26`
+
+<br>

Documentation/Ships & Mechs/Stalker.md

@@ -0,0 +1,30 @@
+
+# Stalker Mech
+
+Heavily armored close combat specialized mech.
+
+The Stalker is equipped with dual proton pulsators <br>
+that shoot in bursts with protonic charges, dealing <br>
+massive damage at close range.
+
+Stalkers cannot be manufactured on the surface, <br>
+so they are constructed on mother-ship and are <br>
+sent to the drop points on request.
+
+Please do not toss them at enemies' meltdowns <br>
+and specters, Stalkers are quite expensive.  
+
+<br>
+
+| Stat | Value 
+|:----:|:-----:
+| Weapon | `Proton` <br> `Pulsators`
+| Weapon Damage | `16`
+| Weapon Shots | `14` *Shotgun <br> Based Weapon*
+| Health | `600`
+| Mine Speed | `150%`
+| Drill Power | `100%`
+| Build Power | `90%`
+| Storage | `48`
+
+<br>

Documentation/Ships & Mechs/Yamato.md

@@ -0,0 +1,32 @@
+
+# Yamato Battlecruiser
+
+510 years of inhuman experiments on a <br>
+Meltdown turrets led us to this pinnacle <br>
+of spacecraft. 
+
+Armed with an amplified version of Meltdown, <br>
+that does not overheat and has a pre-installed <br>
+internal impact reactor that provides fuel.
+
+The best part about this abomination <br>
+is that it is actually able to move!
+
+<br>
+
+| Stat | Value 
+|:----:|:-----:
+| Weapon | `Meltdown`
+| Health | `5000`
+| Mine Speed | `0%`
+| Drill Power | `0%`
+| Build Power | `100%`
+| Storage | `600`
+
+<br>
+
+*In the near future will be either removed from* <br>
+*the mod or fully reworked in favor of a unique* <br>
+*weapon and ability, rather then meltdown.*
+
+<br>

README.md

@@ -1,78 +1,64 @@
-# ExtendedRebuildingModules
-Note: This mod is for V5 and utilizes outdated mechanic and building type, therefore will not be updated for V6+ ever.
-
-This mod aims to add more playable ships and mechs with different specializations.  
-Currently the mod supports 3 new ships and 1 new mech to chose from:
-
-Sister Ship  
-Alternative construction ship model which trades damage for ability to heal buildings.
-Unlike Tau Class Mech, Sister Class Ship has advantage in mobility, although lacks durability and battle capabilities.  
-Weapon: Structural Projector  
-Weapon damage: 7  
-*Weapon healing: 2%  
-*Heal Based Weapon  
-Health: 175  
-Mine speed: 125%  
-Drillpower: 100%  
-Buildpower: 100%  
-Storage: 26
-
-Stalker Mech  
-Heavily armored close combat specialised mech. Stalker is equipped with dual proton pulsators that shoot in bursts of protonic charges, 
-dealing massive damage at close range. Stalkers cannot be manufactured on the surface, 
-so they are constructed on mothership and are sent to the drop points on request. 
-Please do not toss them at enemies' meltdowns and spectres, Stalkers are quite expensive.  
-Weapon: Proton Pulsators  
-Weapon damage: 16  
-*Weapon shots: 14  
-*Shotgun Based Weapon  
-Health: 600  
-Mine speed: 150%  
-Drillpower: 100%  
-Buildpower: 90%  
-Storage: 48  
-
-Reaver Ship  
-Heavy assault gunship, designed for air-ground support actions. 
-Armed with heavy A100 minigun at the cost of weak construction and mining projectors. 
-While 'Reaver' is gunship's official name, people often call it 'Black Pearl' or 'Flying Dutchman'. 
-And now this ship is literally associated with legends of space pirates.  
-Weapon: A100  
-Weapon damage: 14  
-Health: 1250  
-Mine speed: 50%  
-Drillpower: 100%  
-Buildpower: 50%  
-Storage: 120  
-
-**Yamato Battlecruiser  
-510 years of inhuman experiments on a Meltdown turrets led us to this pinnacle of spacecraft. 
-Armed with amplified version of Meltdown, that does not overheat, comes with pre-installed internal impact reactor 
-that fuels the Meltdown onboard. And best part is that this abomination can actually move!  
-*Weapon: Meltdown  
-*Exactly  
-Health: 5000  
-Mine speed: 0%  
-Drillpower: 0%  
-Buildpower: 100%  
-Storage: 600  
-**In the near future will be either removed from the mod or fully reworked in favor of a unigue weapon and ability, rather then meltdown.  
-
-V1.3 coming soon:
-- New Mech
-- New Ship
-- Yamato rework
-
-V1.2 strikes:
-- Reaver ship was resprited
-- Minor balance tweaks
-- Mech weapon is now specified in the database
-
-V1.1:  
-- Mod updated to the newest build 100  
-- Added russian localisation | Добавлена русская локализация.  
-- Buffed Sister attackspeed, raising her combat and healing capabilities while not making them utter good.  
-- Lowered build cost for Sister Ship Pad - Updated sprites for Yamato Construction Facility(Meltdown Ship Pad) and Reaver bullets.  
-- Reaver weapon rework. Raised bullet velocity, no longer keeps ship velocity.  
-- Yamato weapon rework. Behaves like real meltdown beam, holding itself. When ship is idle, beam will start sweeping in an arc.  
-- I finally figured out how github works.  
+
+# Extended Rebuilding Modules   [![Badge Mindustry]][Version 5]
+
+*A **[Mindustry]** mod that adds new specialized ships & mechs.*
+
+<br>
+<br>
+<br>
+
+<div align = center>
+
+[![Button Changelog]][Changelog]
+
+<br>
+<br>
+<br>
+
+## Ships & Mechs
+
+<br>
+
+[![Button Stalker]][Stalker]   
+[![Button Reaver]][Reaver]   
+[![Button Sister]][Sister]
+
+[![Button Yamato]][Yamato]
+
+</div>
+
+<br>
+<br>
+
+## Note
+
+*This mod was designed for **V5** of **Mindustry** and <br>
+is built on outdated game / building mechanics, <br>
+as such it will not be ported to **V6+**.*
+
+<br>
+
+<!----------------------------------------------------------------------------->
+
+[Version 5]: https://github.com/Anuken/Mindustry/releases/tag/v104.6
+[Mindustry]: https://mindustrygame.github.io/
+
+[Changelog]: Documentation/Changelog.md
+[Stalker]: Documentation/Ships%20&%20Mechs/Stalker.md
+[Reaver]: Documentation/Ships%20&%20Mechs/Reaver.md
+[Sister]: Documentation/Ships%20&%20Mechs/Sister.md
+[Yamato]: Documentation/Ships%20&%20Mechs/Yamato.md
+
+
+<!----------------------------------[ Badges ]--------------------------------->
+
+[Badge Mindustry]: https://img.shields.io/badge/Mindustry-v5-d4816b.svg?style=for-the-badge&labelColor=d3a246
+
+
+<!---------------------------------[ Buttons ]--------------------------------->
+
+[Button Changelog]: https://img.shields.io/badge/Changelog-0099E5?style=for-the-badge&logoColor=white&logo=GitBook
+[Button Stalker]: https://img.shields.io/badge/Stalker-Mech-5940a3?style=for-the-badge&labelColor=7856db
+[Button Reaver]: https://img.shields.io/badge/Reaver-Ship-9f3636?style=for-the-badge&labelColor=ce4646
+[Button Sister]: https://img.shields.io/badge/Sister-Ship-558966?style=for-the-badge&labelColor=79c191
+[Button Yamato]: https://img.shields.io/badge/Yamato-Battlecruiser-4d4e58?style=for-the-badge&labelColor=5b5b60

mod.hjson

@@ -0,0 +1,15 @@
+{
+    version : 1.2
+    author : DemonX3
+    name : Extended Rebuilding Modules
+
+    description :
+
+        '''
+
+        You were given licenses for [accent]new types of ships and mechs[].
+
+        Current quantity: 3 Ships | 1 Mech.
+
+        '''
+}