Skip to content

Commit

Permalink
Merge branch 'master' into Dev
Browse files Browse the repository at this point in the history
  • Loading branch information
budak7273 committed Sep 10, 2024
2 parents ee4e583 + 13a3351 commit d609c51
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 12 deletions.
14 changes: 12 additions & 2 deletions .github/workflows/pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,22 @@ jobs:
- name: Build
run: npm run build:ci

- id: lychee
- id: lychee-main
name: Check for Broken Links (Main Docs)
uses: lycheeverse/lychee-action@v1
with:
args: --verbose --exclude-all-private --accept '200,429' --github-token '${{ secrets.LYCHEE_TOKEN }}' './build/**/*.html'
args: --verbose --exclude-all-private --no-progress --accept '200,429' --github-token '${{ secrets.LYCHEE_TOKEN }}' './build/site/satisfactory-modding/**/*.html'
fail: true

- id: lychee-submods
name: Check for Broken Links (Subsites)
uses: lycheeverse/lychee-action@v1
with:
# TODO there surely must be a better way to do this
# exclude the main docs dir from this check to avoid doing work twice
args: --verbose --exclude-all-private --no-progress --accept '200,429' --github-token '${{ secrets.LYCHEE_TOKEN }}' './build/site/[!s][!a][!t][!i]*/**/*.html'
fail: false

image:
name: Image
runs-on: ubuntu-latest
Expand Down
14 changes: 12 additions & 2 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,22 @@ jobs:
- name: Build
run: npm run build:ci

- id: lychee
- id: lychee-main
name: Check for Broken Links (Main Docs)
uses: lycheeverse/lychee-action@v1
with:
args: --verbose --exclude-all-private --no-progress --accept '200,429' --github-token '${{ secrets.LYCHEE_TOKEN }}' './build/**/*.html'
args: --verbose --exclude-all-private --no-progress --accept '200,429' --github-token '${{ secrets.LYCHEE_TOKEN }}' './build/site/satisfactory-modding/**/*.html'
fail: true

- id: lychee-submods
name: Check for Broken Links (Subsites)
uses: lycheeverse/lychee-action@v1
with:
# TODO there surely must be a better way to do this
# exclude the main docs dir from this check to avoid doing work twice
args: --verbose --exclude-all-private --no-progress --accept '200,429' --github-token '${{ secrets.LYCHEE_TOKEN }}' './build/site/[!s][!a][!t][!i]*/**/*.html'
fail: false

image:
name: Image
runs-on: ubuntu-latest
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To open the mod creation wizard, click the `Create Mod` button in the Alpakit De
Mod templates that the community has created will appear here.
Select the `Blueprint Only` template.

The wizard will also prompt you for a Plugin Name.
The wizard will also prompt you for a Mod Name.
The name of your plugin _must_ be your mod's
xref:Development/BeginnersGuide/index.adoc#_mod_reference[Mod Reference].
For this documentation example, you can use `DocMod` as the mod reference.
Expand All @@ -34,7 +34,7 @@ if you have not yet done so.
It is critical that your mod reference follows these formatting rules.
====

Leave "Show Content Directory" checked and press `Create Plugin`.
Leave "Show Content Directory" checked and press `Create Mod`.

image:BeginnersGuide/simpleMod/AlpakitCreateMod.png[Create Mod screenshot]

Expand Down
21 changes: 15 additions & 6 deletions modules/ROOT/pages/faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -486,6 +486,7 @@ The process for specifying them depends on how you are launching the game:

- For https://help.steampowered.com/en/faqs/view/7d01-d2dd-d75e-2955[Steam]
- For https://www.pcgamingwiki.com/wiki/Glossary:Command_line_arguments#Epic_Games_Store[Epic]
- For a https://superuser.com/questions/29569/how-to-add-command-line-options-to-shortcut[Windows shortcut]
- For xref:Development/TestingResources.adoc[Testing Scripts]
- For other launch methods, use your search engine of choice.

Expand Down Expand Up @@ -519,15 +520,23 @@ so instead, chose the option that makes it so it only updates when you launch it
(instead of automatically in the background).
This gives you a chance to copy the files elsewhere before the platform automatically updates them on you.

Steam explains how to disable automatic updates in
- Steam explains how to disable automatic updates in
https://help.steampowered.com/en/faqs/view/71AB-698D-57EB-178C#disable[their FAQ].
- Epic automatic updates can be disabled on the game's "Manage" menu.
Remember to disable updates for each Satisfactory library entry, since the branches are separate games on Epic.

On Epic, this can be done on the game's "Manage" menu.
Remember to disable updates for each Satisfactory library entry, since the branches are separate games on Epic.
Once automatic updates are disabled, take a backup by copying the entire game install directory to another location.

Once an update releases, follow the directions
xref:Development/UpdatingToNewVersions.adoc#_back_up_your_game[here]
to make a copy of your files and learn how to launch the game from that copy.
==== Launching the Backup Copy

In order to launch this separate copy, you'll need to launch it outside of the usual platform launcher.

- For Steam, navigate to the `\Engine\Binaries\Win64` subfolder of your backup copy and create a text file named `steam_appid.txt` with the file contents `526870`.
To launch the game, run the `FactoryGameSteam.exe` file in the root folder of your backup copy.
If you have Steam open, it will still say you are playing, but your backup will still be separate and not require Steam.
- For Epic, you will need to run the game executable with launch arguments to prevent it from talking to the Epic Games launcher.
Create a Windows shortcut pointing to the game executable and add the `-EpicPortal` and `-NoSteamClient` arguments.
https://superuser.com/questions/29569/how-to-add-command-line-options-to-shortcut[This article] explains how to add launch arguments to a shortcut.

[id="PlayOlderVersion_SteamCMD"]
=== Use SteamCMD
Expand Down

0 comments on commit d609c51

Please sign in to comment.