diff --git a/.github/workflows/add-to-project.yml b/.github/workflows/add-to-project.yml new file mode 100644 index 00000000..da04da24 --- /dev/null +++ b/.github/workflows/add-to-project.yml @@ -0,0 +1,16 @@ +name: add-to-project + +on: + issues: + types: + - opened + +jobs: + add-to-project: + name: Add to project + runs-on: ubuntu-latest + steps: + - uses: actions/add-to-project@v0.5.0 + with: + project-url: "https://github.com/orgs/R2Northstar/projects/3" + github-token: "${{ secrets.PROJECT_BOARD_TOKEN }}" diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index f5bcd4f1..2befa783 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -47,18 +47,19 @@ ## Modding and Development * [Modding](modding/README.md) -* [Development](modding-and-development/development/README.md) - * [Repositories](modding-and-development/development/repositories/README.md) - * [Atlas](modding-and-development/development/repositories/atlas.md) - * [NorthstarMods](modding-and-development/development/repositories/northstarmods.md) - * [NorthstarLauncher](modding-and-development/development/northstarlauncher.md) - * [NorthstarMasterServer (old)](modding-and-development/development/northstarmasterserver/README.md) - * [Deploy](modding-and-development/development/northstarmasterserver/deploy.md) - * [Contributing code to Northstar](modding-and-development/development/contributing-code-to-northstar.md) - * [Testing](modding-and-development/testing.md) - * [Reviewing](modding-and-development/development/reviewing.md) - * [Releases](modding-and-development/development/releases.md) +* [Development](development/README.md) + * [Repositories](development/repositories/README.md) + * [Atlas](development/repositories/atlas.md) + * [NorthstarMods](development/repositories/northstarmods.md) + * [NorthstarLauncher](development/northstarlauncher.md) + * [NorthstarMasterServer (old)](development/northstarmasterserver/README.md) + * [Deploy](development/northstarmasterserver/deploy.md) + * [Contributing code to Northstar](development/contributing-code-to-northstar.md) + * [Testing](development/testing.md) + * [Reviewing](development/reviewing.md) + * [Releases](development/releases.md) ## Other +* [Discord moderation](other/moderation.md) * [Credits](other/credits.md) diff --git a/docs/contributing.md b/docs/contributing.md index b953b61e..083cae5b 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -12,4 +12,4 @@ Read [CONTRIBUTING.md](https://github.com/R2Northstar/Northstar/blob/main/CONTRI Please remember that issues created in the Northstar repositories should be related to the mod, avoid creating issues asking for tech support or problems unrelated to the project. {% endhint %} -Check the [Development](modding-and-development/development/README.md) section if you are unsure of where to open a ticket. +Check the [Development](development/README.md) section if you are unsure of where to open a ticket. diff --git a/docs/modding-and-development/development/README.md b/docs/development/README.md similarity index 100% rename from docs/modding-and-development/development/README.md rename to docs/development/README.md diff --git a/docs/modding-and-development/development/contributing-code-to-northstar.md b/docs/development/contributing-code-to-northstar.md similarity index 100% rename from docs/modding-and-development/development/contributing-code-to-northstar.md rename to docs/development/contributing-code-to-northstar.md diff --git a/docs/modding-and-development/development/northstarlauncher.md b/docs/development/northstarlauncher.md similarity index 100% rename from docs/modding-and-development/development/northstarlauncher.md rename to docs/development/northstarlauncher.md diff --git a/docs/modding-and-development/development/northstarmasterserver/README.md b/docs/development/northstarmasterserver/README.md similarity index 55% rename from docs/modding-and-development/development/northstarmasterserver/README.md rename to docs/development/northstarmasterserver/README.md index e40cef53..d6c94b5d 100644 --- a/docs/modding-and-development/development/northstarmasterserver/README.md +++ b/docs/development/northstarmasterserver/README.md @@ -8,7 +8,7 @@ The old NodeJS master server has been replaced in favour of the Go rewrite calle The master server is responsible for centralizing game servers created by players, it also verifies that connecting players own an Origin account with Titanfall 2. -There's no need to host your own master server to play games with other people, you can use [direct connect](../../../using-northstar/direct-connect.md) or just setup a [normal server](../../../hosting-a-server-with-northstar/basic-listen-server.md) that announces itself to `northstar.tf`. This tutorial is aimed for those who want to contribute improvements to the code or test their own changes to the project. +There's no need to host your own master server to play games with other people, you can use [direct connect](../../using-northstar/direct-connect.md) or just setup a [normal server](../../hosting-a-server-with-northstar/basic-listen-server.md) that announces itself to `northstar.tf`. This tutorial is aimed for those who want to contribute improvements to the code or test their own changes to the project. ## Contents diff --git a/docs/modding-and-development/development/northstarmasterserver/deploy.md b/docs/development/northstarmasterserver/deploy.md similarity index 100% rename from docs/modding-and-development/development/northstarmasterserver/deploy.md rename to docs/development/northstarmasterserver/deploy.md diff --git a/docs/development/releases.md b/docs/development/releases.md new file mode 100644 index 00000000..bcee236d --- /dev/null +++ b/docs/development/releases.md @@ -0,0 +1,141 @@ +--- +description: >- + Information intended mostly for internal use on what to consider when making + new releases +--- + +# Releases + +{% hint style="info" %} +WIP +{% endhint %} + +## General + +CI on Northstar release repo builds versioned release if tag is pushed. It checks Launcher and Mods for the same tag. +It then downloads the related build for Launcher from releases and the Squirrel related source files from the mods repo. +It then combines the files together with DiscordRPC and navmeshes to build the final release. \ +Therefore make sure to push tags of Mods and Launcher first (and make sure Launcher has finished building). + +CI also pushes release directly to Thunderstore as a mod called [`Northstar`](https://northstar.thunderstore.io/package/northstar/Northstar/). \ +If it's a release-candidate with the `-rcX` suffix, it will instead get pushed to Thunderstore as [`NorthstarReleaseCandidate`](https://northstar.thunderstore.io/package/northstar/NorthstarReleaseCandidate/). + +### The process of making a release: + +The following is a rough draft of the steps needed to make a release. +The process is ever changing in order to simplify it so these steps outlined might not be up-to-date anymore depending on when you are reading this. + +The current process of making release (includinging release candidate) is: + +1. Make release branch (`MAJOR.MINOR.X`) (if not exists) + +2. Merge 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. + - If changes can be merged fast-forward use `git merge --ff-only origin/main` otherwise cherry-pick relevant commits. + +3. Make release candidate\ + Push tags ending in `-rcX` where `X` is integer for + 1. Launcher + 2. Mods + 3. Release (wait until launcher has finished building) + +4. Make draft notes\ + You can use FlightCore to generate them and then format them manually.\ + If you use FlightCore make sure to remove already released commits if they were cherry-picked. + +5. Create a draft discussion in [release repo discussions](https://github.com/R2Northstar/Northstar/discussions) + +6. Make related github-org thread and link the draft notes there for feedback etc + +7. Ping playtesters to test release candidate. + 1. Add information about what specific aspect to test. + 2. Copy relevant changes for this release candidate from draft release notes. + 3. Link draft release notes. + 4. Make thread to leave feedback about release in. + +8. Wait until release candidate was sufficiently tested. + +9. Make release + Push tags for + 1. Launcher + 2. Mods + 3. Release (wait until launcher has finished building) + +10. Once release has finished building + 1. Go to GitHub release and select the new unpublished release + 2. Copy release notes from draft. + 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). + + +12. Update main menu promos version on Atlas + +13. Push Docker image + 1. Get SHA512 checksum of zip from release CI + 2. Make PR to [Docker repo](https://github.com/pg9182/northstar-dedicated) to update Docker image to newest Northstar release + 3. Merge PR + 4. Wait for Docker repo CI to finish + 5. Approve image + +14. Observe version roll-out via [Grafana dashboard](https://northstar-stats.frontier.tf/). + +### Git commands for tags: + +**For release candidates:** + +``` +git tag vX.Y.Z-rcN +git push origin vX.Y.Z-rcN +``` + +Example: + +``` +git tag v1.8.0-rc1 +git push origin v1.8.0-rc1 +``` + +**For actual releases** + +``` +git tag vX.Y.Z +git push origin vX.Y.Z +``` + +Example: + +``` +git tag v1.8.0 +git push origin v1.8.0 +``` + +## Version numbering + +In general, Northstar tries to follow [semantic versioning](https://semver.org/). This means version numbers are `MAJOR.MINOR.PATCH`, where + +- `MAJOR` is updated for breaking changes +- `MINOR` is updated for changes that are backwards compatible +- `PATCH` is updated for fixes that are backwards compatible + +Semantic versioning is however not followed exactly. For example, to ship out smaller features faster they have been included in patch releases. Similarly, there have been smaller breaking changes, yet at the time of writing the major version number so far has never been updated. + +The reason for this is mostly due to player expectations. Players expect the change from `1.0` to `2.0` to be big. As such, the plan for the near future is to update the major version, once we have a bigger feature ready to release that brings us closer to vanilla in terms of missing features (e.g. _Frontier Defense_). + +Once `2.0` has been released, expectations for `3.0` tend to be lower as the number is no longer "doubled". Past `3.0`, proper semver can probably be employed without hampering player expectations. + + +## Best practices: + +- 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. diff --git a/docs/modding-and-development/development/repositories/README.md b/docs/development/repositories/README.md similarity index 100% rename from docs/modding-and-development/development/repositories/README.md rename to docs/development/repositories/README.md diff --git a/docs/modding-and-development/development/repositories/atlas.md b/docs/development/repositories/atlas.md similarity index 100% rename from docs/modding-and-development/development/repositories/atlas.md rename to docs/development/repositories/atlas.md diff --git a/docs/modding-and-development/development/repositories/northstarmods.md b/docs/development/repositories/northstarmods.md similarity index 100% rename from docs/modding-and-development/development/repositories/northstarmods.md rename to docs/development/repositories/northstarmods.md diff --git a/docs/modding-and-development/development/reviewing.md b/docs/development/reviewing.md similarity index 94% rename from docs/modding-and-development/development/reviewing.md rename to docs/development/reviewing.md index 920df356..a9d89341 100644 --- a/docs/modding-and-development/development/reviewing.md +++ b/docs/development/reviewing.md @@ -19,15 +19,15 @@ It's not necessary to do both when reviewing as long as you mention what you did For code review head to the _"Files changed"_ section of the PR. -![](../../.gitbook/assets/review1.png) +![](../.gitbook/assets/review1.png) From there you can select the line(s) you want to leave a comment on. -![](../../.gitbook/assets/review2.PNG) +![](../.gitbook/assets/review2.PNG) Type in your comment and click on _"Start a review"_. -![](../../.gitbook/assets/review3.png) +![](../.gitbook/assets/review3.png) Note that this will **NOT** post your comment immediately! Add any remaining comments to other lines of code, then head to the _Finishing up_ section of this wiki page to see how to post your code review. @@ -38,7 +38,7 @@ Note that this will **NOT** post your comment immediately! Add any remaining com For testing a PR, refer to the following page {% content-ref url="../testing.md" %} -[testing.md](../testing.md) +[testing.md](./testing.md) {% endcontent-ref %} The TL;DR is to test the aspect that has been changed. @@ -47,7 +47,7 @@ The TL;DR is to test the aspect that has been changed. After you performed the testing and/or code review leave a final comment by clicking on _"Finish your review"_ on the top right of the _"Files changed"_ page of the PR. -![](../../.gitbook/assets/review4.png) +![](../.gitbook/assets/review4.png) In your final comment make sure to mention what you did, e.g. which aspects of the change you tested for or what you considered during code review (formatting, edge cases, ...). The more detailed this part is the easier it is for other reviewers to tell which aspects they can skip during reviewing to speed up the process. diff --git a/docs/modding-and-development/testing.md b/docs/development/testing.md similarity index 98% rename from docs/modding-and-development/testing.md rename to docs/development/testing.md index 2be33c2d..8ba01ff9 100644 --- a/docs/modding-and-development/testing.md +++ b/docs/development/testing.md @@ -55,7 +55,7 @@ Before starting, make sure you have a **working and up-to-date Northstar install ![rcon4](https://user-images.githubusercontent.com/40122905/179727511-877641f8-e5fc-4a34-bcf1-29bafefc1ad2.png) 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](development/northstarlauncher.md "mention") +Alternatively, compiling the PR'd code from source is also an option. For this, refer to [northstarlauncher.md](northstarlauncher.md "mention") #### NorthstarMods diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md b/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md index b21e33ed..d508b696 100644 --- a/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md +++ b/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md @@ -17,7 +17,7 @@ The current minimum requirements are as follows: - 5GB free disk space (+3 GB if you're on windows due to origin and deps) - 3+ cores (2 might work, though) - 3GB+ total memory (RAM or swap will do) -- Windows 8.1 (and built-in WARP [use `-softwared3d11`] or a graphics card) + or wine 6.0.0+ (and dxvk+lavapipe+x11, wined3d+llvmpipe+x11, or a working graphics setup with dxvk or llvmpipe) (see [this](https://github.com/pg9182/northstar-dedicated) for more) +- Windows 8.1 (and built-in WARP \[use `-softwared3d11`\] or a graphics card) + or wine 6.0.0+ (and dxvk+lavapipe+x11, wined3d+llvmpipe+x11, or a working graphics setup with dxvk or llvmpipe) (see [this](https://github.com/pg9182/northstar-dedicated) for more) **Per instance:** diff --git a/docs/images/vtol-download-github-portable.png b/docs/images/vtol-download-github-portable.png new file mode 100644 index 00000000..2863fe75 Binary files /dev/null and b/docs/images/vtol-download-github-portable.png differ diff --git a/docs/images/vtol-download-github.png b/docs/images/vtol-download-github.png new file mode 100644 index 00000000..6207c963 Binary files /dev/null and b/docs/images/vtol-download-github.png differ diff --git a/docs/images/vtol-locate.png b/docs/images/vtol-locate.png index 8a800cdd..6a1fadbb 100644 Binary files a/docs/images/vtol-locate.png and b/docs/images/vtol-locate.png differ diff --git a/docs/images/vtol-main-window.png b/docs/images/vtol-main-window.png index 7b039280..76c4769c 100644 Binary files a/docs/images/vtol-main-window.png and b/docs/images/vtol-main-window.png differ diff --git a/docs/images/vtol-northstar-installation-info.png b/docs/images/vtol-northstar-installation-info.png index b043a44d..acd2a5b4 100644 Binary files a/docs/images/vtol-northstar-installation-info.png and b/docs/images/vtol-northstar-installation-info.png differ diff --git a/docs/installing-northstar/northstar-installers/vtol-guide.md b/docs/installing-northstar/northstar-installers/vtol-guide.md index 06c269b6..c7785f2e 100644 --- a/docs/installing-northstar/northstar-installers/vtol-guide.md +++ b/docs/installing-northstar/northstar-installers/vtol-guide.md @@ -1,6 +1,15 @@ # VTOL Guide -VTOL is a mod manager for installing and managing mods for the Northstar client made for Titanfall 2. You can find links to install it on the [Northstar website](https://northstar.tf), or on [VTOL's GitHub page](https://github.com/R2NorthstarTools/VTOL). +VTOL is a mod manager for installing and managing mods for the Northstar client made for Titanfall 2. + +VTOL works on Windows only and you can find links to download it on [Northstar's website](https://northstar.tf) or [VTOL's GitHub repo](https://github.com/R2NorthstarTools/VTOL). +Installing it from the website automatically installs the latest version that will automatically update itself. +On the GitHub repo, you can download the newest version by clicking one of two options. +Note that the portable is just a `.exe` file and not the installer, as such it won't automatically update itself. + +![VTOL installer download (on GitHub, automatically updates](../../images/vtol-download-github.png) + +![VTOL portable download (on GitHub, doesn't automatically update](../../images/vtol-download-github-portable.png) ## Main Menu @@ -8,24 +17,24 @@ VTOL is a mod manager for installing and managing mods for the Northstar client **The _Main Menu_ of VTOL is where you'll probably spend most of your time.** -This menu has a lot of useful information, such as the _"version of VTOL"_ you have, the _"version of Northstar"_ you have, if the Master Server is online, _"whether EA App/Origin are currently open"_, and a _"place to set your game path"_. +This menu has a lot of useful information, such as the version of VTOL you have, the version of Northstar you have, if the Master Server is online, whether EA App/Origin are currently open, and a place to set your game path. ## Version Numbers -You can see what _"version of VTOL/Northstar"_ you have in the top left corner of the VTOL window. +In the top left corner of the VTOL window you can see what versions of VTOL and Northstar you have installed. ![Version Numbers](../../images/vtol-version-numbers.png) ## Master Server/EA or Origin online -These small tabs near the middle of the VTOL window show you whether the Master Server for Northstar is currently online, and if EA or Origin is running properly on your computer. If the EA/Origin tab is red, solving that will be covered later (See: Settings section later on).\ +These small tabs near the middle of the VTOL window show you whether the Master Server for Northstar is currently online, and if EA or Origin is running properly on your computer. If the EA/Origin tab is red, make sure to open EA/Origin first.\ If you are unsure if you have EA or Origin, you have EA. ![Server/EA/Origin Status](../../images/vtol-server-status.png) ## Northstar Installation/Locate Titanfall 2 Install -The final parts of the Main Menu are at the bottom, showing your game's directory with a button to Locate Titanfall 2 install, a small button next to this, and a button reading _"Update +Northstar"_ +The final parts of the Main Menu are at the bottom, showing your game's directory with a button to Locate Titanfall 2 install, a small button next to this, and a button below both of these reading _"Re-Install Northstar"_. ![Installation Section](../../images/vtol-northstar-installation-info.png) @@ -37,25 +46,28 @@ VTOL handles most things automatically, but it may still require minimal setup f Something you might have to do manually is locate your Titanfall 2 install. You can do this by pressing the button of the same name on VTOL, and navigating to your Titanfall 2 directory (If you're unsure of what your game path is, check out the [Default Directories](../troubleshooting.md#game-location) section) -After doing this, Northstar should automatically install. If not, the button at the bottom will read _"Install Northstar"_. Let VTOL install Northstar, and you should be good to go. Once installed, this button will turn into the _"Update +Northstar"_ shown in the screenshot earlier, which you can use to update without having to reinstall. +After doing this, Northstar should automatically install. If not, the button at the bottom will read _"Install Northstar"_. +Let VTOL install Northstar and you should be good to go. Once installed, this button will turn into the _"Re-Install Northstar"_ button shown in the screenshot earlier, which you can use to forcibly reinstall Northstar in the case something goes wrong with your Northstar install. ## Launching Northstar via VTOL ![Launching Northstar](../../images/vtol-launching-northstar.png) -Assuming you've followed everything up to this point, you should be set to hit _"Launch Titanfall 2 Northstar"_ and play on Northstar's servers. If you encounter an error like a crash, Northstar will create a log file in the `Titanfall2/R2Northstar/logs` directory. You can look at this log yourself, or send it on the [Northstar Discord server](https://discord.com/invite/northstar) and someone can try to look at it and help you. +Assuming you've followed everything up to this point, you should be set to hit _"Launch Titanfall 2 Northstar"_ and play on Northstar's servers. +If you encounter an error like a crash, Northstar will create a log file in the `Titanfall2/R2Northstar/logs` directory. +You can look at this log yourself, or send it on the [Northstar Discord server](https://discord.com/invite/northstar) and someone can try to look at it and help you. ## Additional Mods/Settings ## Tab List -![VTOL Tab List](../../images/vtol-settings.png) - The furthermost left side of VTOL has a list of tabs you can use for several different functions.\ To expand the smaller version of the tab list, press the button with 3 bars as shown below ![3 Bars](../../images/vtol-settings-expand.png) +![VTOL Tab List](../../images/vtol-settings.png) + **NOTE: This guide will not be including the _"Home"_ button as a tab when describing this list. When it says the first tab, it means the first tab underneath the home button** ## Installed Mods List @@ -72,7 +84,9 @@ You can also right click on a specific mod to get the option to either delete it ![Mods browser](../../images/vtol-mods-browser.png) -VTOL has a built in-browser for searching [Northstar's Thunderstore page](https://northstar.thunderstore.io/) (the website where most Northstar mods get uploaded to), located at the second tab _"Browse"_ on the tab list. You will see the newest uploaded mods here by default, which you can change by applying filters (Note: The sorting is by default Low-High for filters. You can change this by pressing the button with an arrow next to the filters button, making it High-Low) +VTOL has a built in-browser for searching [Northstar's Thunderstore page](https://northstar.thunderstore.io/) (the website where most Northstar mods get uploaded to), located at the second tab _"Browse"_ on the tab list. +You will see the newest uploaded mods here by default, which you can change by applying filters (Note: The sorting is by default Low-High for filters. +You can change this by pressing the button with an arrow next to the filters button, making it High-Low) VTOL also has support where all you need to do is drag and drop a mod downloaded from the Thunderstore page onto the _"Mods"_ tab (the second tab on the left side) to automatically install the mod. @@ -80,19 +94,26 @@ VTOL also has support where all you need to do is drag and drop a mod downloaded ![VTOL Settings](../../images/vtol-settings-tab.png) -On the way bottom of the tab list, there is a button to open settings for the VTOL manager. You will want to keep most of these on default, but change them as you wish. It is normal for the _"Restart_As_Admin"_ button to appear untoggled. This is also where you can tick _"Enable_EA_APP_Usage"_ to make the client work better with the EA app, assuming you have it and not Origin. +On the way bottom of the tab list, there is a button to open settings for the VTOL manager. You will want to keep most of these on default, but change them as you wish. +It is normal for the _"Restart_As_Admin"_ button to appear untoggled. This is also where you can tick _"Enable_EA_APP_Usage"_ to make the client work better with the EA app, assuming you have it and not Origin. ## Skins ![Skins installation tab](../../images/vtol-skins.png) -The third settings tab on VTOL is the _"Skins"_ tab. VTOL has support for skins formatted for an older version of Northstar, normally requiring an extra tool. All you need to do is drag the folder of one of these old style skins onto the Skins screen to install it automatically. +The third settings tab on VTOL is the _"Skins"_ tab. VTOL has support for DDS format skins (the skins with the numbered folders in them), which are commonly used for Vanilla Titanfall 2, with Northstar generally opting to convert them to mods. + +This format is older and less consistent than converting them to a mod to be used with Northstar (see [Advocate](./#advocate)). +It can still be used on Vanilla by making use of a [vanilla profile](../../using-northstar/advanced.md#vanilla-profile). + +However, if you want you can still install skins like this for use with Northstar. +All you need to do is drag the folder of a DDS format skin onto the Skins screen of VTOL to install it automatically. ## Server ![Launch arguments/dedicated server tab](../../images/vtol-server.png) -The fourth tab on VTOL is the _"Server"_ tab. This section allows you to add Launch Arguments to your client or dedicated server. Note that this adds Launch Arguments to change what Northstar does when it launches, not to launch Northstar itself. A way you can do this is by adding [Launch Arguments](../troubleshooting.md#launch-opts) via the store you own the game on and launching through there. +The fourth tab on VTOL is the _"Server"_ tab. This section allows you to add Launch Arguments to your client or dedicated server. For the dedicated server option, you can scroll through this tab to set many different options for a server which can be found on the Northstar Wiki's [Server Hosting Guide](../../hosting-a-server-with-northstar/basic-listen-server.md) @@ -112,13 +133,16 @@ The first screen is an area where you can locate a folder for a mod you've creat ![VTOL's Skin Tool implementation](../../images/vtol-skintool.png) -The second screen is an area where you can drag and drop images to the different maps of a skin to make your own skin. This is an implementaion of the [skin tool](https://github.com/zxcPandora/Titanfall2-SkinTool). +The second screen is an area where you can drag and drop images to the different maps of a skin to make your own skin. This is an implementaion of the [Skin Tool](https://github.com/zxcPandora/Titanfall2-SkinTool). ### Advocate ![VTOL's Advocate implementation](../../images/vtol-advocate.png) -The third screen is an implementation of Spoon's [Advocate Tool](https://github.com/ASpoonPlaysGames/Advocate), where you can convert an old style skin mod to a mod that can be installed by everyone like a normal mod. Please give credit to the original skin owner while doing this. (If confused, following the earlier link to Github describes how to set up Advocate) +The third screen is an implementation of Spoon's [Advocate Tool](https://github.com/ASpoonPlaysGames/Advocate), where you can convert a DDS formatted skin to a mod that can be installed by everyone normally without the need for the [Skin Tool](https://github.com/zxcPandora/Titanfall2-SkinTool). +If you're going to be sharing a converted skin that isn't yours, please give credit to the original creator. +(If confused on how to use this, follow the earlier link to Github that describes how to set up Advocate. +Do note, this version of Advocate isn't perfectly up to date) ### External Tools @@ -130,11 +154,13 @@ The fourth screen lists a lot of commonly used tools by modders to help create m ![VTOL's Profiles menu](../../images/vtol-profiles.png) -The sixth tab is the _"Profiles"_ tab, allowing you to create profiles for Northstar. Profiles are seperate Northstar installs, each with their own set of mods and seperated by folders. For example, you can have one profile with your normal set of mods, and another profile for only using core mods (those that common with Northstar/the ones that start with `Northstar.`). +The sixth tab is the _"Profiles"_ tab, allowing you to create profiles for Northstar. Profiles are seperate Northstar installs, each with their own set of mods and seperated by folders. +For example, you can have one profile with your normal set of mods and another profile for only using core mods (those that common with Northstar/the ones that start with `Northstar.`). ![The Export Profile menu in VTOL](../../images/vtol-export-profile.png) -Hitting `Export Profile` will save your current profile to a `.vbp` file, which you can easily switch to by clicking `IMPORT` on the desired profile inside of VTOL. You can also share your profile or download someone else's profile if they send you this file by hitting `Add Profile` and selecting the downloaded file. These files get saved to `Titanfall2/VTOL_profiles`. +Hitting `Export Profile` will save your current profile to a `.vbp` file, which you can easily switch to by clicking `IMPORT` on the desired profile inside of VTOL. +You can also share your profile or download someone else's profile if they send you this file by hitting `Add Profile` and selecting the downloaded file. These files get saved to `Titanfall2/VTOL_profiles`. ## About diff --git a/docs/modding-and-development/development/releases.md b/docs/modding-and-development/development/releases.md deleted file mode 100644 index 44f502ab..00000000 --- a/docs/modding-and-development/development/releases.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -description: >- - Information intended mostly for internal use on what to consider when making - new releases ---- - -# Releases - -{% hint style="info" %} -WIP -{% endhint %} - -## General - -CI on Northstar release repo builds versioned release if tag is pushed. It checks Launcher and Mods for same tag and builds those versions. \ -Therefore make sure to push tags of Mods and Launcher first. - -CI also pushes release directly to Thunderstore as a mod called [`Northstar`](https://northstar.thunderstore.io/package/northstar/Northstar/). \ -If it's a release-candidate with the `-rcX` suffix, it will instead get pushed to Thunderstore as [`NorthstarReleaseCandidate`](https://northstar.thunderstore.io/package/northstar/NorthstarReleaseCandidate/). - -### Git commands for tags: - -**For release candidates:** - -``` -git tag vX.Y.Z-rcN -git push origin vX.Y.Z-rcN -``` - -Example: - -``` -git tag v1.8.0-rc1 -git push origin v1.8.0-rc1 -``` - -**For actual releases** - -``` -git tag vX.Y.Z -git push origin vX.Y.Z -``` - -Example: - -``` -git tag v1.8.0 -git push origin v1.8.0 -``` - -## Version numbering - -In general, Northstar tries to follow [semantic versioning](https://semver.org/). This means version numbers are `MAJOR.MINOR.PATCH`, where - -- `MAJOR` is updated for breaking changes -- `MINOR` is updated for changes that are backwards compatible -- `PATCH` is updated for fixes that are backwards compatible - -Semantic versioning is however not followed exactly. For example, to ship out smaller features faster they have been included in patch releases. Similarly, there have been smaller breaking changes, yet at the time of writing the major version number so far has never been updated. - -The reason for this is mostly due to player expectations. Players expect the change from `1.0` to `2.0` to be big. As such, the plan for the near future is to update the major version, once we have a bigger feature ready to release that brings us closer to vanilla in terms of missing features (e.g. _Frontier Defense_). - -Once `2.0` has been released, expectations for `3.0` tend to be lower as the number is no longer "doubled". Past `3.0`, proper semver can probably be employed without hampering player expectations. - - -## Best practices: - -- 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. diff --git a/docs/other/moderation.md b/docs/other/moderation.md new file mode 100644 index 00000000..5459e021 --- /dev/null +++ b/docs/other/moderation.md @@ -0,0 +1,18 @@ +# Moderation + +{% hint style="info" %} +This page contains information targetted at Discord moderators. +{% endhint %} + + +## General stuff + +- **Communication:** Communication is key. Any changes and actions should be discussed with other moderators unless they are very obvious (e.g. scambans). + Any changes to permissions etc should be discussed first in `#staff-suggestions`. Any changes performed should also be manually written down in `#changelog` so that everyone is on the same page. +- **Use Dyno:** Use dyno commands to perform actions like mutes and bans. Dyno log is way easier to search than Discord's native audit log and helps us keep track of who did what. +- **Staff tickets:** User requests like receiving _Contributor_/_Modder_ role should be handled handled via staff ticket. This way other moderators can chime in and public channels are not clogged with unnecessary info. +- **Warn liberally:** User warns are stored in Dyno log. They should be performed as a first measure on misconduct. It's better to warn once too many times than ban someone without warning. + +## Useful commands + +- `!scamban UID`: Bans a user with a message telling them that their account has been compromised and has been spreading scam.