HPL1/Content Creation Chapter 9

9 Heads-Up Display files

9.1 Intro

Heads-Up Display files are XML files and before editing them it is suggested to read some quick tutorial on XML files. Only very basic XML understanding is needed to edit these files.

The files are divided into different sections, some sections are in all entity files and some are only present in certain entity types.

The following values are used, note that all types have "" around the value:

String	A string of letters. "MyName"
Float	A decimal number. "1.04" or "1.04f"
Integer	A number without decimals "-15"
Vector3	Three numbers in a row separated by space and/or commas: "1, 1, 1".

9.1.1 Prerequisite

In order to use the Hud Object Editor you need the fmod library and the Verdana font. You can download these things from the Getting Started page. The prerequisites archive also contains an offline version of this document as well as some other last minute information, should the wiki ever go down for whatever reason.

Toss the fmod Dynamic Library Link (*.dll) into the redistributable directory of Penumbra and the Verdana TrueType Font into the fonts folder.

Depending on where you installed Penumbra the Drive letter and directory might differ from the following example:

The fmod.dll file goes into
C:\penumbra2\redist
And the TrueType Font goes into
C:\penumbra2\redist\fonts

The program can only be called via Windows' Command Prompt. Grip never made a GUI for the program, you must also be in the redistributable directory when calling the program.

9.1.2 Invocation

In the Windows Command Prompt, change the directory to the folder and drive where you have penumbra installed.

cd C:\penumbra2\redist

Then, load the Collada file (*.dae) while invoking the program. File extension isn't necessary.

hudobjecteditor my_model

The program will then fire up while using the HPL engines resource configuration file to search and index all directories currently written to it. Your model file and the accompanying materials for it can be placed anywhere you like so long as it's within the reach of the resource.cfg file. Use the HPL Helper program to add new directories or type them out manually with something like Notepad++.