diff options
Diffstat (limited to 'docs/development')
| -rw-r--r-- | docs/development/README.md | 4 | ||||
| -rw-r--r-- | docs/development/releases.md | 27 | ||||
| -rw-r--r-- | docs/development/repositories/northstarlauncher.md (renamed from docs/development/northstarlauncher.md) | 0 | ||||
| -rw-r--r-- | docs/development/repositories/northstarmods.md | 9 | ||||
| -rw-r--r-- | docs/development/testing.md | 15 |
5 files changed, 40 insertions, 15 deletions
diff --git a/docs/development/README.md b/docs/development/README.md index 56acd02..a624676 100644 --- a/docs/development/README.md +++ b/docs/development/README.md @@ -6,6 +6,10 @@ description: >- # Development +Check the subpages on the sidebar for various aspects of Northstar development. + +## Repositories + Check the following page for information about different code repositories Northstar uses {% content-ref url="repositories/" %} diff --git a/docs/development/releases.md b/docs/development/releases.md index bcee236..4145f0c 100644 --- a/docs/development/releases.md +++ b/docs/development/releases.md @@ -39,7 +39,7 @@ The current process of making release (includinging release candidate) is: Push tags ending in `-rcX` where `X` is integer for 1. Launcher 2. Mods - 3. Release (wait until launcher has finished building) + 3. Release 4. Make draft notes\ You can use FlightCore to generate them and then format them manually.\ @@ -61,7 +61,7 @@ The current process of making release (includinging release candidate) is: Push tags for 1. Launcher 2. Mods - 3. Release (wait until launcher has finished building) + 3. Release 10. Once release has finished building 1. Go to GitHub release and select the new unpublished release @@ -69,15 +69,8 @@ The current process of making release (includinging release candidate) is: 3. Click checkbox for creating discussion and select _Release_ as category 4. Publish -11. Post announcements on Discord - 1. Post message in `#server-hosting-announcements` channel.\ - Make sure to highlight server hosting specific changes.\ - Make thread for bug reports. - 2. Post message in `#modding-announcements`.\ - Make sure to highlight modding specific changes (API changes etc). - 3. Post message in `#announcements`.\ - Make sure to highlight end-user specific changes (new features, certainn fixes, etc). - +11. Post release announcement on Discord in `#releases` channel. + Make sure to highlight aspects relevant for server hosters, modders, and end-users. 12. Update main menu promos version on Atlas @@ -139,3 +132,15 @@ Once `2.0` has been released, expectations for `3.0` tend to be lower as the num - Make at least one release candidate and test it before actual release. - Release should also only ever be latest release candidate but tagged as release to avoid introducing new bugs. + + +## Other repos + +Repos like navmeshes and DiscordRPC get their release unrelated to main Northstar release numbering as they usually only see a few release per year due to + + +### DiscordRPC + +Push new tag which in turn will generate a release. Tags are formatted as `vN` where `N` is an always increasing integer, i.e. `v4`, `v5`, `v6`, etc. + +Once a new DiscordRPC release has been made, the version number needs to be bumped in the [release repo](https://github.com/R2Northstar/Northstar) to pull the new release. diff --git a/docs/development/northstarlauncher.md b/docs/development/repositories/northstarlauncher.md index 89aeca4..89aeca4 100644 --- a/docs/development/northstarlauncher.md +++ b/docs/development/repositories/northstarlauncher.md diff --git a/docs/development/repositories/northstarmods.md b/docs/development/repositories/northstarmods.md index 1798661..40ea4f0 100644 --- a/docs/development/repositories/northstarmods.md +++ b/docs/development/repositories/northstarmods.md @@ -5,3 +5,12 @@ description: Core squirrel mods # NorthstarMods TODO + +When adding new Sqirrel script source files that are from the base game, make sure to commit the unmodified file first. +In particular, on `main` they should committed as `Respawn` with the email address `respawn@northstar.tf`. + +```sh +git -c user.name="Respawn" -c user.email="<respawn@northstar.tf>" commit -m "Add SQUIRREL_FILE.nut from VPK_NAME" +``` + +This process is done to later leverage the power of `git blame` to see who authored a particular code line which assists with better understanding changes in the codebase. diff --git a/docs/development/testing.md b/docs/development/testing.md index 8ba01ff..9125453 100644 --- a/docs/development/testing.md +++ b/docs/development/testing.md @@ -46,7 +46,8 @@ The tool is still being improved upon but already more than usable. Check its RE Before starting, make sure you have a **working and up-to-date Northstar install** and you're **logged into GitHub with your GitHub account** (downloading files from CI only works while logged into any GitHub account)! -1. Head to the bottom of the page of the PR and click on "_Show all checks_"  +1. Head to the bottom of the page of the PR and click on "_Show all checks_"\ +   2. For "_CI / build (pull\_request)_" click on "_Details_"\   3. From here click on "_Summary_"\ @@ -55,7 +56,7 @@ Before starting, make sure you have a **working and up-to-date Northstar install   5. Once downloaded, open the zip and copy `Northstar.dll` and `NorthstarLauncher.exe` to your Titanfall2 folder, overwriting the existing DLL and EXE in there. -Alternatively, compiling the PR'd code from source is also an option. For this, refer to [northstarlauncher.md](northstarlauncher.md "mention") +Alternatively, compiling the PR'd code from source is also an option. For this, refer to [northstarlauncher.md](repositories/northstarlauncher.md) #### NorthstarMods @@ -67,7 +68,7 @@ Click on _"Code"_ and then on _"Download ZIP"_  -From there copy over all the `Northstar.XXXXX` folders into your mods folder in your TItnafall2 install the same way you would manually install mods. +From there copy over all the `Northstar.XXXXX` folders into your mods folder in your Titanfall2 install the same way you would manually install mods. ## Tips and toolkits @@ -105,9 +106,15 @@ By default duplicate accounts are blocked by server. Use `-allowdupeaccounts` wh Use `map <map name>` to quickly switch map.\ Example: `map mp_glitch` -List of maps can be found [here](../hosting-a-server-with-northstar/dedicated-server/#maps) +List of maps can be found [here](../hosting-a-server-with-northstar/server-settings/file-names.md#maps) **Speed-up/slow-down game** Use `host_timescale <factor>` to speed-up or slow-down the game.\ For example `host_timescale 10` speeds up game by factor of `10`. Set to `1` to go back to default. + +**Viewing Navmeshes** + +Requires `sv_cheats 1` and `enable_debug_overlays 1`. + +Use `navmesh_debug_hull 1` to view navmeshes. |