1
mirror of https://github.com/R2Northstar/Northstar synced 2025-09-18 19:30:50 +02:00

Compare commits

..

8 Commits

Author SHA1 Message Date
Alystrasz
7cc8b4104e [chore] removing repositories sections since it has been already implemented in readme 2022-01-05 09:44:45 -03:00
Alystrasz
93d5927f4e [docs] mentioning Discord channels in CONTRIBUTING.md 2022-01-05 09:44:45 -03:00
Alystrasz
39b08c7ab6 [fix] typos 2022-01-05 09:44:45 -03:00
Alystrasz
8607841396 [docs] adding issue template 2022-01-05 09:44:45 -03:00
Alystrasz
541dbd3595 [docs] adding CONTRIBUTING document skeleton 2022-01-05 09:44:45 -03:00
GeckoEidechse
57397bdac3 Add wiki link to README
We already have one via the badge but it's on the smaller side and therefore easy to miss
2022-01-04 14:00:35 -03:00
Barichello
0a30bdf8db Merge pull request #102 from PersonMeetup/main
Improve README.md
2022-01-01 17:11:33 -03:00
Leslie Swan
dc388d5d94 improve README.md
Adds direct links to the wiki and it's installation & troubleshooting
pages, as well as improves the visual formatting.
2022-01-01 12:48:18 -07:00
3 changed files with 58 additions and 13 deletions

16
.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,16 @@
## Expected Behavior
## Actual Behavior
## Steps to Reproduce the Problem
1.
2.
3.
## Specifications
- Northstar version:
- Platform:

15
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,15 @@
# Welcome to Northstar contribution guide
Thank you for investing your time in contributing to our project!
## Issues
### Create a new issue
If you find a bug while using Northstar, before posting it, please ensure that a corresponding issue does not
already exists on GitHub.
Afterwards, please check Discord `faq`, `help` and `bug` channels for corresponding threads.
Also, please double-check that you're opening an issue in the correct repository (read carefully readme `Development` section if you're not sure).

View File

@@ -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.
<p align="center"><strong>
<a href="https://r2northstar.gitbook.io/r2northstar-wiki/installing-northstar/basic-setup">Installation</a> | <a href="https://r2northstar.gitbook.io/r2northstar-wiki/installing-northstar/troubleshooting">Troubleshooting</a> | <a href="https://r2northstar.gitbook.io/">Wiki</a>
</strong></p>
## 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
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