Revert "also allow _bump", because DDS-converted _bump will not work, we NEED _norm

[xonotic/xonotic-maps.pk3dir.git] / scripts / shader-audit.sh

diff --git a/scripts/shader-audit.sh b/scripts/shader-audit.sh
old mode 100644 (file)
new mode 100755 (executable)
index af3d03e..83aba6b
--- a/scripts/shader-audit.sh
+++ b/scripts/shader-audit.sh
@@ -1,5 +1,11 @@
 #!/bin/sh
 
+case "$0" in
+       */*)
+               cd "${0%/*}"
+               ;;
+esac
+
 LF="
 "
 
@@ -56,6 +62,7 @@ use_texture()
        fi
 
        case "$3" in
+               ## RULE: skyboxes must lie in env/
                sky)
                        case "$2" in
                                env/*)
@@ -65,6 +72,7 @@ use_texture()
                                        ;;
                        esac
                        ;;
+               ## RULE: non-skyboxes must not lie in env/
                *)
                        case "$2" in
                                env/*)
@@ -78,10 +86,10 @@ use_texture()
 
        # verify shader -> texture name
        case "$1" in
+               ## RULE: textures/FOOx/BAR-BAZ must use textures/FOOx/*/*, recommended textures/FOOx/BAR/BAZ
                textures/*x/*-*)
                        pre=${1%%x/*}x
                        suf=${1#*x/}
-                       # rule: in suffix part, change each - to /
                        suf="`echo "$suf" | sed 's,-,/,g'`"
                        case "$2" in
                                "$pre"/*/*)
@@ -91,6 +99,7 @@ use_texture()
                                        ;;
                        esac
                        ;;
+               ## RULE: textures/FOOx/BAR must use textures/FOOx/*/*, recommended textures/FOOx/base/BAR
                textures/*x/*)
                        pre=${1%%x/*}x
                        suf=${1#*x/}
@@ -102,6 +111,7 @@ use_texture()
                                        ;;
                        esac
                        ;;
+               ## RULE: textures/map_FOO[_/]* must use textures/map_FOO[_/]*
                textures/map_*/*)
                        pre=${1%%/map_*}
                        suf=${1#*/map_}
@@ -109,11 +119,16 @@ use_texture()
                        case "$2" in
                                "$pre"/map_$map[/_]*)
                                        ;;
-                               *)
+                               textures/map_*)
+                                       # protect one map's textures from the evil of other maps :P
                                        echo "(EE) texture $2 of shader $1 is out of place, recommended file name is $pre/map_$map/*"
                                        ;;
+                               *)
+                                       # using outside stuff is permitted
+                                       ;;
                        esac
                        ;;
+               ## RULE: textures/common/FOO must use textures/common/FOO or textures/common/*/*
                textures/common/*)
                        case "$2" in
                                "$1")
@@ -125,10 +140,11 @@ use_texture()
                                        ;;
                        esac
                        ;;
+               ## RULE: textures/FOO/* must use textures/FOO/*, for FOO in decals, liquids_water, liquids_slime, liquids_lava, warpzone
                textures/decals/*|textures/liquids_water/*|textures/liquids_slime/*|textures/liquids_lava/*|textures/warpzone/*)
-                       prefix=${1%%_*}
+                       pre=${1%/*}
                        case "$2" in
-                               "$prefix"_*|"$prefix")
+                               "$pre"/*)
                                        # I _suppose_ this is fine, as tZork committed this pack
                                        ;;
                                *)
@@ -136,6 +152,7 @@ use_texture()
                                        ;;
                        esac
                        ;;
+               ## RULE: textures/skies/FOO or textures/skies/FOO_BAR must use textures/skies/FOO respective textures/skies/FOO_BAR as preview image, and env/FOO[_/]* as skybox
                textures/skies/*)
                        sky=${1#textures/skies/}
                        sky=${sky%%_*}
@@ -151,6 +168,7 @@ use_texture()
                                        ;;
                        esac
                        ;;
+               ## RULE: models/* must use models/*
                models/*)
                        case "$2" in
                                models/*)
@@ -169,7 +187,7 @@ use_texture()
 parsing_shader=
 parse_shaderstage()
 {
-       while read L A1 A2 Aother; do
+       while read L A1 Aother; do
                case "$L" in
                        map)
                                case "$A1" in
@@ -181,7 +199,7 @@ parse_shaderstage()
                                esac
                                ;;
                        animmap)
-                               for X in $A2 $Aother; do
+                               for X in $Aother; do
                                        use_texture "$parsing_shader" "`normalize "$X"`" animmap
                                done
                                ;;
@@ -197,13 +215,18 @@ parse_shaderstage()
 parse_shader()
 {
        use_texture "$parsing_shader" "$parsing_shader" shader
-       while read L A1; do
+       while read L A1 Aother; do
                case "$L" in
-                       qer_editorimage\ *)
-                               use_texture "$parsing_shader" "$A1" editorimage
+                       qer_editorimage)
+                               use_texture "$parsing_shader" "`normalize "$A1"`" editorimage
                                ;;
-                       skyparms\ *)
-                               use_texture "$parsing_shader" "$A1" sky
+                       skyparms)
+                               use_texture "$parsing_shader" "${A1}_lf" sky
+                               use_texture "$parsing_shader" "${A1}_rt" sky
+                               use_texture "$parsing_shader" "${A1}_up" sky
+                               use_texture "$parsing_shader" "${A1}_dn" sky
+                               use_texture "$parsing_shader" "${A1}_ft" sky
+                               use_texture "$parsing_shader" "${A1}_bk" sky
                                ;;
                        '{')
                                parse_shaderstage
@@ -220,17 +243,25 @@ parse_shader()
 parse_shaderfile()
 {
        case "$1" in
+               ## RULE: map_FOO.shader may define tetxures/map_FOO_* and textures/map_FOO/*
                map_*)
                        allowed_prefixes="textures/map_`echo "$1" | cut -d _ -f 2`_ textures/map_`echo "$1" | cut -d - -f 2`/"
                        forbidden_prefixes=
                        ;;
+               ## RULE: skies_FOO.shader may define tetxures/skies/FOO and textures/skies/FOO_*
                skies_*)
                        allowed_prefixes="textures/skies/`echo "$1" | cut -d _ -f 2`: textures/skies/`echo "$1" | cut -d _ -f 2`_"
                        forbidden_prefixes=
                        ;;
+               ## RULE: model_*.shader may define models/*
+               model_*)
+                       allowed_prefixes="models/"
+                       forbidden_prefixes=
+                       ;;
+               ## RULE: any other FOO.shader may define textures/FOO/*
                *)
-                       allowed_prefixes=
-                       forbidden_prefixes="textures/skies/ textures/map_"
+                       allowed_prefixes="textures/$1/"
+                       forbidden_prefixes="textures/skies/ textures/map_ models/"
                        ;;
        esac
        while read L; do
@@ -255,14 +286,14 @@ strip_comments()
        sed 's,//.*,,g; s,\r, ,g; s,\t, ,g; s,  *, ,g; s, $,,; s,^ ,,; /^$/ d'
 }
 
-t=`mktemp`
+t=`mktemp || echo ".temp"`
 for X in *.shader; do
        strip_comments < "$X" > "$t"
        parse_shaderfile "${X%.shader}" < "$t"
 done
 rm -f "$t"
 
-textures_avail=`( cd ..; find textures/ -type f -not -name '*_norm.*' -not -name '*_glow.*' -not -name '*_gloss.*' -not -name '*.xcf' ) | while IFS= read -r T; do normalize "$T"; done | sort -u`
+textures_avail=`( cd ..; find textures/ -type f -not -name '*_norm.*' -not -name '*_glow.*' -not -name '*_gloss.*' -not -name '*_reflect.*' -not -name '*.xcf' ) | while IFS= read -r T; do normalize "$T"; done | sort -u`
 textures_used=`echo "${textures_used#$LF}" | sort -u`
 
 echo "$textures_used$LF$textures_used$LF$textures_avail" | sort | uniq -u | while IFS= read -r L; do