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: 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 e28d95f180bd6511a2a509b4c07a1932237c2273 - feat: Package custom unit data when possible
It is required to share static unit, item, ability and doodad data
across different maps and scripts equally. Therefore, include the
required steps in the build process and into the repository.

The unit data must be exported from the World Editor and commited to the
repository every time the data must be upgraded for the project as a
whole.

The data will be duplicated for every map instead of relying on the
campaign inheritance. However, when a valid campaign MPQ archive will
finally be possible to produce automatically, the campaign unit data
file will be compiled for it as well.
Author: Vladyslav Bondarenko
Author date (UTC): 2022-12-14 02:23
Committer name: Vladyslav Bondarenko
Committer date (UTC): 2022-12-14 02:23
Parent(s): 4f17ffd9e6653d1d8f04587291ec9c95818643ad
Signer:
Signing key:
Signing status: N
Tree: f50ff878d527c6e78f5986be235b24c1eb0df80d
File Lines added Lines deleted
bin/compile.sh 4 5
bin/package.sh 7 1
bin/prepare-resources.sh 12 4
src/map1/main.j 4 12
src/map1/map1.m4 1 0
src/map1/map1.w3x 0 0
src/sorcerer/cmpgn.j 39 0
src/sorcerer/war3campaign.w3u 0 0
File bin/compile.sh copied from file bin/prepare-resources.sh (similarity 60%) (mode: 100755) (index d16089e..b37654e)
... ... set -e
3 3 BASEDIR=```readlink -f "$(dirname $0)/../"``` BASEDIR=```readlink -f "$(dirname $0)/../"```
4 4 BUILDDIR="${BASEDIR}/target" BUILDDIR="${BASEDIR}/target"
5 5 SRCDIR="${BASEDIR}/src" SRCDIR="${BASEDIR}/src"
6 echo 'bin/compile.sh'
6 7
7 mkdir -p "${BUILDDIR}/map1"
8 # TODO Select appropriate translation for the locale
9 cp "${SRCDIR}/map1/war3map.wts" "${BUILDDIR}/map1/"
10 m4 --debug=aeqp --include="${SRCDIR}" "${SRCDIR}/map1/map1.m4" > "${BUILDDIR}/map1/war3map.j"
8 # These resources are preprocessed and compiled before being imported.
9 # Therefore, create separate files for them in the build directory.
11 10
12 cp "${SRCDIR}/map1/map1.w3x" "${BUILDDIR}/"
11 m4 --debug=aeqp --include="${SRCDIR}" "${SRCDIR}/map1/map1.m4" > "${BUILDDIR}/map1/war3map.j"
13 12
14 13 sh "${BASEDIR}/bin/pjass.sh" "${BUILDDIR}/map1/war3map.j" sh "${BASEDIR}/bin/pjass.sh" "${BUILDDIR}/map1/war3map.j"
File bin/package.sh changed (mode: 100755) (index 3d5b872..a094855)
1 1 #!/bin/sh #!/bin/sh
2 echo 'bin/package.sh'
2 3 BASEDIR=```readlink -f "$(dirname $0)/../"``` BASEDIR=```readlink -f "$(dirname $0)/../"```
3 4 BUILDDIR="${BASEDIR}/target" BUILDDIR="${BASEDIR}/target"
4 5
5 6 OLDPWD=$PWD OLDPWD=$PWD
6 7
7 8 cd "${BUILDDIR}/map1/" cd "${BUILDDIR}/map1/"
8 smpq --add --overwrite "${BUILDDIR}/map1.w3x" war3map.j war3map.wts
9 smpq --add --overwrite "${BUILDDIR}/map1.w3x" war3map.j war3map.wts war3map.w3u
10 # FIXME Create valid campaign archive
11 # TODO Add versioning for the complete package
12 cd "${BUILDDIR}/"
13 smpq --create --overwrite "${BUILDDIR}/sorcerer-0.0.0WIP.w3n" war3campaign.w3u map1.w3x
14
9 15 smpq --list "${BUILDDIR}/map1.w3x" smpq --list "${BUILDDIR}/map1.w3x"
10 16 cd "${OLDPWD}" cd "${OLDPWD}"
File bin/prepare-resources.sh changed (mode: 100755) (index d16089e..706d441)
1 1 #!/bin/sh #!/bin/sh
2 set -e
2 echo 'bin/prepare-resources.sh'
3 3 BASEDIR=```readlink -f "$(dirname $0)/../"``` BASEDIR=```readlink -f "$(dirname $0)/../"```
4 4 BUILDDIR="${BASEDIR}/target" BUILDDIR="${BASEDIR}/target"
5 5 SRCDIR="${BASEDIR}/src" SRCDIR="${BASEDIR}/src"
6 6
7 7 mkdir -p "${BUILDDIR}/map1" 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}/map1/war3map.w3u"
13 ln -s "${SRCDIR}/sorcerer/war3campaign.w3u" "${BUILDDIR}/war3campaign.w3u"
8 14 # TODO Select appropriate translation for the locale # TODO Select appropriate translation for the locale
9 cp "${SRCDIR}/map1/war3map.wts" "${BUILDDIR}/map1/"
10 m4 --debug=aeqp --include="${SRCDIR}" "${SRCDIR}/map1/map1.m4" > "${BUILDDIR}/map1/war3map.j"
15 ln -s "${SRCDIR}/map1/war3map.wts" "${BUILDDIR}/map1/war3map.wts"
11 16
17 # These resources will be modified at packaging phase later. Therefore, copy
18 # them entirely to the build directory.
19
20 set -e
12 21 cp "${SRCDIR}/map1/map1.w3x" "${BUILDDIR}/" cp "${SRCDIR}/map1/map1.w3x" "${BUILDDIR}/"
13 22
14 sh "${BASEDIR}/bin/pjass.sh" "${BUILDDIR}/map1/war3map.j"
File src/map1/main.j changed (mode: 100644) (index a3f6666..fb5ffcb)
2 2
3 3 // divert(1) // divert(1)
4 4 globals globals
5 constant player USER = Player(0)
6 5 constant player PLAYER_UNDEAD = Player(1) constant player PLAYER_UNDEAD = Player(1)
7 6 constant player PLAYER_TROLL = Player(2) constant player PLAYER_TROLL = Player(2)
8 constant integer UNIT_TYPE_SORCERER = 'Hblm'
9 constant integer QUEST00 = 0
10 constant integer QUEST01 = 1
11 7 constant integer CONSTRAINT00 = 0 constant integer CONSTRAINT00 = 0
12 8 constant integer CONSTRAINT01 = 1 constant integer CONSTRAINT01 = 1
13 9 endglobals endglobals
 
... ... endfunction
124 120 function map1_init takes nothing returns nothing function map1_init takes nothing returns nothing
125 121 local real x = GetStartLocationX(GetPlayerId(USER)) local real x = GetStartLocationX(GetPlayerId(USER))
126 122 local real y = GetStartLocationX(GetPlayerId(USER)) local real y = GetStartLocationX(GetPlayerId(USER))
127 local unit u = CreateUnit(USER, UNIT_TYPE_SORCERER, x, y, bj_UNIT_FACING)
123 local unit u = CreateUnit(USER, UID_MARAKANIS, x, y, bj_UNIT_FACING)
128 124
129 125 local real x1 = GetStartLocationX(GetPlayerId(PLAYER_TROLL)) local real x1 = GetStartLocationX(GetPlayerId(PLAYER_TROLL))
130 126 local real y1 = GetStartLocationX(GetPlayerId(PLAYER_TROLL)) local real y1 = GetStartLocationX(GetPlayerId(PLAYER_TROLL))
131 local unit u1 = CreateUnit(PLAYER_TROLL, 'Oshd', x1, y1, bj_UNIT_FACING)
127 local unit u1 = CreateUnit(PLAYER_TROLL, UID_PTATAKOKWA, x1, y1, bj_UNIT_FACING)
132 128
133 129 local timer t = null local timer t = null
134 130 local trigger u_death_trg = null local trigger u_death_trg = null
 
... ... function map1_init takes nothing returns nothing
138 134 call SelectUnit(u, true) call SelectUnit(u, true)
139 135 endif endif
140 136
141 call EnableMinimapFilterButtons(false, false)
142
143 call quest_create(QUEST00, "Kill Ptatakokwa", "This troll is getting on your nerves.", null, true)
144
145 call quest_create(QUEST01, "Kill Marakanis", "This elf is getting on your nerves.", null, true)
137 call cmpgn_quest_init()
146 138
147 139 call quest_constraint_unit_survives_create(CONSTRAINT00, USER, u) call quest_constraint_unit_survives_create(CONSTRAINT00, USER, u)
148 140 call quest_constraint_unit_survives_create(CONSTRAINT01, PLAYER_TROLL, u1) call quest_constraint_unit_survives_create(CONSTRAINT01, PLAYER_TROLL, u1)
 
... ... function map1_init takes nothing returns nothing
159 151 call quest_enable(QUEST01, PLAYER_TROLL) call quest_enable(QUEST01, PLAYER_TROLL)
160 152
161 153 set t = CreateTimer() set t = CreateTimer()
162 call TimerStart(t, 36.0, false, function map1_quest_discover)
154 call TimerStart(t, 4.0, false, function map1_quest_discover)
163 155 endfunction endfunction
164 156
165 157 function main takes nothing returns nothing function main takes nothing returns nothing
File src/map1/map1.m4 changed (mode: 100644) (index 759ed28..08be0d3)
2 2 // define(endglobals, )dnl # Replace every 'endglobals' token with empty string // define(endglobals, )dnl # Replace every 'endglobals' token with empty string
3 3 // include(base/quest.j) // include(base/quest.j)
4 4 // include(spellbook/spell00.j) // include(spellbook/spell00.j)
5 // include(sorcerer/cmpgn.j)
5 6 // include(map1/main.j) // include(map1/main.j)
6 7 // undefine(`globals')dnl # Leave 'globals' token as it is // undefine(`globals')dnl # Leave 'globals' token as it is
7 8 // undefine(`endglobals')dnl # Leave 'endglobals' token as it is // undefine(`endglobals')dnl # Leave 'endglobals' token as it is
File src/map1/map1.w3x changed (mode: 100644) (index 70470d8..ef0e988)
File src/sorcerer/cmpgn.j added (mode: 100644) (index 0000000..d16b8bd)
1 // src/sorcerer/cmpgn.j
2
3 //divert(1)
4 globals
5 constant player USER = Player(0)
6
7 // Unit type identifier constants
8 constant integer UID_MARAKANIS = 'H000'
9 constant integer UID_PTATAKOKWA = 'O000'
10
11 // Quests
12 constant integer QUEST00 = 0
13 constant integer QUEST01 = 1
14 endglobals
15 //divert(0)
16
17 //divert(2)
18 function cmpgn_quest_init takes nothing returns nothing
19 local string title
20 local string desc
21 local string icon
22
23 set title = "Kill Ptatakokwa"
24 set desc = "This troll is getting on your nerves."
25 set icon = QUEST_DEFAULT_ICON_PATH
26 call quest_create(QUEST00, title, desc, icon, QUEST_MAINQUEST_FLAG)
27
28 set title = "Kill Marakanis"
29 set desc = "This elf is getting on your nerves."
30 set icon = QUEST_DEFAULT_ICON_PATH
31 call quest_create(QUEST01, title, desc, icon, QUEST_MAINQUEST_FLAG)
32 endfunction
33
34 function cmpgn_init takes nothing returns nothing
35 call cmpgn_quest_init()
36
37 call EnableMinimapFilterButtons(false, false)
38 endfunction
39 //divert(0)
File src/sorcerer/war3campaign.w3u added (mode: 100644) (index 0000000..dc231db)
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