1 files changed, 80 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4053171
--- /dev/null
+++ b/README.md
@@ -0,0 +1,80 @@
+# Upstate Liberty
+https://github.com/Adi23041999/UpstateLiberty
+
+![image](https://i.imgur.com/YdvyCAK.png)
+
+## Installation
+- install Ultimate ASI Loader (https://github.com/ThirteenAG/Ultimate-ASI-Loader)
+- copy the mod files into the game directory
+- supported exe versions: 1.0 only
+- optionally install QOL mods (SilentPatch, Widescreen Fix, SkyGFX)
+
+## Compability notes
+- **SAVES ARE NOT COMPATIBLE!!!**
+- **SilentPatch.asi** crashes if it is not in the same folder as OpenLimitAdjuster.asi (to be fixed in SP update).
+- **Modloader** does not support .asi and .zon files correctly (to be fixed in ML update).
+- Outdated vesions of **gtadebug** cause a crash when starting a New Game in freeroam mode, and spawning vehicles is broken.
+  Both issues are fixed in gtadebug v1.4 (or newer).
+
+## Freeroam setup
+- rename main_d.scm to main.scm
+
+Or
+- install debug menu (https://github.com/aap/debugmenu)
+- install gtadebug (rename iii_debug.dll to iii_debug.asi) (https://github.com/aap/gtadebug)
+- hold 'D' while the game is loading to launch the game in freeroam mode
+
+To teleport to various places in Upstate, use **Square** + **Triangle** + **DPad** (**Jump** + **Enter vehicle** + **Arrow keys** on the keyboard).
+
+## Additional repositories
+- Limit Adjuster (https://github.com/Adi23041999/III.VC.SA.LimitAdjuster/tree/upstate)
+- CLEO (https://github.com/Adi23041999/III.VC.CLEO)
+- gta_studio_max (https://github.com/Adi23041999/gta_studio_max)
+
+## Authors
+
+### Project Lead
+- Adi
+
+### Contributors
+- 1xSYS/HAYA
+- 5d0
+- rww
+- Sergiu
+- Silent
+- universetwisters
+- DeadpoolMKD
+- dkluin
+- Fire_Head
+- Goncaloafs
+- Jago
+- The Truth
+- UnitedMel
+- Yucark
+
+### Special Thanks
+- Luigi's Club
+- re3 Team
+- aap
+- DimZet
+- Sergeanur
+- thelink2012
+- github.com/GTAmodding
+
+### Supporters
+- CallieKills
+- Donald Love
+- DryAgain
+- Gamerjman19
+- KarnyBanan
+- kaycred
+- Lysu
+- macjust99
+- nkjellman
+- Przemokk
+- Rider66
+- sebb
+- Sprenner
+- swifterik
+- TheTeacher313
+- Uriel Sánchez