diff --git a/docs/README.md b/docs/README.md index be4d59a5..48275ae7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -24,7 +24,7 @@ Install instructions can be found here: For modding guides, documentation on Northstar API features and documentation on Respawn Squirrel look at: -{% embed url="https://r2northstar.readthedocs.io/" %} +{% embed url="https://docs.northstar.tf/Modding/" %} ## Contact and contributing diff --git a/docs/development/contributing-code-to-northstar.md b/docs/development/contributing-code-to-northstar.md index 98cf7701..37e881ca 100644 --- a/docs/development/contributing-code-to-northstar.md +++ b/docs/development/contributing-code-to-northstar.md @@ -31,6 +31,11 @@ To get the cropped GIFs of a screenrecording: (The linked site has not been vetted, use at own risk) 4. Upload GIF to GitHub pull request description by just pasting it at the appropriate location. +### Useful links + +- [How to write a commit message](https://cbea.ms/git-commit/) +- [Atomic commits](https://www.freshconsulting.com/insights/blog/atomic-commits/) + ### Avoiding "PR hell" _"PR hell"_ is what contributors refer to when a pull request is stuck as pending without any indication for progress. diff --git a/docs/development/releases.md b/docs/development/releases.md index 4145f0c2..aed3b3db 100644 --- a/docs/development/releases.md +++ b/docs/development/releases.md @@ -27,9 +27,9 @@ The process is ever changing in order to simplify it so these steps outlined mig The current process of making release (includinging release candidate) is: -1. Make release branch (`MAJOR.MINOR.X`) (if not exists) +1. Make release branch (`MAJOR.MINOR.X`) (only if commits need to be cherry-picked) -2. Merge desired commits from `main` +2. Take desired commits from `main` - Make sure to consider whether changing are breaking in regards to older/newer server/client and in regards to Squirrel API. - Older/newer client/server breakage might need to be version gated and should **NOT** be done in patch releases. - Squirrel API changes likely breaks mods and should **NOT** be done in patch releases. Additionaly make sure to ping modders on release or preferably even in advance. diff --git a/docs/modding/README.md b/docs/modding/README.md index 55ec4652..410a61d8 100644 --- a/docs/modding/README.md +++ b/docs/modding/README.md @@ -1,6 +1,6 @@ # Modding -Northstar Modding documentation has moved over to: [https://r2northstar.readthedocs.io/](https://r2northstar.readthedocs.io/). +Northstar Modding documentation has moved over to: [https://docs.northstar.tf/Modding/](https://docs.northstar.tf/Modding/). ## Custom Skin Modding diff --git a/docs/other/moderation/rules.md b/docs/other/moderation/rules.md index 33a8ff85..5f2da3c4 100644 --- a/docs/other/moderation/rules.md +++ b/docs/other/moderation/rules.md @@ -25,6 +25,7 @@ This is a public server that anyone is welcome to join. As such, we expect every **14. Good manners.** This means strictly no topics that would divert or derail the current conversation being held, especially those of sexual innuendos. **15. No hating/flaming about moderation decisions**. If you want to discuss moderation decisions (bans, mutes, changes, ...) please open a staff only ticket in #help . Harassing a mod will get you banned. **16. Follow Discord ToS**. If Discord doesn't allow it, we won't allow it either. +**17. No alts**. Alt accounts are not allowed. Note that as we cannot track everyone and their accounts we might miss some so we rely on your help for reporting. ────────────────────────────────────────────────────────────────────────────────────────────────────── **Ban Guidelines** @@ -48,9 +49,8 @@ Please note: **Staff and Other VIPs may be exempt** (to some extent) from any of these rules due to their reputation in the community, if you feel like they should be warned for a violation you should report to staff For questions regarding Discord's Privacy Policy or Terms of Use, please refer to the documents here () -`Last Updated: 2024-07-14` +`Last Updated: 2024-08-18` -New users, **you can go to #installation to find out how to install Northstar** as well as read the FAQ if you have any questions -**If you get an issue whilst installing/playing please open a ticket in #help** (Do not go to #general to fix it) +**If you have any issues regarding Northstar during your time playing or installing**, please open a support ticket in <#922663326994018366>. This channel is dedicated to helping users and should be used for this purpose instead of `#⁠general` and other similar chats. ``` diff --git a/docs/steamdeck-and-linux/installing-on-steamdeck-and-linux.md b/docs/steamdeck-and-linux/installing-on-steamdeck-and-linux.md index 509da673..6bbd06e5 100644 --- a/docs/steamdeck-and-linux/installing-on-steamdeck-and-linux.md +++ b/docs/steamdeck-and-linux/installing-on-steamdeck-and-linux.md @@ -15,11 +15,18 @@ NorthstarProton has some problems and may stop working at any point, if this hap On Steam Deck, complete the following in desktop mode. You may return to game mode once completed _(A mouse + keyboard plugged into the Deck are recommended for easier navigation of menus)_ 1. Make sure you ran the vanilla version of Titanfall2 at least once on Linux! - * If you use an Nvidia GPU you may need to start the game using Proton 6.3-8 for the first time + * If Titanfall 2 fails to launch, you may have to delete the game's Proton prefix and reinstall using another version of Proton. + 1. To do this, head to `~/.local/share/Steam/steamapps/compatdata` if you installed Steam via a native package, or the Flatpak equivalent. + 2. Delete the folder named `1237970` + 3. Set Titanfall 2 to launch with `Proton 6.3-8` or `Proton 7.0-6` in the _Properties_ -> _Compatibility_ section. + 4. Launch the game and allow the install to completely finish. + 5. Set Titanfall 2 to launch with a more current version of Proton, NorthstarProton, or Proton GE. + 6. If Titanfall 2 still fails to launch, delete the prefix again and try installing with the other version of Proton. 2. Install the latest version of Northstar using [FlightCore](../installing-northstar/northstar-installers#geckoeidechse-flightcore), [Viper](../installing-northstar/northstar-installers#0negal-viper), or do it manually 1. For manual install download the latest version of Northstar from the [releases](https://github.com/R2Northstar/Northstar/releases) page 2. Then extract all contents of the file to your Titanfall 2 folder ( Right click _Titanfall 2_ > Open _Properties_ > Click _Local Files_ > Click _Browse_ ) -3. Install NorthstarProton +3. Install NorthstarProton or a current version of Proton GE. + * In some user cases, NorthstarProton may not work. You may instead try Proton GE, which is also available through the following methods. 1. **Protonup-QT**: Click _About_, then tick the box to enable _advanced mode_. You should be able to select and install NorthstarProton from the _Add version_ menu. 2. **ProtonPlus**: NorthstarProton can also be installed via ProtonPlus. 3. **Manual**: Download the latest release of [NorthstarProton](https://github.com/cyrv6737/NorthstarProton/releases/), extract it, and place the folder in one of the following directories: