Merge pull request #325 from satisfactorymodding/Dev

Documentation for SML3.8.0

.devcontainer/devcontainer.json

@@ -38,11 +38,13 @@
  "DavidAnson.vscode-markdownlint",
  "medo64.render-crlf",
  "andrejunges.Handlebars",
- "bierner.markdown-preview-github-styles"
+ "bierner.markdown-preview-github-styles",
+ "tamasfe.even-better-toml"
  ],
  // cSpell:enable
  "settings": {
- "npm.packageManager": "pnpm"
+ "npm.packageManager": "pnpm",
+ "asciidoc.antora.enableAntoraSupport": true
  }
  }
  }

.github/workflows/pull-request.yml

@@ -40,6 +40,7 @@ jobs:
  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
+ # maybe use separate lychee configs to use their exclude_path option?
  args: --verbose --exclude-all-private --no-progress --accept '200,429' --github-token '${{ secrets.LYCHEE_TOKEN }}' './build/site/[!s][!a][!t][!i]*/**/*.html'
  fail: false
 

.github/workflows/push.yml

@@ -46,6 +46,7 @@ jobs:
  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
+ # maybe use separate lychee configs to use their exclude_path option?
  args: --verbose --exclude-all-private --no-progress --accept '200,429' --github-token '${{ secrets.LYCHEE_TOKEN }}' './build/site/[!s][!a][!t][!i]*/**/*.html'
  fail: false
 
@@ -93,3 +94,20 @@ jobs:
  labels: ${{ steps.meta.outputs.labels }}
  build-args: |
  BUILD=build:ci
+
+ notify:
+ name: Notify
+ runs-on: ubuntu-latest
+ needs:
+ - build
+ - image
+ if: ${{ always() && contains(needs.*.result, 'failure') }}
+ steps:
+ - name: Notify Discord
+ uses: sarisia/actions-status-discord@v1
+ with:
+ title: "The docs failed to build :("
+ noprefix: true
+ description: "Place your bets on what random link broke this time."
+ color: 0xA50000
+ webhook: ${{ secrets.DISCORD_WEBHOOK }}

.vscode/tasks.json

@@ -9,8 +9,52 @@
  "isDefault": true
  },
  "problemMatcher": [],
- "label": "yarn: build:dev",
+ "label": "pnpm: build:dev",
  "detail": "antora antora-playbook-dev.yml"
+ },
+ {
+ "type": "shell",
+ "label": "Hot Rebuild",
+ "command": "pnpm serve",
+ "hide": true,
+ "presentation": {
+ "group": "hot-rebuild-server"
+ }
+ },
+ {
+ "type": "shell",
+ "label": "Webserver",
+ "command": "pnpm watch:dev",
+ "hide": true,
+ "presentation": {
+ "group": "hot-rebuild-server"
+ }
+ },
+ {
+ "label": "Open in browser",
+ "type": "shell",
+ "windows": {
+ "command": "Start-Process http://127.0.0.1:8000/"
+ },
+ "presentation": {
+ "reveal": "silent"
+ },
+ "problemMatcher": []
+ },
+ {
+ "type": "shell",
+ "label": "Launch hot rebuilding development server",
+ "group": {
+ "kind": "none",
+ "isDefault": true
+ },
+ "dependsOn": [
+ "Hot Rebuild",
+ "Webserver",
+ "Open in browser"
+ ],
+ "command": "echo 'Development server and watch started'",
+ "problemMatcher": []
  }
  ]
 }

antora-playbook-ci.yml

@@ -6,7 +6,7 @@ site:
 content:
  sources:
  - url: ./
- branches: HEAD, v3.5.1, v3.4.1, v3.3.2, v3.1.1, v2.2.1, v2.1.1, v2.0.0, v1.0.2
+ branches: HEAD
 
  - url: https://github.com/CoderDE/FicsIt-Networks.git
  branches: master

antora-playbook.yml

@@ -12,7 +12,7 @@ content:
  sources:
  ## Used for prod
  - url: https://github.com/satisfactorymodding/Documentation.git
- branches: master, v3.6.1, v3.5.1, v3.4.1, v3.3.2, v3.1.1, v2.2.1, v2.1.1, v2.0.0, v1.0.2
+ branches: master, v3.7.0, v3.6.1, v3.5.1, v3.4.1, v3.3.2, v3.1.1, v2.2.1, v2.1.1, v2.0.0, v1.0.2
  edit_url: '{web_url}/blob/{refname}/{path}'
 
  ## Used for dev

antora.yml

@@ -3,3 +3,10 @@ title: Satisfactory Modding Documentation
 version: latest
 nav:
  - modules/ROOT/nav.adoc
+
+asciidoc:
+ # Custom text replacements. Built-in ones can be found here:
+ # https://github.com/asciidoctor/asciidoctor/blob/917d3800a08a8f283a8d05beb08bb75af1673de5/lib/asciidoctor.rb#L391
+ attributes:
+ # Uses zero-width joiner (U+200D) to avoid being split across lines
+ cpp: C‍+‍+

cspell.json

@@ -31,9 +31,11 @@
  "customizer",
  "Deantendo",
  "devcontainer",
+ "Digby",
  "disqualifier",
  "disqualifiers",
  "doggos",
+ "DOREPCONDITIONAL",
  "DOREPLIFETIME",
  "FACTORYGAME",
  "favorited",
@@ -45,6 +47,8 @@
  "ficsmas",
  "FORCEINLINE",
  "Forsythe",
+ "furtue",
+ "FFGCondReplicatedProperty",
  "Headlift",
  "HKEY",
  "hoverpack",
@@ -110,13 +114,16 @@
  "UKBFL",
  "umenuworldmodule",
  "undetailed",
+ "unopenable",
  "UOBJECT",
  "UPARAM",
  "uplugin",
  "uproject",
  "UPROPERTY",
  "usmap",
  "USTRUCT",
+ "utoc",
+ "utocs",
  "VRAM",
  "Vulkan",
  "webp",
@@ -137,4 +144,4 @@
  "destory",
  "conveneint"
  ]
-}
+}

lychee.toml

@@ -26,15 +26,15 @@ exclude = [
  # 403s despite being valid pages
  "https://stackoverflow.com/questions/",
  "https://www.unrealengine.com/en-US/ue-on-github",
+ "https://store.epicgames.com/en-US/p/satisfactory",
  # 403s despite being valid page, we should try to get this working somehow, since these links can change without warning
  "https://docs.unrealengine.com/",
- "https://dev.epicgames.com/"
+ "https://dev.epicgames.com/",
+ # Times out despite being valid
+ "https://www.adobe.com/learn/substance-3d-designer/web/the-pbr-guide-part-1",
+ # Pages often time out and Shouldn't™ ever get deleted anyways
+ "https://web.archive.org/web/",
 ]
 
 # Exclude these filesystem paths from getting checked.
-# TODO find a better way to handle sub-mods, as they currently must be ignored here
-# else they'll fail the the whole build if they have broken links.
-exclude_path = [
- "./build/site/ficsit-networks/",
- "./build/site/ficsitremotemonitoring/"
-]
+exclude_path = []

modules/ROOT/attachments/Development/SatisfactoryAudioRenamer/convert.py

@@ -0,0 +1,31 @@
+import os
+from pathlib import Path
+
+def convert(filename):
+
+ my_file = open("./txtp/" + filename, "r")
+ data = my_file.read()
+
+ data_into_list = data.replace('\n', ' ').split(" ")
+
+
+ for i in range(len(data_into_list)):
+ if data_into_list[i].startswith('wem'):
+
+ wavname = "./txtp/" + data_into_list[i].split('.')[0] + '.wav'
+
+ if os.path.isfile(wavname):
+ os.rename(wavname, "./out/" + filename.split('.')[0] + '_' + str(i) + '.wav')
+ else:
+ print(wavname + " not found.")
+
+ my_file.close()
+
+relevant_path = "./txtp/"
+included_extensions = ['txtp']
+file_names = [fn for fn in os.listdir(relevant_path)
+ if any(fn.endswith(ext) for ext in included_extensions)]
+
+
+for file_name in file_names:
+ convert(file_name)