diff --git a/README.md b/README.md index c03cff0..03f3cbc 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,29 @@ # Northstar -Northstar is a mod and modding framework allowing users to host their own Titanfall 2 servers using custom scripts and assets to create custom content, as well as being able to host vanilla content + +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/R2Northstar/Northstar)](https://github.com/R2Northstar/Northstar/releases) +[![Join the chat at Discord](https://img.shields.io/badge/chat-on%20discord-7289DA.svg)](https://northstar.tf/discord) +[![Read the wiki](https://img.shields.io/badge/wiki-GitBook-important)](https://r2northstar.gitbook.io) + +Northstar is a modding framework client that allows users to host their own Titanfall 2 servers using custom scripts and assets to create custom content, as well as being able to host vanilla content. + +

+Installation | Troubleshooting +

+ +## Development + +Northstar's development is split into 4 repositories: + +1. [NorthstarLauncher](https://github.com/R2Northstar/NorthstarLauncher) (Code for the C++ hook DLL) +2. [NorthstarMods](https://github.com/R2Northstar/NorthstarMods) (Code for the squirrel mods responsible for server gamelogic recreation and custom content) +3. [NorthstarMasterServer](https://github.com/R2Northstar/NorthstarMasterServer) (Responsible for server browser, authentication and persistence) +4. [NorthstarWiki](https://github.com/R2Northstar/NorthstarWiki) (Documentation for Northstar) + +## Special Thanks -This is a repo for packaged Northstar releases and the wiki and as such does not contain any code -Code for the C++ hook DLL can be found [here](https://github.com/R2Northstar/NorthstarLauncher) -Code for the squirrel mods responsible for server gamelogic recreation and custom content can be found [here](https://github.com/R2Northstar/NorthstarMods) -Code for the master server responsible for server browser, authentication and persistence can be found [here](https://github.com/R2Northstar/NorthstarMasterServer) - -The discord can be found [here](https://northstar.tf/discord) - -Thanks to everyone that's put up with me and helped out with this project, it's been a fun passion project i've had throughout 2021 so releasing it is pretty cathartic -Specifically: thanks to the Icepick developers for making the Icepick, I initially forked it for earlier versions of Northstar and it was a great base to experiment with stuff on before moving to the custom launcher -Thanks to everyone on R5R team for giving me advice on some later parts of development -Thanks to everyone in the testing server for putting up with me and helping find bugs -Thanks to everyone else that's helped, gave advice, all that \ No newline at end of file +Thanks to everyone that's put up with me and helped out with this project, it's been a fun passion project I've had throughout 2021 so releasing it is pretty cathartic. Specifically: + +- Thanks to the Icepick developers for making the Icepick, I initially forked it for earlier versions of Northstar and it was a great base to experiment with stuff on before moving to the custom launcher. +- Thanks to everyone on R5R team for giving me advice on some later parts of development +- Thanks to everyone in the testing server for putting up with me and helping find bugs +- Thanks to everyone else that's helped, gave advice, all that \ No newline at end of file