Stay in Tarkov
A SPT-Aki mod to be used with SPT-Aki Server to allow the Coop Module to communicate with the SPT-Aki Server.
@@ -17,32 +19,111 @@ A SPT-Aki mod to be used with SPT-Aki Server to allow the Coop Module to communi
This is the SERVER modification of [SPT-Aki](https://www.sp-tarkov.com/) to allow the [Coop Module](https://github.com/stayintarkov/StayInTarkov.Client) to communicate with the SPT-Aki Server.
-## How to use this Repo?
-* Install SIT via the Launcher (or manually)
-* Download and Install the latest SPT-Aki Server
-* Download the [latest "Source code" release](https://github.com/stayintarkov/SIT.Aki-Server-Mod/releases) (preferred) or use the code clone above (if you are feeling brave and like bugs)
-* Install this repo into the server /user/mods/ folder
-* Rename the folder SITCoop
+
+
+ Table of Contents
+
+ -
+ About The Project
+
+ -
+ Getting Started
+
+ - Contact
+ - Roadmap
+ - Contributing
+ - Acknowledgments
+ - License
+
+
+
+
+
+
+## About The Project
+
+Stay In Tarkov (SIT) is a Escape From Tarkov mod designed for cooperative play.
+
+Stay In Tarkov is currently under development by a small team of developers. While SIT is playable, there are many bugs, synchronization and performance issues during gameplay. Escape From Tarkov and SPT-AKI updates frequently and oftentimes, your progress must be reset.
+
+In other words, SIT is not a perfect replacement of the live experience: always keep in mind that game breaking bugs and progression issues will occur and there are no way around it.
+
+
+
+## Getting Started
+
+All the information you'll need to get SIT setup can be found on our docs [here](https://stayintarkov.com/docs)
+
+Please make sure you have read the docs before coming to us in the Discord as they likely contain the answers you're looking for
+
+
+
+## Roadmap
+Our roadmap can be found [here](https://docs.stayintarkov.com/en/plans.html)
+
+
+## Contact/Support
+
+The best place to get in contact with us is likely on the SIT Discord.\
+Our Discord invite link can be found at https://stayintarkov.com/discord
+
+
+
+## Contributing
+
+* Pull requests are encouraged and deeply appreciated. Thanks to all contributors!
+
+* Code contributions have a strict NO GCLASSXXX policy. If your code has a GCLASS that is neccessary to it working please provide the Pull Request with the list so that they can be remapped before merging.
+
+
+
+## License
+
+* 99% of the original core and single-player functionality completed by SPT-Aki teams. There are licenses pertaining to them within this source
+
+* Paulov's work is unlicensed. Unlicensed does not allow any unauthorized or commericial use of Paulov's work. Credit must be provided.
+
+* SIT team's work is MIT licensed
+
+* [RevenantX LiteNetLib](https://github.com/RevenantX/LiteNetLib) is MIT licensed
+
+* [DrakiaXYZ](https://github.com/DrakiaXYZ/) projects contain the MIT License (as of 1.10, Drakia's projects are no longer embedded)
+
+
+
+
+## Acknowledgments & Thanks
+
+* [Paulov Ko-Fi Donations](https://ko-fi.com/paulovt) (original creator of Stay in Tarkov)
+* [Mihai Ko-Fi Donations](https://ko-fi.com/mmihai)
+* [Trippy](https://github.com/trippyone)
+* [Bullet](https://github.com/devbence)
+* [Dounai](https://github.com/dounai2333)
+* [SPT-Aki team](https://www.sp-tarkov.com/) (Credits provided on each code file used and much love to their Dev team for their support)
+* [DrakiaXYZ](https://github.com/DrakiaXYZ/)
+* [Contributors](https://github.com/stayintarkov/SIT.Aki-Server-Mod/graphs/contributors) and the original contributors of Paulov's SIT.Core
+* [RevenantX LiteNetLib](https://github.com/RevenantX/LiteNetLib)
+
+
+
+
+[contributors-shield]: https://img.shields.io/github/contributors/stayintarkov/SIT.Aki-Server-Mod.svg?style=for-the-badge
+
+[contributors-url]: https://github.com/stayintarkov/SIT.Aki-Server-Mod/graphs/contributors
+
+[forks-shield]: https://img.shields.io/github/forks/stayintarkov/SIT.Aki-Server-Mod.svg?style=for-the-badge&color=%234c1
-## How do I set up this mod?
+[forks-url]: https://github.com/stayintarkov/SIT.Aki-Server-Mod/network/members
-### Coop Config JSON
-* You must configure the file called coopConfig.json in your SITCoop/config folder. This file is auto generated on first run of the mod.
+[stars-shield]: https://img.shields.io/github/stars/stayintarkov/SIT.Aki-Server-Mod?style=for-the-badge&color=%234c1
-#### IF you are using PORT FORWARDING
-* In the file you must use the following config, replacing `127.0.0.1` with your own IPv4 from https://www.whatismyip.com and set useExternalIPFinder to false
-* OR set useExternalIPFinder to true
+[stars-url]: https://github.com/stayintarkov/SIT.Aki-Server-Mod/stargazers
-#### IF you are using HAMACHI or other VPN service
-* set useExternalIPFinder to false
-* set externalIP to your desired IP from the service
+[downloads-total-shield]: https://img.shields.io/github/downloads/stayintarkov/SIT.Aki-Server-Mod/total?style=for-the-badge
-### Http.json
+[downloads-latest-shield]: https://img.shields.io/github/downloads/stayintarkov/SIT.Aki-Server-Mod/latest/total?style=for-the-badge
-* Open Aki_Data\Server\configs\http.json with your favourite text editor
-* Change the `ip` setting to your internal network IP of your Computer Primary Network (Ethernet or Wi-Fi)
-* Change the `logRequests` setting to `false` to prevent log spam
## Installing SPT-Aki to Azure Web Services