Factorio sandbox role documentation (#234)

* add docs factorio role # Conflicts: # docs/sandbox/index.md # mkdocs.yml * linting
saltyorg · Oct 1, 2024 · 6d6f11f · 6d6f11f
1 parent b3d75be
commit 6d6f11f
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 25 deletions.
diff --git a/docs/sandbox/apps/factorio.md b/docs/sandbox/apps/factorio.md
@@ -0,0 +1,22 @@
+# Factorio
+
+## What is it?
+
+Run a [Factorio](https://www.factorio.com) headless server.
+
+| Details     |             |             |             |
+|-------------|-------------|-------------|-------------|
+| [:material-home: Project home](https://www.factorio.com){: .header-icons } | [:octicons-link-16: Docs](https://wiki.factorio.com/Multiplayer){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/goofball222/factorio){: .header-icons } | [:material-docker: Docker](https://hub.docker.com/r/goofball222/factorio){: .header-icons }|
+
+### 1. Installation
+
+``` shell
+
+sb install sandbox-factorio
+
+```
+
+### 2. Setup
+
+- [:octicons-link-16: Documentation](https://wiki.factorio.com/Multiplayer){: .header-icons }
+- Set to install the latest Factorio experimental (1.1.x) build. Fix to a certain version using the [inventory system](../../saltbox/inventory/index.md).
diff --git a/docs/sandbox/index.md b/docs/sandbox/index.md
@@ -37,6 +37,7 @@ tags:
 - **[duplicati](../sandbox/apps/duplicati.md)**  - tag - `sandbox-duplicati`
 - **[embystat](../sandbox/apps/embystat.md)**  - tag - `sandbox-embystat`
 - **[epms](../sandbox/apps/epms.md)**  - tag - `sandbox-epms`
+- **[factorio](../sandbox/apps/factorio.md)**  - tag - `sandbox-factorio`
 - **[fireflyiii](../sandbox/apps/fireflyiii.md)** - tag - `sandbox-firefly`
 - **[fireflyiii_importer](../sandbox/apps/fireflyiii_importer.md)** - tag - `sandbox-firefly_importer`
 - **[filebot](../sandbox/apps/filebot.md)**  - tag - `sandbox-filebot`

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -95,18 +95,18 @@ plugins:
 extra:
   generator: false
   social:
-  - icon: fontawesome/solid/heart
-    class: md-social__link heart
-    link: 'https://github.com/sponsors/saltydk'
-    name: Donate
-  - icon: fontawesome/brands/discord
-    class: md-social__link
-    link: 'https://discord.gg/ugfKXpFND8'
-    name: Discord
-  - icon: fontawesome/brands/github
-    class: md-social__link
-    link: 'https://github.com/saltyorg/Saltbox'
-    name: GitHub
+    - icon: fontawesome/solid/heart
+      class: md-social__link heart
+      link: "https://github.com/sponsors/saltydk"
+      name: Donate
+    - icon: fontawesome/brands/discord
+      class: md-social__link
+      link: "https://discord.gg/ugfKXpFND8"
+      name: Discord
+    - icon: fontawesome/brands/github
+      class: md-social__link
+      link: "https://github.com/saltyorg/Saltbox"
+      name: GitHub
 
 markdown_extensions:
   - abbr
@@ -144,12 +144,12 @@ nav:
       - Paths: saltbox/basics/paths.md
       - Inventory: saltbox/inventory/index.md
       - Major Upgrade Guide:
-        - Traefik 3.0 Upgrade: saltbox/upgrade/traefik3.md
+          - Traefik 3.0 Upgrade: saltbox/upgrade/traefik3.md
       - Backup/Restore:
-        - Settings: saltbox/backup/settings.md
-        - Backup: saltbox/backup/backup.md
-        - Restore: saltbox/backup/restore.md
-        - Migrate: saltbox/backup/migrate.md
+          - Settings: saltbox/backup/settings.md
+          - Backup: saltbox/backup/backup.md
+          - Restore: saltbox/backup/restore.md
+          - Migrate: saltbox/backup/migrate.md
 
   - Sandbox:
       - Basics: sandbox/basics.md
@@ -229,6 +229,7 @@ nav:
           - Homarr: sandbox/apps/homarr.md
           - Homepage: sandbox/apps/homepage.md
         - Game Servers:
+          - Factorio: sandbox/apps/factorio.md
           - LinuxGSM: sandbox/apps/lgsm.md
           - MC-Router: sandbox/apps/mcrouter.md
           - Minecraft: sandbox/apps/minecraft.md
@@ -362,8 +363,8 @@ nav:
         - Overseerr: apps/overseerr.md
         - Portainer: apps/portainer.md
       - Other Media Servers:
-        - Emby: apps/emby.md
-        - Jellyfin: apps/jellyfin.md
+          - Emby: apps/emby.md
+          - Jellyfin: apps/jellyfin.md
       - Alternatives to Core Apps:
         - Petio: apps/petio.md
         - Plex Autoscan: apps/plex-autoscan.md
@@ -388,15 +389,15 @@ nav:
         - Unpackerr: apps/unpackerr.md
         - Whisparr: apps/whisparr.md
       - Support Apps:
-        - diun: apps/diun.md
-        - MariaDB: apps/mariadb.md
-        - PostgreSQL: apps/postgres.md
+          - diun: apps/diun.md
+          - MariaDB: apps/mariadb.md
+          - PostgreSQL: apps/postgres.md
       - Visualization:
-        - Grafana: apps/grafana.md
+          - Grafana: apps/grafana.md
       - TODO - NEED UPDATING:
-        - Organizr: apps/organizr.md
+          - Organizr: apps/organizr.md
       - Utility tags:
-        - Plex-DB: apps/utility_tags/plex-db.md
+          - Plex-DB: apps/utility_tags/plex-db.md
 
   - FAQ:
       - System: faq/System.md