feat: added support and examples of implementing mods

brittonhayes · Mar 22, 2023 · d6ea85e · d6ea85e
1 parent 0c4ced5
commit d6ea85e
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -67,6 +67,20 @@ resources:
     memory: 4G
 ```
 
+Add mods to your server
+
+```yaml
+# Adding mods
+config:
+  mods:
+  - modId: "59A30ACC02650E71"
+    name: "Night Vision System"
+    version: "1.1.3"
+  - modId: "5A64DE35CCD36695"
+    name: "3rd Ranger Battalion Modpack"
+    version: "0.7.11"
+```
+
 # Acknowledgements
 
 - Helm chart design heavily based on the work by [fbuchmeier](https://github.com/fbuchmeier)

diff --git a/Taskfile.yaml b/Taskfile.yaml
@@ -22,9 +22,14 @@ tasks:
   helm:
     desc: Execute helm template and documentation generation
     cmds:
-    - helm template arma-reforger {{ .ChartPath }} | kubeconform -summary
+    - task: helm:tpl
     - helm-docs -c {{ .ChartPath }}
 
+  helm:tpl:
+    desc: Execute helm template
+    cmds:
+    - helm template arma-reforger {{ .ChartPath }} --values {{ .ValuesFile }}
+
   helm:install:
     desc: Install helm chart to cluster
     cmds:

diff --git a/charts/arma-reforger/Chart.yaml b/charts/arma-reforger/Chart.yaml
@@ -5,7 +5,7 @@ type: application
 maintainers:
 - name: Britton Hayes
   url: https://github.com/brittonhayes
-version: 0.2.0
+version: 0.3.0
 appVersion: "1.16.0"
 keywords:
 - arma-reforger

diff --git a/charts/arma-reforger/README.md b/charts/arma-reforger/README.md
@@ -1,6 +1,6 @@
 # arma-reforger
 
-![Version: 0.1.9](https://img.shields.io/badge/Version-0.1.9-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square)
+![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square)
 
 A Helm chart for ARMA reforger on LinuxGSM.
 
@@ -29,7 +29,7 @@ A Helm chart for ARMA reforger on LinuxGSM.
 | config.gameHostRegisterBindAddress | string | `"0.0.0.0"` | When left out or empty, an attempt is made to automatically determine the IP address, but this will often fail and should not be relied upon as the server might not be reachable from public networks.  |
 | config.gameHostRegisterBindPort | int | `2001` | Otherwise, this is the UDP port that is forwarded to the server.   |
 | config.maxFPS | int | `60` | otherwise, the server can try to use all the available resources! |
-| config.mods | list | `[]` | List of mods |
+| config.mods | list | `[]` | version: "0.7.11"  |
 | config.name | string | `"arma-reforger-server.example.com"` | length 0..100 characters  |
 | config.networkViewDistance | int | `500` | Maximum network streaming range of replicated entities.  |
 | config.playerCountLimit | int | `20` | Set the maximum amount of players on the server.  |

diff --git a/charts/arma-reforger/templates/_helpers.tpl b/charts/arma-reforger/templates/_helpers.tpl
@@ -99,3 +99,13 @@ noLookupWhenTemplating
 noLookupWhenTemplating
 {{- end -}}
 {{- end -}}
+
+{{- define "mods" -}}
+{{- if .Values.config.mods -}}
+    {{ $first := true }}
+    {{- range $v := .Values.config.mods }}
+    {{- if $first}}{{$first = false}}{{else}},{{end -}}
+    { "modId": {{ $v.modId | quote }}, "name": {{ $v.name | quote }}, "version": {{ $v.version | quote }} }
+    {{- end }}
+{{- end }}
+{{- end -}}
diff --git a/charts/arma-reforger/templates/configmap.yaml b/charts/arma-reforger/templates/configmap.yaml
@@ -34,7 +34,7 @@ data:
                 "fastValidation": {{ .Values.config.fastvalidation }},
                 "battlEye": {{ .Values.config.battleeye }}
             },
-            "mods": []
+            "mods": [{{ include "mods" . }}]
         },
         "a2sQueryEnabled": true,
         "steamQueryPort": 17777

diff --git a/charts/arma-reforger/values.yaml b/charts/arma-reforger/values.yaml
@@ -116,7 +116,14 @@ config:
   # -- List of administrators
   admins: []
 
-  # -- List of mods
+  # -- Array of mods to load in the format
+  # -- mods: 
+  # --  - modId: "59A30ACC02650E71"
+  # --    name: "Night Vision System"
+  # --    version: "1.1.3"
+  # --  - modId: "5A64DE35CCD36695"
+  # --    name: "3rd Ranger Battalion Modpack"
+  # --    version: "0.7.11" 
   mods: []
 
   # -- array value, default: ["PLATFORM_PC"]