-= Gametoast.com =-

How to add HQ mode to your map

Hello community!
This tutorial will teach you how to add the mode "headquarters" to your map.

"Wait!", you might say, "what is this guy talking about? What is HQ mode?"

HQ mode is something I always wished for my maps (I got inspired by the Clone Wars game for GameCube), but it appeared that I couldn't find a tutorial for it. There was a mode called "sand castles" in the Beach Troopers mod by Maveritchell (I really love this mod), but that wasn't really what I was looking for and there where no other sources to look at. With pretty much no lua experience I started to create my own.
This is how it turned out:

In HQ mode you need to destroy the enemy HQ to win.
Each team possesses one HQ and several outposts which are destructible CPs. For each CP that gets destroyed, the HQ's energy is reduced significantly, which is why it is advisable not to attack the HQ until all hostile CPs are destroyed. You can also repair destroyed CPs, but only when the timer elapses that is triggered when a CP gets destroyed.
For each CP that is destroyed while the timer is running additional time will be added to your timer so that you cannot repair any destroyed CPs during this time.

These pictures will give you a better impression: As said, the outposts that have to be destroyed are CPs.
This is very useful because if one team loses a lot of cps, all of the respawning units will spawn at the remaining CPs so that they are better protected.
It can be pretty challenging to win in SP, but in MP, this mode is the real fun. Try it out;)
(Note that the map shown on the screenies turned out to be way too big and chaotic and is also very close to ZEs object limit. It was one of my first maps, too. If you want to play it anyways or take a look at the complete source files, you can find a download link at the end of this post.)



Instructions:

If you want to add this mode to your map, here's what you need to do.
I expect you to have basic modding knowledge and you should know how to add new modes to your map.
(Scroll down to the end of this post to download everything you need to add HQ mode to your map.)


1. The whole scripting part is done in the "ObjectiveHQ.lua".
I don't recommend you to change anything in here unless you know what you're doing.
I made a couple of comments, but still ... This is what the lua contains: 2. Copy the ObjectiveHQ.lua from the downloaded package and paste it into your ...\data_MAP\common\scripts folder.

3. Goto ...\data_MAP\Common and open mission.req. It should look similar to this: Now, add "ObjectiveHQ" in the script sections. The final result should look similar to this: 4. Now to the rather difficult part: HQ mode requires a new script for that mode (obviously), but also a new layer in ZE.
With the 1.3 patch [RDH]Zerted provided a couple of very useful additions. You can use whichever suffix you want that came with the latest release: Create a script for that mode and add it to your mission.req, just as you have done before.
But this time add it the "lvl" section. 5.) Add the mode to the addme.lua. I have marked everthing new with --!!!. 6. Add your layer to ZE. How to add a new layer for hunt mode is described in this tutorial - you can do this for HQ accordingly.


7. In the new layer, you need to place the HQ relevant objects. These are the destructible outposts (CPs) and the HQs. First of all, copy the ODFs, meshes and textures from the package to your world odf/msh folders (downloadable package at the end of this post). Of course you can use your own meshes and odf files, but this makes it easy to start with.
Each team needs exactly one HQ, preferably placed on the opposite sides of your map.
I recommend to place the HQ in a protected position so that it can't be shot over half the map (same for the CPs). The HQ ODF is cis_bldg_hq_building.odf. Give each HQ a unique name in ZE.
Next, you need to place the CPs (a_nic_des_cp.odf) on the map. You can place as many as you want, but keep mind that the game doesn't support more than 16 CPs (remember the HQs which take already 2 CP "slots"). Also note that you have to place the same amount of CPs for each team.
When placing the CPs you need to set up a naming scheme starting with number 1 for each team, for example team1_cp1, team1_cp2, and so on.


8. Now, you need to modify your MAP*era*_YourSuffix.lua script.
The first section including ScriptPostLoad section should look like this (make sure to adjust the variables, especially HQ and CP names): You can copy your ScriptInit section from any conquest lua script, but don't forget to load the correct layer: 9. You are done! Munge your map and play!




A couple of additional notes:
Feel free to use and modify this script as you like. You don't need to give credits or ask me for permission to use it. (I wouldn't mind a short message if you do so, though.)
I know that my script isn't perfect and that you could improve a little here and there. It just turned out to look this way with all the modifications and changes I made during the creation process. If you know how to improve it significantly, let me know.
Any and all criticism, suggestions, questions and/or feedback are welcome.

You can find the HQ mode package here: Download
If you want to play a map with HQ mode on it, download: Naboo - Inner City


Have fun!
~Locutus

Really cool. I might add it to my current project.

GAB wrote:Really cool. I might add it to my current project.

Same.

Nice work. Glad you at least had Sand Castles as a reference, because it was designed as an assault/HQ/siege(whatever you call it)-lite-type mode. The reason I didn't go with something more extensive is because I designed that to work as strictly a luascript add-on to preexisting maps. A mode that works in a similar fashion can be found on Archer01's map Yavin: Arroyo Pass (http://starwarsbattlefront.filefront.co ... Pass;72406), although this too was a mode built around having a map built for it. For other reference, you can look at other game types that use this "sequential-but-equal" objective type - games like MOBAs are a prime example.

Very, VERY nice work!

Just a thing...

LEO wrote:

Hidden/Spoiler:

I could have sworn Königin means King, but I remembered that would be Königer, I believe... ^^

@yuke5 and GAB:
I hope it's of some use for you.
If you have any questions don't hesitate to ask

Maveritchell wrote:A mode that works in a similar fashion can be found on Archer01's map Yavin: Arroyo Pass (http://starwarsbattlefront.filefront.co ... Pass;72406), although this too was a mode built around having a map built for it. For other reference, you can look at other game types that use this "sequential-but-equal" objective type - games like MOBAs are a prime example.

Actually I'm happy that I didn't do this.
Due to not looking at other implementations I created my very own HQ mode with it's own features like the possibility to kill the HQ without all CPs being destroyed and the timer-combined possibility.
But yeah, it was your Sand Castles mode which gave me the motivation to start this.

Marth8880 wrote:Very, VERY nice work!

Just a thing...

LEO wrote:

Hidden/Spoiler:

I could have sworn Königin means King, but I remembered that would be Königer, I believe... ^^

Hehe, your translation is close, König means king and Königin = queen^^
(Quotes are buggy again, LEO didn't post that picture;))