📝 update readme and add commit hooks

.githooks/pre-commit

@@ -0,0 +1,80 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed.
+# Called by "git commit" with no arguments.  The hook should
+# exit with non-zero status after issuing an appropriate message if
+# it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-commit".
+
+if git rev-parse --verify HEAD >/dev/null 2>&1
+then
+	against=HEAD
+else
+	# Initial commit: diff against an empty tree object
+	against=$(git hash-object -t tree /dev/null)
+fi
+
+# If you want to allow non-ASCII filenames set this variable to true.
+allownonascii=$(git config --bool hooks.allownonascii)
+
+## CUSTOM
+# pull aaaaaaaaaaaadventu.re script
+curl https://aaaaaaaaaaaadventu.re/replace_slugs2.sh -o script/current/replace_slugs2.sh
+# ./replace_slugs2.sh *.json hbf/*.json
+
+# compare with last one
+currentHash=$(sha1sum script/current/replace_slugs2.sh | awk '{ print $1 }')
+reviewedHash=$(sha1sum script/reviewed/replace_slugs2.sh | awk '{ print $1 }')
+if [ "$currentHash" != "$reviewedHash" ]; then
+	echo "Slug replacement script changed! Review it and move it to the reviewed folder!"
+	exit 1
+else
+    # ask for code review and exit
+	echo "Slug replacement script was not changed"
+fi
+
+# execute script if there is no difference
+chmod -x script/reviewed/replace_slugs2.sh
+
+# go to folder for a^12dventure files
+rm -r a12dventure
+cp -r 2rc3 a12dventure
+cd a12dventure
+chmod +x ../script/reviewed/replace_slugs2.sh
+../script/reviewed/replace_slugs2.sh
+# add all new files
+git add *
+echo "copied and modified files"
+
+## END CUSTOM
+
+# Redirect output to stderr.
+exec 1>&2
+
+# Cross platform projects tend to avoid non-ASCII filenames; prevent
+# them from being added to the repository. We exploit the fact that the
+# printable range starts at the space character and ends with tilde.
+if [ "$allownonascii" != "true" ] &&
+	# Note that the use of brackets around a tr range is ok here, (it's
+	# even required, for portability to Solaris 10's /usr/bin/tr), since
+	# the square bracket bytes happen to fall in the designated range.
+	test $(git diff --cached --name-only --diff-filter=A -z $against |
+	  LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
+then
+	cat <<\EOF
+Error: Attempt to add a non-ASCII file name.
+
+This can cause problems if you want to work with people on other platforms.
+
+To be portable it is advisable to rename the file.
+
+If you know what you are doing you can disable this check using:
+
+  git config hooks.allownonascii true
+EOF
+	exit 1
+fi
+
+# If there are whitespace errors, print the offending file names and fail.
+exec git diff-index --check --cached $against --

README.md

@@ -28,6 +28,7 @@ If not stated otherwise, the files are licensed under the terms of [CC-BY 4.0](h
 * `2rc3/` Contains the tiled maps in `*.json` format. Make your changes here.
 
 * `a12dventure/` Deployed version. Will be updated at commit time.
+  * see commit hooks chapter
 
 * `badges/` source images to create badges at congrass time.
 
@@ -45,3 +46,8 @@ Clone with the argument `--recurse-submodules` or initialize the submodules with
 
 * Put the image files (in `*.png` format) in the main folder and ensure the embedded tilesets refer to them as relative path (`../your_image.png`).
 
+### Commit hook
+
+Please enabe the pre-commit hook that updates the a12dventure version:
+
+ `git config --local core.hooksPath .githooks/`