vrtc / sorcererw3n (public) (License: CC0) (since 2022-12-13) (hash sha1)
Custom campaign for WarCraft3-1.27a. It requires complex build tools that are reusable and may serve as an example of dos and donts. Hence, the need for a managed repository.
Clone URLs: https://rocketgit.com/user/vrtc/sorcererw3n ssh://rocketgit@ssh.rocketgit.com/user/vrtc/sorcererw3n git://git.rocketgit.com/user/vrtc/sorcererw3n
develop master
List of commits:
Subject Hash Author Date (UTC)
feat(build)!: Add first Apache Ant build descriptor d31e56fdf056a8928e45d5778e705f7c0984e49f Vladyslav Bondarenko 2023-01-08 17:23:01
feat(build)!: Create valid custom campaign archive 72cf187d0fc7d5438145a6ddf7ad72e23beec42c Vladyslav Bondarenko 2023-01-07 16:12:47
feat: Parametrize individual spell00 spellcasts 08560a980369527f3fc962e3da384da1ef97ce6f Vladyslav Bondarenko 2022-12-17 22:15:56
feat(doc): Add article on m4 pitfalls 2d95ed54414b150e45c391bc04b81fa6845c2797 Vladyslav Bondarenko 2022-12-17 13:23:09
fix(build)!: Include scripts for preprocessing b16c534a4018408be9df186870f293620696603b Vladyslav Bondarenko 2022-12-17 13:20:30
feat: Add spell stub and it's required resources d2ddbeca89c691847f79233aba8b47792b35c52c Vladyslav Bondarenko 2022-12-15 05:12:18
feat: Package custom unit data when possible e28d95f180bd6511a2a509b4c07a1932237c2273 Vladyslav Bondarenko 2022-12-14 02:23:42
fix!: Show quest buttons and messages correctly 4f17ffd9e6653d1d8f04587291ec9c95818643ad Vladyslav Bondarenko 2022-12-13 21:52:45
feat!: Initial commit b1de946d39ba2c2927cd283c0cb5164fd71e6fa0 Vladyslav Bondarenko 2022-12-13 08:58:53
Commit d31e56fdf056a8928e45d5778e705f7c0984e49f - feat(build)!: Add first Apache Ant build descriptor
Previously, in order to automatically execute all the complex steps
required to produce a working custom campaign archive, Bash shell
scripts were used. However, there are two problems with them. First,
they are difficult to install on Windows OS. Second, Bash shell scripts
lack focus and tools to implement sane build automation system.
Therefore, a generic build automation tool, that is Apache Ant 1.10,
replaces previously used Bash scripts.

The current Apache Ant build descriptor supports all previous features
of late Bash scripts. It parses source Jass snippets, generates
war3map.j script for map and packages required metadata in MPQ archives
(w3x, w3n).

The dependency on external tools remains the same: m4, smpq, pjass. It
is likely easier to configure and port them to work with Ant than with Bash
scripts.

Modifications to the build descriptor will be required as more maps are
added, but not for adding new Jass snippets.
Author: Vladyslav Bondarenko
Author date (UTC): 2023-01-08 17:23
Committer name: Vladyslav Bondarenko
Committer date (UTC): 2023-01-08 17:23
Parent(s): 72cf187d0fc7d5438145a6ddf7ad72e23beec42c
Signer:
Signing key: EFF9624877D25D02
Signing status: E
Tree: a8fdfc990c0a0a7ef4456e64d90879cbf108a2c5
File Lines added Lines deleted
.gitignore 1 0
bin/compile.sh 0 13
bin/package.sh 0 16
bin/pjass.sh 0 24
bin/prepare-resources.sh 0 28
build.properties 6 0
build.xml 153 0
etc/README.md 28 0
src/map1/map1.w3x 0 0
src/sorcerer/war3campaign.wts 30 0
File .gitignore changed (mode: 100644) (index 50acd46..dc8bf97)
1 1 *.swp *.swp
2 2 *~ *~
3 local.properties
3 4 target/ target/
File bin/compile.sh deleted (index b37654e..0000000)
1 #!/bin/sh
2 set -e
3 BASEDIR=```readlink -f "$(dirname $0)/../"```
4 BUILDDIR="${BASEDIR}/target"
5 SRCDIR="${BASEDIR}/src"
6 echo 'bin/compile.sh'
7
8 # These resources are preprocessed and compiled before being imported.
9 # Therefore, create separate files for them in the build directory.
10
11 m4 --debug=aeqp --include="${SRCDIR}" "${SRCDIR}/map1/map1.m4" > "${BUILDDIR}/map1/war3map.j"
12
13 sh "${BASEDIR}/bin/pjass.sh" "${BUILDDIR}/map1/war3map.j"
File bin/package.sh deleted (index c914b1a..0000000)
1 #!/bin/sh
2 echo 'bin/package.sh'
3 BASEDIR=```readlink -f "$(dirname $0)/../"```
4 BUILDDIR="${BASEDIR}/target"
5
6 OLDPWD=$PWD
7
8 cd "${BUILDDIR}/map1/"
9 smpq --add --overwrite "${BUILDDIR}/map1.w3x" war3map.j war3map.wts war3map.w3u war3map.w3a
10 # TODO Add versioning for the complete package
11 cd "${BUILDDIR}/"
12 smpq --add --overwrite "${BUILDDIR}/sorcerer-0.0.0WIP-1.27-en.w3n" war3campaign.w3u war3campaign.w3a
13 smpq --add --overwrite --single-unit --compression none "${BUILDDIR}/sorcerer-0.0.0WIP-1.27-en.w3n" map1.w3x
14
15 smpq --list "${BUILDDIR}/map1.w3x"
16 cd "${OLDPWD}"
File bin/pjass.sh deleted (index af8cd76..0000000)
1 #!/bin/sh
2
3 set -e
4
5 # Cannot rely on an old bug in the game engine
6 # Ignore errors in the original Blizzard scripts
7 # Re-enable semantic error checks
8 # Enable all possible sanity checks
9 # Start parsing user scripts, paths to which are provided as arguments
10
11 BASEDIR=```readlink -f "$(dirname $0)/../"```
12
13 pjass \
14 -rb \
15 +nosemanticerror \
16 "${BASEDIR}/etc/common.j" \
17 "${BASEDIR}/etc/common.ai" \
18 "${BASEDIR}/etc/Blizzard.j" \
19 -nosemanticerror \
20 +filter \
21 +shadow \
22 +checkglobalsinit \
23 +checkstringhash \
24 $@
File bin/prepare-resources.sh deleted (index b98cad0..0000000)
1 #!/bin/sh
2 echo 'bin/prepare-resources.sh'
3 BASEDIR=```readlink -f "$(dirname $0)/../"```
4 BUILDDIR="${BASEDIR}/target"
5 SRCDIR="${BASEDIR}/src"
6
7 mkdir -p "${BUILDDIR}/map1"
8
9 # These resources remain unmodified and will be imported like this. Therefore,
10 # do not copy but only create symbolik links to them in the build directory.
11
12 ln -s "${SRCDIR}/sorcerer/war3campaign.w3u" "${BUILDDIR}/war3campaign.w3u"
13 ln -s "${SRCDIR}/sorcerer/war3campaign.w3a" "${BUILDDIR}/war3campaign.w3a"
14 # TODO Select appropriate translation for the locale
15 ln -s "${SRCDIR}/sorcerer/war3campaign.wts" "${BUILDDIR}/war3campaign.wts"
16
17 ln -s "${SRCDIR}/sorcerer/war3campaign.w3u" "${BUILDDIR}/map1/war3map.w3u"
18 ln -s "${SRCDIR}/sorcerer/war3campaign.w3a" "${BUILDDIR}/map1/war3map.w3a"
19 # TODO Select appropriate translation for the locale
20 ln -s "${SRCDIR}/map1/war3map.wts" "${BUILDDIR}/map1/war3map.wts"
21
22 # These resources will be modified at packaging phase later. Therefore, copy
23 # them entirely to the build directory.
24
25 set -e
26 cp "${SRCDIR}/sorcerer/sorcererstub.w3n" "${BUILDDIR}/sorcerer-0.0.0WIP-1.27-en.w3n"
27 cp "${SRCDIR}/map1/map1.w3x" "${BUILDDIR}/"
28
File build.properties added (mode: 100644) (index 0000000..a57a482)
1 project.builddir=target
2 project.executable.m4=m4
3 project.executable.pjass=pjass
4 project.executable.smpq=smpq
5 project.scriptsdir=etc
6 project.version=0.0.0WIP
File build.xml added (mode: 100644) (index 0000000..02c67ca)
1 <project name="sorcererw3n" default="package">
2 <!-- Check Ant version -->
3 <antversion atleast="1.10.9" property="project.antversion.atleast"/>
4 <fail unless="project.antversion.atleast"/>
5 <!-- Mandatory properties -->
6 <loadproperties encoding="UTF-8">
7 <file file="build.properties"/>
8 </loadproperties>
9 <!-- Optional override properties, user and build environment specific -->
10 <property file="local.properties"/>
11 <fileset id="project.base.fileset.jass" dir="src/base">
12 <include name="**/*.j"/>
13 <exclude name="**/*.m4"/>
14 </fileset>
15 <fileset id="project.spellbook.fileset.jass" dir="src/spellbook">
16 <include name="**/*.j"/>
17 <exclude name="**/*.m4"/>
18 </fileset>
19 <fileset id="project.sorcerer.fileset.jass" dir="src/sorcerer">
20 <include name="**/*.j"/>
21 <exclude name="**/*.m4"/>
22 </fileset>
23 <fileset id="project.map1.fileset.jass" dir="src/map1">
24 <include name="**/*.j"/>
25 <exclude name="**/*.m4"/>
26 </fileset>
27 <path id="project.map1.path.jass">
28 <fileset refid="project.base.fileset.jass" />
29 <fileset refid="project.spellbook.fileset.jass" />
30 <fileset refid="project.sorcerer.fileset.jass" />
31 <fileset refid="project.map1.fileset.jass" />
32 </path>
33 <target name="pjass">
34 <exec executable="${project.executable.pjass}" failonerror="true" failifexecutionfails="true">
35 <!-- load native declarations -->
36 <arg file="${project.scriptsdir}/common.j"/>
37 <arg file="${project.scriptsdir}/Blizzard.j"/>
38 <arg file="${project.scriptsdir}/common.ai"/>
39 <!-- reliance on Return bug is forbidden -->
40 <arg value="-rb"/>
41 <!-- enable all available code static analysis -->
42 <arg value="+filter"/>
43 <arg value="+shadow"/>
44 <arg value="+checkglobalsinit"/>
45 <arg value="+checkstringhash"/>
46 <arg line="${project.target.pjass.line}"/>
47 </exec>
48 </target>
49 <target name="validate" description="check if the build environment is ready for work">
50 <echo>validate:m4</echo>
51 <exec executable="${project.executable.m4}" failonerror="true" failifexecutionfails="true">
52 <arg value="--version"/>
53 </exec>
54 <echo>validate:smpq</echo>
55 <exec executable="${project.executable.smpq}" failonerror="true" failifexecutionfails="true">
56 <arg value="--version"/>
57 </exec>
58 <echo>validate:pjass</echo>
59 <antcall target="pjass">
60 <param name="project.target.pjass.line" value=""/>
61 </antcall>
62 </target>
63 <target name="process-sources" description="parse all Jass source snippets with pjass">
64 <!-- Load a colon separated strip of Jass snippet file names,
65 then replace the colon with empty space,
66 and pass it as a command line argument to pjass. -->
67 <pathconvert refid="project.map1.path.jass" pathsep=" " property="project.map1.path.jass.line"/>
68 <antcall target="pjass">
69 <param name="project.target.pjass.line" value="${project.map1.path.jass.line}"/>
70 </antcall>
71 </target>
72 <target name="generate-sources" description="generate final war3map.j scripts for all maps with m4">
73 <!-- TODO Use MacroDef or subproject builds to adapt tasks for all individual maps. -->
74 <mkdir dir="${project.builddir}/map1"/>
75 <exec executable="${project.executable.m4}" output="${project.builddir}/map1/war3map.j" failonerror="true" failifexecutionfails="true">
76 <arg value="--debug=aeqp"/>
77 <arg value="-I ${basedir}"/>
78 <arg value="src/map1/map1.m4"/>
79 </exec>
80 </target>
81 <target name="compile" depends="process-sources,generate-sources" description="parse Jass scripts that will be packaged with pjass">
82 <antcall target="pjass">
83 <param name="project.target.pjass.line" value="${project.builddir}/map1/war3map.j"/>
84 </antcall>
85 </target>
86 <target name="process-resources">
87 </target>
88 <target name="prepare-package" depends="compile,process-resources" description="copy and arrange files before packaging">
89 <!-- TODO Files *.w3a, *.w3u or *.wts require localization -->
90 <mkdir dir="${project.builddir}/map1"/>
91 <copy file="src/sorcerer/war3campaign.w3a" overwrite="true" todir="${project.builddir}"/>
92 <copy file="src/sorcerer/war3campaign.w3u" overwrite="true" todir="${project.builddir}"/>
93 <copy file="src/sorcerer/war3campaign.wts" overwrite="true" todir="${project.builddir}"/>
94 <!-- FIXME It might not be needed to duplicate metadata in both campaign and map. -->
95 <copy file="src/sorcerer/war3campaign.w3a" overwrite="true" tofile="${project.builddir}/map1/war3map.w3a"/>
96 <copy file="src/sorcerer/war3campaign.w3u" overwrite="true" tofile="${project.builddir}/map1/war3map.w3u"/>
97 <copy file="src/sorcerer/sorcererstub.w3n" overwrite="true" tofile="${project.builddir}/sorcerer-${project.version}-1.27-en.w3n"/>
98 <copy file="src/map1/war3map.wts" overwrite="true" todir="${project.builddir}/map1"/>
99 <copy file="src/map1/map1.w3x" overwrite="true" todir="${project.builddir}"/>
100 </target>
101 <target name="package" depends="prepare-package" description="produce valid custom campaign MPQ archive (w3n) with smpq">
102 <!-- NOTE The path to subject MPQ archive MUST be absolute. -->
103 <!-- NOTE The paths to files that are added to the subject MPQ archive MUST be relative. -->
104 <exec executable="${project.executable.smpq}" dir="${project.builddir}/map1" failonerror="true" failifexecutionfails="true">
105 <arg value="--add"/>
106 <arg value="--overwrite"/>
107 <arg value="--compression"/>
108 <arg value="zlib"/>
109 <arg file="${project.builddir}/map1.w3x"/>
110 <arg value="war3map.w3a"/>
111 <arg value="war3map.w3u"/>
112 <arg value="war3map.wts"/>
113 <arg value="war3map.j"/>
114 </exec>
115 <exec executable="${project.executable.smpq}" dir="${project.builddir}" failonerror="true" failifexecutionfails="true">
116 <arg value="--add"/>
117 <arg value="--overwrite"/>
118 <arg value="--compression"/>
119 <arg value="zlib"/>
120 <arg file="${project.builddir}/sorcerer-${project.version}-1.27-en.w3n"/>
121 <arg value="war3campaign.w3a"/>
122 <arg value="war3campaign.w3u"/>
123 <arg value="war3campaign.wts"/>
124 </exec>
125 <exec executable="${project.executable.smpq}" dir="${project.builddir}" failonerror="true" failifexecutionfails="true">
126 <arg value="--add"/>
127 <arg value="--overwrite"/>
128 <arg value="--single-unit"/>
129 <arg value="--compression"/>
130 <arg value="none"/>
131 <arg file="${project.builddir}/sorcerer-${project.version}-1.27-en.w3n"/>
132 <arg value="map1.w3x"/>
133 </exec>
134 </target>
135 <target name="verify" description="print final custom campaign MPQ archive information">
136 <exec executable="${project.executable.smpq}" dir="${project.builddir}" failonerror="true" failifexecutionfails="true">
137 <arg value="--info"/>
138 <arg file="${project.builddir}/sorcerer-${project.version}-1.27-en.w3n"/>
139 </exec>
140 <exec executable="${project.executable.smpq}" dir="${project.builddir}" failonerror="true" failifexecutionfails="true">
141 <arg value="--list"/>
142 <arg file="${project.builddir}/sorcerer-${project.version}-1.27-en.w3n"/>
143 </exec>
144 <exec executable="${project.executable.smpq}" dir="${project.builddir}" failonerror="true" failifexecutionfails="true">
145 <arg value="--info"/>
146 <arg file="${project.builddir}/map1.w3x"/>
147 </exec>
148 <exec executable="${project.executable.smpq}" dir="${project.builddir}" failonerror="true" failifexecutionfails="true">
149 <arg value="--list"/>
150 <arg file="${project.builddir}/map1.w3x"/>
151 </exec>
152 </target>
153 </project>
File etc/README.md added (mode: 100644) (index 0000000..ee81c8b)
1 # Blizzard Jass2 scripts
2
3 This directory should contain the following Blizzard script files:
4 - common.j
5 - Blizzard.j
6 - common.ai
7
8 These files are distributed with the game and contain declarations of
9 funcctions and variables for Jass2 scripting language, that is available to
10 users at runtime.
11
12 These files are duplicated in the project's repository for several practical
13 reasons.
14
15 When the project is built, 'pjass' parses all the project specific scripts and
16 checks them for validtity before the game is even run or the campaign packaged.
17 Files with native declarations must be included in the tool's path for it to
18 work. Hence why these files must be readily present during development.
19
20 Additionally, these files specifically are used to decisively test the project
21 for validity against specific game version (1.27), from which these native
22 declarations were obtained from. If the project should be ported to some other
23 game version, these files must be upgraded to appropriate version.
24
25 'pjass' is a free community tool that is used to parse Jass2 scripts. Since
26 game version >1.31, 'pjass' should be included in the official game
27 distribution. Note that 'pjass' is easily built for GNU/Linux natively from
28 source.
File src/map1/map1.w3x changed (mode: 100644) (index a684545..0fe2b86)
File src/sorcerer/war3campaign.wts added (mode: 100644) (index 0000000..b6e2b49)
1 STRING 1
2 {
3 Sorcerous Heritage
4 }
5
6 STRING 2
7 {
8 Normal
9 }
10
11 STRING 3
12 {
13 Nondescript
14 }
15
16 STRING 5
17 {
18 vladyslavbond@protonmail.com
19 }
20
21 STRING 6
22 {
23 Chapter One
24 }
25
26 STRING 7
27 {
28 Untitled Button
29 }
30
Hints:
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://rocketgit.com/user/vrtc/sorcererw3n

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@ssh.rocketgit.com/user/vrtc/sorcererw3n

Clone this repository using git:
git clone git://git.rocketgit.com/user/vrtc/sorcererw3n

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a merge request:
... clone the repository ...
... make some changes and some commits ...
git push origin main