Add "Handle sounds", "Build html" tasks

Author: ZwerOxotnik

.scripts/handle_sounds.sh

@@ -0,0 +1,92 @@
+#!/bin/bash
+### Generates lua and cfg files to handle .ogg sounds for Factorio
+### Modified version of https://github.com/ZwerOxotnik/Mod-generator
+
+
+SOUNDS_LIST_FILE=sounds_list.lua
+CFG_FILE=sounds_list.cfg
+
+
+### Get mod name and version from info.json
+### https://stedolan.github.io/jq/
+mod_name=`cat info.json|jq -r .name`
+
+
+echo "you're in $(pwd)"
+read -r -p "Complete path to folder of sounds: $mod_name/" folder_path
+read -r -p "Add sounds to programmable speakers? [Y/N] " response
+case "$response" in
+    [yY][eE][sS]|[yY])
+        STATE=1
+        ;;
+    *)
+        STATE=2
+        ;;
+esac
+if [ $STATE -eq 1 ]; then
+	read -r -p "Insert group name of sounds:" sound_group_name
+	case "$sound_group_name" in "")
+		sound_group_name=$mod_name
+		;;
+	esac
+fi
+
+
+SOUNDS_LIST_PATH="$folder_path/$SOUNDS_LIST_FILE"
+rm -f $SOUNDS_LIST_PATH
+CFG_FILE="$sound_group_name".cfg
+rm -f $CFG_FILE
+
+if [ $STATE -eq 1 ]; then
+	echo "### This file auto-generated by https://github.com/ZwerOxotnik/factorio-example-mod" >> $CFG_FILE
+	echo "### Please, do not change this file manually!" >> $CFG_FILE
+	echo "[programmable-speaker-instrument]" >> $CFG_FILE
+	echo $sound_group_name=$sound_group_name >> $CFG_FILE
+	echo "[programmable-speaker-note]" >> $CFG_FILE
+fi
+echo "-- This file auto-generated by https://github.com/ZwerOxotnik/factorio-example-mod" >> $SOUNDS_LIST_PATH
+echo "-- Please, do not change this file if you're not sure, except sounds_list.name and path!" >> $SOUNDS_LIST_PATH
+echo "-- You need require this file to your control.lua and add https://mods.factorio.com/mod/zk-lib in your dependencies" >> $SOUNDS_LIST_PATH
+echo "" >> $SOUNDS_LIST_PATH
+echo "local sounds_list = {" >> $SOUNDS_LIST_PATH
+
+if [ $STATE -eq 1 ]; then
+	echo -e "\tname = \"$sound_group_name\", --change me, if you want to add these sounds to programmable speakers" >> $SOUNDS_LIST_PATH
+fi
+if [ $STATE -eq 2 ]; then
+	echo -e "\tname = nil --change me, if you want to add these sounds to programmable speakers" >> $SOUNDS_LIST_PATH
+fi
+echo -e "\tpath = \"__"$mod_name"__/"$folder_path"/\", -- path to this folder" >> $SOUNDS_LIST_PATH
+echo -e "\tsounds = {" >> $SOUNDS_LIST_PATH
+
+format=*.ogg
+files=($(find . -name "$format" -type f))
+for path in "${files[@]}"; do
+	name="$(basename -- $path)"
+	name=${name%.*}
+	echo -e "\t\t{" >> $SOUNDS_LIST_PATH
+	echo -e "\t\t\tname = \"$name\"", >> $SOUNDS_LIST_PATH
+	echo -e "\t\t}," >> $SOUNDS_LIST_PATH
+	if [ $STATE -eq 1 ]; then
+		echo $name=$name >> $CFG_FILE
+	fi
+done
+echo -e "\t}" >> $SOUNDS_LIST_PATH
+echo "}" >> $SOUNDS_LIST_PATH
+echo "" >> $SOUNDS_LIST_PATH
+echo if "puan_api then puan_api.add_sounds(sounds_list) end" >> $SOUNDS_LIST_PATH
+echo "" >> $SOUNDS_LIST_PATH
+echo "return sounds_list" >> $SOUNDS_LIST_PATH
+
+echo "You're almost ready!"
+echo "# You need to write 'require(\"__$mod_name__/$folder_path/sounds_list\")' in your $mod_name/control.lua"
+echo "# Add string \"zk-lib\" in dependencies of $mod_name/info.json, example: '\"dependencies\": [\"zk-lib\"]'"
+if [ $STATE -eq 1 ]; then
+	echo "# Put $CFG_FILE in folder "$mod_name"/locale/en (it'll provide readable text in the game)"
+fi
+
+echo ""
+echo ""
+
+echo "if you found a bug or you have a problem with script etc, please, let me know"
+echo "This script created by ZwerOxotnik (source: https://github.com/ZwerOxotnik/factorio-example-mod)"

.vscode/tasks.json

@@ -7,10 +7,29 @@
 			"problemMatcher": [],
 			"command": "bash",
 			"args": [".scripts/zip_mod.sh"],
-      "group": "build",
-      "presentation": {
+			"group": "build",
+			"presentation": {
 				"reveal": "silent",
-      }
+			}
+		},
+		{
+			"label": "Build html",
+			"type": "shell",
+			"problemMatcher": [],
+			"command": "sphinx-build -b html predocs docs/_build/html",
+			"args": [""],
+			"group": "build",
+			"presentation": {
+				"reveal": "silent",
+			}
+		},
+		{
+			"label": "Handle sounds",
+			"type": "shell",
+			"problemMatcher": [],
+			"command": "bash",
+			"args": [".scripts/handle_sounds.sh"],
+			"group": "build"
 		}
 	]
 }