Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update with changes from Dev #289

Merged
merged 13 commits into from
Apr 20, 2024
Merged
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"name": "SML Documentation",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "mcr.microsoft.com/devcontainers/javascript-node:0-18",
"image": "mcr.microsoft.com/devcontainers/javascript-node:20",

// Features to add to the dev container. More info: https://containers.dev/features.
"features": {
Expand Down
14 changes: 7 additions & 7 deletions .github/workflows/pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Setup pnpm
uses: pnpm/action-setup@v2
uses: pnpm/action-setup@v3
with:
version: latest
version: 9

- name: Setup NodeJS
uses: actions/setup-node@v2
uses: actions/setup-node@v4
with:
node-version: '16'
node-version: '20'
cache: 'pnpm'

- name: Install Dependencies
Expand All @@ -40,10 +40,10 @@ jobs:
- build
steps:
- name: Checkout repository
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Build and push Docker image
uses: docker/build-push-action@v2
uses: docker/build-push-action@v5
with:
context: .
push: false
20 changes: 10 additions & 10 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Setup pnpm
uses: pnpm/action-setup@v2
uses: pnpm/action-setup@v3
with:
version: latest
version: 9

- name: Setup NodeJS
uses: actions/setup-node@v2
uses: actions/setup-node@v4
with:
node-version: '16'
node-version: '20'
cache: 'pnpm'

- name: Install Dependencies
Expand All @@ -49,23 +49,23 @@ jobs:
packages: write
steps:
- name: Checkout repository
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Log in to the Container registry
uses: docker/login-action@v1
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@v3
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}

- name: Build and push Docker image
uses: docker/build-push-action@v2
uses: docker/build-push-action@v5
if: github.ref != 'refs/heads/Dev'
with:
context: .
Expand All @@ -74,7 +74,7 @@ jobs:
labels: ${{ steps.meta.outputs.labels }}

- name: Build and push Docker image
uses: docker/build-push-action@v2
uses: docker/build-push-action@v5
if: github.ref == 'refs/heads/Dev'
with:
context: .
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/Development/Modeling/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Lightmap UVs::
+
Ambient Occlusion Bake::
Help the lighting engine do a better job by making a texture to describe where the nooks, crannies, and edges of meshes are.
https://www.katsbits.com/tutorials/blender/baking-ambient-occlusion.php[Tutorial Article]
https://web.archive.org/web/20231202113004/https://www.katsbits.com/tutorials/blender/baking-ambient-occlusion.php[Tutorial Article]

== Help
Keep in mind these are common techniques and many more resources are available to learn from. Feel free to ask for help in the `+#help-making-mods+` channel on the https://discord.gg/xkVJ73E[Discord server] or in the https://forums.ficsit.app/[SMR Forums]
Expand Down
2 changes: 2 additions & 0 deletions modules/ROOT/pages/ForUsers/DedicatedServerSetup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ If using ficsit-cli to manage your server:
. Download https://github.com/satisfactorymodding/ficsit-cli[ficsit-cli]
either to your computer or to the server itself
depending on which environment you are more comfortable working with.
- Visit https://cli.ficsit.app/ to automatically download the latest stable release for your detected platform.
- Specific (pre-)releases can be manually download from the https://github.com/satisfactorymodding/ficsit-cli/releases[GitHub releases page].
. Run the application in a terminal window.
. Navigate to the "Installations" > "New Installation" screen.
. Enter server connection details in the popup window.
Expand Down
12 changes: 12 additions & 0 deletions modules/ROOT/pages/ForUsers/SatisfactoryModManager.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ xref:faq.adoc#_are_satisfactory_mods_safe[here].
*** link:#Install_Win11[Windows 11]
*** link:#Install_Winget[Automatic via Winget]
** link:#Install_Linux[Linux]
** link:#Install_Mac[Mac]

[id="Install_Win10"]
=== For Windows 10:
Expand Down Expand Up @@ -89,6 +90,17 @@ installed you can install the mod manager by running this command in a command p

`winget install SatisfactoryModding.SatisfactoryModManager`.

[id="Install_Mac"]
=== Mac

Satisfactory does not officially support Mac,
but you can use various technologies outside the scope of this guide,
such as CrossOver, to get it running.

Satisfactory Mod Manager does not currently support Mac,
but you can use https://github.com/satisfactorymodding/ficsit-cli[ficsit-cli]
to both install mods and manage remote servers from a Mac.

== Detecting your Game Installation Directory

After you've installed the Mod Manager it will automatically detect your game installation,
Expand Down
30 changes: 27 additions & 3 deletions modules/ROOT/pages/faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,13 @@ If you find a mod that is missing its stickers or ones that seem to be incorrect
please let us know in the Discord (including a SMM debug zip if it does not work is useful as well!)
and we will investigate and update the info if necessary.

== Do mods work with dedicated servers?

In general, yes, but exact support will vary depending on the mod.
See xref:ForUsers/DedicatedServerSetup.adoc[Installing Mods on Dedicated Servers] for more details.
The xref:ForUsers/DedicatedServerSetup.adoc#InstallingMods[Installing Mods section]
describes how to tell if an individual mod supports Dedicated Servers.

== Satisfactory Mod Manager is open, but I can't see it's window!

The program's window somehow got offscreen.
Expand Down Expand Up @@ -189,16 +196,33 @@ image:FAQ/SmmImportExport.png[SMM Import/Export screenshot]
[id="Files_GameInstall"]
=== Game Install

The answer to this question depends on if you installed the game via Steam or Epic.
The location of your game files depends on how you installed the game.

[id="Files_GameInstall_Steam"]
==== Steam

The default path is
`C:\Program Files (x86)\Steam\steamapps\common\Satisfactory`.

On Steam:
You can use the below approach to find your exact install location:

image:FAQ/LocalFiles_Steam.png[Browse Local Files on Steam]

On Epic: (Note that the Early Access and Experimental branches are separate entries with separate install directories!)
[id="Files_GameInstall_Epic"]
==== Epic

Note that the Early Access and Experimental branches are separate library entries with separate install directories!

image:FAQ/LocalFiles_Epic.png[Browse Local Files on Epic]

[id="Files_GameInstall_Other"]
==== Other

Dedicated Server, Linux, and Mac install locations vary significantly depending on how you set them up.

In a Crossover (Mac) install, assuming your bottle is named "Steam", files will be at
`"${HOME}/Library/Application Support/CrossOver/Bottles/Steam/drive_c/Program Files (x86)/Steam/steamapps/common/Satisfactory"`

[id="Files_Mods"]
=== Mods

Expand Down
Loading