Heroes of Hammerwatch wiki - User contributions [en]

Custom Actors (Enemies)

2019-04-25T15:41:51Z

Hootless: Created the page, still needs an explanation of how to do the unit files properly

It's currently only possible to add custom actors easily by using the Enemy SVal Loader mod[https://steamcommunity.com/sharedfiles/filedetails/?id=1722742864], available on the Steam Workshop. It's still possible to have your custom enemies spawn by editing the EnemyPlacement script manually to include your new enemies but is strongly not recommended, as this makes it impossible to have multiple enemy mods at once. This guide will assume you are using the mod to maintain compatibility with other mods. If you haven't yet, make sure you [[Mod base|create the base for the mod first]].

== Making Actors ==
''Under Construction - Use existing actor .unit and .png as a base until this is written.''

== Making Actors Spawn ==
In this example, we'll make ticks from the first act appear in the Battlements. Functionally the same principles can be used to spawn your own enemy wherever you like, I just wanted to show that you can move enemies around (a little bit at least, for now you can't actually stop them from spawning in their original areas completely).

In your mod folder, create a folder called <code>actors</code>. In there, you have to create a new sval file. You can for example call this <code>extra_act6_enemies.sval</code>, or something else fitting. '''Keep in mind''': the assets between base and mods are shared! This means you should use a unique filename here that no other mod is going to use. (You could also put it in a separate (or different) folder if you want to be extra cautious.)

Sval files is the main serializable data structure used throughout the engine, and sval files describe a single SValue object. Sval files however have a special property; you can specify a <code>loader</code> tag to tell the engine which script function to load the sval with. These are called [[SValue Loaders]]. Using this loader, we can make the file load actor spawn definitions. For example, we can make an sval file containing this to add ticks to the battlements:

<loader>AddEnemyFile</loader>
<dict>
<dict name="late_game_tick">
<string name="loc">actors/tick_1.unit</string>
<string name="type">act6_common</string>
<string name="class">regular</string>
<int name="min-ng">0</int>
<int name="max-ng">5</int>
<int name="min-lev">2</int>
</dict>
</dict>

Here's a breakdown of the information included here:
* <code>loc</code>: This is the location of the unit file to be used. If you have your file in a folder called "my_super_cool_mod" for example, you would use <code>my_super_cool_mod/tick_1.unit</code> instead.
* <code>type</code>: This determines where the enemy can spawn. A list of all applicable tags and what they mean is below.
* <code>class</code>: What kind of enemy it is. Applicable tags are <code>regular</code>, <code>elite</code>, <code>miniboss</code>, and <code>spawner</code>.
* <code>min-ng</code>: [OPTIONAL] The minimum level of NG+ at which the spawning rule applies. If you set this to 5, your enemy will only spawn on NG+5 and beyond. If you don't add this line, it will default to NG+0 and above.
* <code>max-ng</code>: [OPTIONAL] The maximum level of NG+ at which the spawning rule applies. If you set this to 5, your enemy will only spawn on NG+5 and below. If you don't add this line it defaults to 0, which tells the generator to not apply a limit. Adding the line and setting it to 0 manually will achieve the same affect.
* <code>min-lev</code>: [OPTIONAL] The minimum level of an area at which the spawning rule applies. In the example above with the value of 2, the tick will only spawn on Battlements 2, and won't spawn at all on Battlements 1. If you don't add this line it defaults to 0, which allows the enemy to spawn on any level of the area.
* <code>spawnerAlt</code>: [OPTIONAL] This line isn't included above because it's not a spawner. If you are adding a spawner, you have to include this line (it's a string, so copy the <code>loc</code> line and change <code>loc</code> to <code>spawnerAlt</code>). This is specified in exactly the same way as the <code>loc</code> unit file, and is used to give the location of the destroyed version of the spawner. The destroyed spawner should have its own .unit file.

== Type Tags ==

* <code>act1_common</code>: Mines, Prisons 1 (Ticks)
* <code>act1_uncommon</code>: Mines, Prison 1+2 (Bats)
* <code>act1_rare</code>: Mines, Prison 3 (Maggots)
* <code>act2_common</code>: Prison, Armory 1 (Melee Skeletons)
* <code>act2_uncommon</code>: Prison, Armory 1+2 (Ranged Skeletons)
* <code>act4_common</code>: Archives (Eyes)
* <code>act4_uncommon</code>: Archives (Wisps)
* <code>act4_rare</code>: Archives (Ghosts)
* <code>act5_common</code>: Chambers (Stronger Melee Skeletons)
* <code>act5_uncommon</code>: Chambers (Stronger Ranged Skeletons)
* <code>act5_rare</code>: Chambers (Liches, Battlemages)
* <code>act6_common</code>: Battlements (Ice Troll Warriors)
* <code>pop_act1_common</code>: Desert (Scorpions)
* <code>pop_act1_uncommon</code>: Desert (Snakes)
* <code>pop_act2_common</code>: Lower Pyramid (Melee Mummies)
* <code>pop_act2_uncommon</code>: Lower Pyramid (Ranged Mummies)
* <code>pop_act3_common</code>: Upper Pyramid (Stronger Melee Mummies)
* <code>pop_act3_uncommon</code>: Upper Pyramid (Stronger Ranged Mummies

There's no Act 3 tags currently because Act 3 only reuses Act 2 enemies (the ghosts from statues aren't handled by the same generator). This may be modified in a later version to make Act 3 unique enemies, though the goal is currently to have spawning from the framework be as close to vanilla as possible by default.

That's it! That's really all it takes to add custom enemies (barring of course the effort it takes to make the unit file and the sprite, but still)! If you've done it all right, you should be able to enable the mod in-game and see your new enemy spawning wherever you chose!

{{Template:BaseNav}}

Mod support

2019-04-25T14:44:08Z

Hootless: /* How to add: */ Linked the Custom Items page

Welcome to the modding page! This page is dedicated to offering a list of important information in a ladder to get around modding Heroes of Hammerwatch!

=Modding resouces=
==Starting a mod==
* [[mod_base|How to start]]
* [[Info.xml|info.xml specification]]
* [[Unpack resources]]

==Editor==
* [[Editor guide]]

===How to use:===
*Assets
*Tilemaps
*Environment lighting
====.unit,.effect & .inc====
*Doodads
*Actors
*Items
*Link child unit to inc. (Like the act walls!)
====Worldscripts====
*Linking worldscripts
===How to put those into:===
*Levels
*Prefabs
====How to put Prefabs into:====
*Levels! lol

==Custom assets page==
===How to add:===
*Tilemaps
*Doodads
*Actors
*[[Custom_items|Items]]
*Worldscripts
*[[Custom_Materials_(Dyes)|Materials]]

==Scripting/GUI page?==
*GUI modification and creation
===Scripting modification and creation===
*GUI scripts
*Worldscript
*Gamemode scripts

==Upload to workshop==
[[Uploading_to_the_workshop|How to upload to the workshop]]

=List of common resources=
*[[Custom_items|Custom Items]]
*[[Script_Hooks|Script Hooks]]
*[[List_of_modifiers|List of modifiers]]
*[[SValue_Loaders|SValue loaders]]

{{Template:BaseNav}}

Blueprints

2019-04-25T14:37:04Z

Hootless: Redirected page to Magic Anvil

#REDIRECT [[Magic_Anvil]]

Custom Materials (Dyes)

2019-04-17T19:14:20Z

Hootless: Added wiki navigator

Materials (or dyes) alter the color of various parts of the players sprite. They can be added to the game fairly easily, requiring adding only a simple file. If you haven't yet, make sure you [[Mod base|create the base for the mod first]].

== Making Materials ==

In this example, we'll add a pink skin dye.

In your mod folder, create a folder called <code>tweak</code>. In there, you have to create a new sval file. You can for example call this <code>extra_dyes.sval</code>, or something else. '''Keep in mind''': the assets between base and mods are shared! This means you should use a unique filename here that no other mod is going to use. (You could also put it in a separate (or different) folder if you want to be extra cautious.)

Sval files is the main serializable data structure used throughout the engine, and sval files describe a single SValue object. Sval files however have a special property; you can specify a <code>loader</code> tag to tell the engine which script function to load the sval with. These are called [[SValue Loaders]]. Using this loader, we can make the file load material definitions. For example, we can make an sval file containing this to add a new pink skin dye.

<loader>Materials::LoadDyes</loader>
<dict>
<array name="skin">
<dict>
<string name="id">pink</string>
<string name="name">Pink</string>
<array name="shades"><string>#350010</string><string>#e646c3</string><string>#ffa2fa</string></array>
<string name="quality">rare</string>
<bool name="default">true</bool>
</dict>
</array>
</dict>

Here's a breakdown of the information included here:
* <code>array name="skin"</code>: This is what the material applies to. Other options besides <code>skin</code> are <code>hair</code>, <code>cloth</code>, <code>metal</code>, <code>leather</code>, and <code>wood</code>
* <code>string name="id"</code>: This is the ID used to refer to the skin.
* <code>string name="name"</code>: The name displayed in-game.
* <code>array name="shades"</code>: The three values here correspond to the hex values for the three colors used in the material. Each can be anywhere from <code>#000000</code> to <code>#ffffff</code>.
* <code>string name="quality"</code>: The quality of the material, can be <code>common</code>, <code>uncommon</code>, or <code>rare</code>.
* <code>bool name="default"</code>: Determines whether you start with the material or have to find it like the other materials. Can be either <code>true</code> or <code>false</code>.

If you've done it all right, you should be able to enable the mod in-game and see your new material available in the tailor (if you have it set to default)! Unfortunately due to limits of the game engine it currently (as of writing this page) is not possible to have custom materials show up in the character creation screen.

[[File:Pink_picture.PNG]]

{{Template:BaseNav}}

Template:BaseNav

2019-04-17T19:13:26Z

Hootless: Added a link to the Custom Materials tutorial page

<div class="rowcontainer">
<div class="rowlarge">
<div class="menu">
{| class="wikitable" style="margin:auto; text-align:center;"
!colspan="2"|Wiki Navigator
|-
![[Classes]]
|[[Paladin]] • [[Priest]] • [[Ranger]] • [[Sorcerer]] • [[Thief]] • [[Warlock]] • [[Wizard]] • [[Gladiator]]
|-
!rowspan="2"|[[Town|The Outlook]]
|[[Apothecary]] • [[Bestiary]] • [[Blacksmith]] • [[Chapel]] • [[Fountain]] • [[Guild Hall]] • [[General Store]]
|- style="border-top:hidden"
| |[[Magic Shop]] • [[Magic Anvil]] • [[Ore Trader]] • [[Town Hall]] • [[Tailor]] • [[Tavern]]
|-
![[File:PoP.png|22px|link=]][[City of Stone]]
| [[Pyramid of Prophecy]] • [[Arena]] • [[Tavern|The Refreshing Chisel]] • [[Retired Gladiator]] • [[Statues]]
|-
!|[[Mechanics]]
|[[Acts]] • [[Combat]] • [[Leveling Up]] • [[Money]] • [[New Game Plus]]
|-
![[Acts|Forsaken Tower]]
|[[Chests]] • [[Encounters]] • [[Items]] • [[puzzlesecrets|Puzzles & Secrets]]
|-
![[Enemies]]
|[[Enemies|Bosses]] • [[Aberrations]] • [[Beasts]] • [[Constructs]] • [[Undead]]
|-
!rowspan="2"|[[mod_support|Mods & Misc]]
|[[Commands]] • [[custom_assets|Custom assets]] • [[custom_items|Custom Items]] • [[Custom_language_files|Custom language files]] • [[Custom_Materials_(Dyes)|Custom Materials (Dyes)]]
|-style="border-top:hidden"
|[[editor_guide|Editor]] • [[patchNotes|Patch Notes]] • [[mod_base|Starting a mod]] • [[Uploading_to_the_workshop|Uploading to the workshop]] • [[Voice_lines|Voice Lines]]
|}
</div>
</div>
</div>

Mod support

2019-04-17T19:10:48Z

Hootless: Added a link to the Custom Materials tutorial page

Welcome to the modding page! This page is dedicated to offering a list of important information in a ladder to get around modding Heroes of Hammerwatch!

=Modding resouces=
==Starting a mod==
* [[mod_base|How to start]]
* [[Info.xml|info.xml specification]]
* [[Unpack resources]]

==Editor==
* [[Editor guide]]

===How to use:===
*Assets
*Tilemaps
*Environment lighting
====.unit,.effect & .inc====
*Doodads
*Actors
*Items
*Link child unit to inc. (Like the act walls!)
====Worldscripts====
*Linking worldscripts
===How to put those into:===
*Levels
*Prefabs
====How to put Prefabs into:====
*Levels! lol

==Custom assets page==
===How to add:===
*Tilemaps
*Doodads
*Actors
*Items
*Worldscripts
*[[Custom_Materials_(Dyes)|Materials]]

==Scripting/GUI page?==
*GUI modification and creation
===Scripting modification and creation===
*GUI scripts
*Worldscript
*Gamemode scripts

==Upload to workshop==
[[Uploading_to_the_workshop|How to upload to the workshop]]

=List of common resources=
*[[Custom_items|Custom Items]]
*[[Script_Hooks|Script Hooks]]
*[[List_of_modifiers|List of modifiers]]
*[[SValue_Loaders|SValue loaders]]

{{Template:BaseNav}}

Custom Materials (Dyes)

2019-04-17T17:17:05Z

Hootless: How to create custom materials/dyes

File:Pink picture.PNG

2019-04-17T17:14:07Z

Hootless: Custom material appearing in-game

Custom material appearing in-game