Industrial Park (level editor): Difference between revisions

From Heavy Iron Modding
Content added Content deleted
No edit summary
No edit summary
Line 9: Line 9:
==Usage==
==Usage==
To learn to use Industrial Park, please follow the Essential Series of modding tutorials, starting with the [[Essentials Series/Introduction to modding|Introduction To Modding]] page. Most of the information in the first few pages is related to using the tool, such as [[Essentials Series/Industrial Park basics|Industrial Park Basics]] and [[Essentials Series/Editing Assets|Editing Assets]].
To learn to use Industrial Park, please follow the Essential Series of modding tutorials, starting with the [[Essentials Series/Introduction to modding|Introduction To Modding]] page. Most of the information in the first few pages is related to using the tool, such as [[Essentials Series/Industrial Park basics|Industrial Park Basics]] and [[Essentials Series/Editing Assets|Editing Assets]].

==Asset Types==
The following table shows the current status of each asset type for Industrial Park. Some are editable, some can be used only for display, and some must be edited externally.

{| class="wikitable sortable"
|+
! Asset
! Status
! Info
|-
| align=center | [[ALST]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[ANIM]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[ATBL]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[BOUL]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model</span>
|| See [[Essentials Series/Boulders|Boulders]] for more information.
|-
| align=center | [[BSP]], [[JSP]]
|| <span style="color:#FF7F00">Edit</span>, <span style="color:#0000FF">Display</span>
|| BSP and JSP models will be displayed in the world. Industrial Park's BSP/JSP editor allows you to:
* Edit individual mesh colors, material names and atomic flags (JSP only).
* Edit individual sections and settings in JSPINFO asset.
* Use the Export function to export the model to one of the Assimp formats. OBJ or DAE are recommended. This might not work on all models; it has a higher change of working on Xbox files. It can also be exported as a raw BSP (BSP assets) or DFF (JSP assets).
* Import function grayed out as it hasn't been implemented yet.
|-
| align=center | [[BUTN]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model</span>
|| See [[Essentials Series/Buttons|Buttons]] for more information.
|-
| align=center | [[CAM]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display as widget</span>
|| See [[Essentials Series/Cameras|Cameras]] for more information.
|-
| align=center | [[CNTR]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Buttons|Buttons]] for more information.
|-
| align=center | [[COLL]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Stage Controllers#Collision Table|Stage Controllers]] for more information.
|-
| align=center | [[COND]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Conditionals#Conditionals]] for more information.
|-
| align=center | [[CRDT]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[CSN]]
|| <span style="color:#FF0000">Unavailable</span>
||
|-
| align=center | [[CSNM]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[DEST]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[DPAT]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Dispatchers|Dispatchers]] for more information.
|-
| align=center | [[DSCO]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[DSTR]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model</span>
||
|-
| align=center | [[DUPC]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model</span>
||
|-
| align=center | [[DYNA]]
|| <span style="color:#FF7F00">Edit</span>, <span style="color:#0000FF">Display from model or widget</span>
|| Allows editing of all DYNA types in BFBB and some from the other games. Has a generic editor for unsupported types.
|-
| align=center | [[EGEN]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model</span>
||
|-
| align=center | [[ENV]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Stage Controllers#Environment|Stage Controllers]] for more information.
|-
| align=center | [[FLY]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Live preview</span>
||
|-
| align=center | [[FOG]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Stage Controllers#Fog|Stage Controllers]] for more information.
|-
| align=center | [[GRUP]]
|| <span style="color:#007F00">Edit</span>
|| Editor has feature to add all selected assets to group.
|-
| align=center | [[GUST]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[HANG]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model</span>
||
|-
| align=center | [[JAW]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Sound and Music|Sound and Music]] for more information.
|-
| align=center | [[LITE]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display as widget</span>
||
|-
| align=center | [[LKIT]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Stage Controllers#Light Kit|Stage Controllers]] for more information.
|-
| align=center | [[LOBM]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[LODT]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Stage Controllers#Level of Detail Table|Stage Controllers]] for more information.
|-
| align=center | [[MAPR]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[MINF]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Use for display</span>
||
|-
| align=center | [[MODL]]
|| <span style="color:#FF7F00">Edit</span>, <span style="color:#0000FF">Display</span>
|| Assets with references to MINF or MODL will be displayed as that model in the world. Industrial Park's MODL editor is similar to the BSP/JSP editor and allows you to:
* Edit individual mesh colors, material names and atomic flags.
* Use the Export function to export the model to one of the Assimp formats. OBJ or DAE are recommended. This might not work on all models; it has a higher change of working on Xbox files. It can also be exported as a raw BSP (BSP assets) or DFF (JSP assets).
* Use the Import function to select a model file to import. Industrial Park uses Assimp for model importing, so DFFs will be imported as they are, while other formats will be converted to DFF - using either OBJ or FBX is recommended. This does not work with rigged models and any rigging present in the files will be discarded during the conversion.
|-
| align=center | [[MRKR]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display as widget</span>
||
|-
| align=center | [[MVPT]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display as widget</span>
||
|-
| align=center | [[NPC]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model</span>
||
|-
| align=center | [[PARE]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Particles|Particles]] for more information.
|-
| align=center | [[PARP]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Particles|Particles]] for more information.
|-
| align=center | [[PARS]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Particles|Particles]] for more information.
|-
| align=center | [[PEND]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model</span>
||
|-
| align=center | [[PICK]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Use for display</span>
|| PKUP assets will try to find their models from the references in the PICK asset, so for that, boot.hip must be opened in an Archive Editor. Otherwise, the pickups will be displayed as widgets.
|-
| align=center | [[PIPT]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Stage Controllers#Pipe Info Table|Stage Controllers]] for more information.
|-
| align=center | [[PKUP]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model</span>
||
|-
| align=center | [[PLAT]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model</span>
|| See [[Essentials Series/Platforms|Platforms]] for more information.
|-
| align=center | [[PLYR]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display as widget</span>
||
|-
| align=center | [[PORT]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Portals|Portals]] for more information.
|-
| align=center | [[PRJT]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[RWTX]]
|| <span style="color:#FF7F00">Edit</span>, <span style="color:#0000FF">Display</span>
|| Industrial Park's RWTX editor allows you to:
* Edit the texture's filtering mode (mipmapping)
* Edit the texture's addressing mode (wrap, tile, clamp, mirror)
* Import an image to overwrite the texture. Supported formats: BMP, GIF, EXIF, JPG, PNG, TIFF and RWTEX
* Export the image as RWTEX (which can be imported in Magic.TXD)
|-
| align=center | [[SCRP]]
|| <span style="color:#007F00">Edit</span>
|| Uses the [[#Link List Editor|Link List Editor]] for timed links.
|-
| align=center | [[SDFX]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display as widget</span>
|| SDFX assets a minimum and a maximum radius. These values are collected from the SDFX's SGRP reference. The maximum will be only displayed if the asset is selected.
|-
| align=center | [[SFX]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display as widget</span>
|| SFX assets have a minimum and a maximum radius. The maximum will be only displayed if the asset is selected.
|-
| align=center | [[SGRP]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[SHDW]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Stage Controllers#Shadow Table|Stage Controllers]] for more information.
|-
| align=center | [[SHRP]]
|| <span style="color:#007F00">Edit</span>
|| Allows editing of entries of types 3, 4, 5, 6, 8 and 9 for BFBB and TSSM.
|-
| align=center | [[SIMP]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model</span>
|| See [[Essentials Series/Simple Objects|Simple Objects]] for more information.
|-
| align=center | [[SND]], [[SNDS]]
|| <span style="color:#FF7F00">Import raw</span>, <span style="color:#0000FF">Play</span>
|| When importing an SND or SNDS asset, you have two choices:
* Trim the sound's header and send it to the SNDI asset. This will cut the header from your data and send it to the SNDI asset, which holds the headers of SND and SNDS.
* Import the sound's data as it is. This will not mess with the SNDI asset.
The SND/SNDS editor also includes a function to import external [[JAW]] data and automatically send it to the JAW asset.
The SND/SNDS editor can play sounds in GameCube (Scooby or BFBB) and Xbox (all games) archives.
|-
| align=center | [[SNDI]]
|| <span style="color:#007F00">Edit</span>
||
* The SNDI asset can be edited individually, and can also be updated automatically from a SND or SNDS import.
|-
| align=center | [[SPLN]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display as spline</span>
||
|-
| align=center | [[SURF]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[TEXT]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[TIMR]]
|| <span style="color:#007F00">Edit</span>
|| See [[Essentials Series/Timers|Timers]] for more information.
|-
| align=center | [[TPIK]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Use for display</span>
|| DYNA pickups will try to find their models from the references in the TPIK asset, so for that, boot.hip must be opened in an Archive Editor. Otherwise, the DYNAs will be displayed as widgets.
|-
| align=center | [[TRCK]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model</span>
|| The TRCK editor is actually just the SIMP editor.
|-
| align=center | [[TRIG]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display as widget</span>
|| See [[Essentials Series/Triggers|Triggers]] for more information.
|-
| align=center | [[UI]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model/texture</span>
|| Texture UIs display properly, model UIs are slightly off. See [[Essentials Series/User Interfaces|User Interfaces]] for more information.
|-
| align=center | [[UIFT]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model/texture</span>
|| Texture UIs display properly, model UIs are slightly off, displaying as text is not supported yet. See [[Essentials Series/User Interfaces|User Interfaces]] for more information.
|-
| align=center | [[VIL]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display from model</span>
|| See [[Essentials Series/Tikis and Enemies|Tikis and Enemies]] for more information.
|-
| align=center | [[VILP]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[VOLU]]
|| <span style="color:#007F00">Edit</span>
||
|-
| align=center | [[WIRE]]
|| <span style="color:#007F00">Edit</span>, <span style="color:#0000FF">Display as wireframe model</span>
||
|}

* Assets which [[Essentials Series/Links|links]] (but not other fields) can be edited: [[CCRV]], [[DTRK]], [[GRSM]], [[NGMS]], [[PGRS]], [[RANM]], [[SLID]], [[SSET]], [[SUBT]], [[TRWT]], [[UIM]], [[ZLIN]].
* Assets which editing internally is not supported: [[ATKT]], [[BINK]], [[CSSS]], [[CTOC]], [[MPHT]], [[NPCS]], [[ONEL]], [[RAW]], [[SPLP]], [[TEXS]].
* Many of the assets (such as FOG) have values which are RGBA colors. In those asset editors, click the <nowiki>[...]</nowiki> button next to the color value to show a color picker.
* Note: this table applies only for Battle For Bikini Bottom; some asset types have different formats through the games and are not supported.


==Research/Advanced==
==Research/Advanced==
Line 330: Line 15:
===Asset ID Generator===
===Asset ID Generator===
On this window, each line typed into the top text box will be run through the BKRD hash algorithm and an asset ID will be generated from it in the bottom text box.
On this window, each line typed into the top text box will be run through the BKRD hash algorithm and an asset ID will be generated from it in the bottom text box.

===DYNA Search===
Use Choose Root Directory to pick a folder; all HIP/HOP files in the folder and any subfolders will be included in the DYNA search. Click Perform Search and all DYNAS found in any of the files will be logged.


===Event Search===
===Event Search===
Use Choose Root Directory to pick a folder; all HIP/HOP files in the folder and any subfolders will be included in the event search. Click Perform Search and all events which match the set filters found in any of the files will be logged. You can filter the asset types of the sender and reciever assets (Null allows for any) and the events which are recieved and sent in each link (Unknown allows for any). For example: if you leave sender asset as TRIG, target asset as Null, recieve event as Unknown and target event as Enable, you will be returned all links which are sent from TRIGs to any assets which have Enable as the event being sent in any HIP/HOPs in the folder you choose.
Use Choose Root Directory to pick a folder; all HIP/HOP files in the folder and any subfolders will be included in the event search. Click Perform Search and all events which match the set filters found in any of the files will be logged. You can filter the asset types of the sender and reciever assets (Null allows for any) and the events which are recieved and sent in each link (Unknown allows for any). For example: if you leave sender asset as TRIG, target asset as Null, recieve event as Unknown and target event as Enable, you will be returned all links which are sent from TRIGs to any assets which have Enable as the event being sent in any HIP/HOPs in the folder you choose.


===DYNA Search===
===Pickup Searcher===
Use Choose Root Directory to pick a folder; all HIP/HOP files in the folder and any subfolders will be included in the DYNA search. Click Perform Search and all DYNAS found in any of the files will be logged.
Use Choose Root Directory to pick a folder; all HIP/HOP files in the folder and any subfolders will be included in the Pickup search. Click Perform Search and all Pickups found in any of the files will be logged.


==External Links==
==External Links==

Revision as of 00:05, 31 August 2022

Industrial Park is a tool made by community member igorseabra4 in C# using SharpDX. It is an editor capable of opening a number of HIP/HOP files and display the level, with models and textures for level and objects, as well as edit some of the asset types in Battle For Bikini Bottom, The SpongeBob SquarePants Movie, Scooby-Doo: Night of 100 Frights, The Incredibles and The Incredibles: Rise of the Underminer for all platforms (except the point-and-click PC versions of the SpongeBob games).

This tool is based off from, and shares a lot of its source code with another one of the creator's tools: Heroes Power Plant, a tool to edit levels in Sonic Heroes. Being also based on the RenderWare engine, both games share their model format. It also gave Industrial Park the convention of being named after a level in the game. Industrial Park uses TxdGen for converting textures and vgmstream for previewing sounds.

The program is still under development, so features are still planned, and it is possible that functions of the tool don't work as expected.

Usage

To learn to use Industrial Park, please follow the Essential Series of modding tutorials, starting with the Introduction To Modding page. Most of the information in the first few pages is related to using the tool, such as Industrial Park Basics and Editing Assets.

Research/Advanced

This is a tab in Industrial Park with tools that don't fit elsewhere in the program. It's recommended to only use these tools without any Archive Editor window open.

Asset ID Generator

On this window, each line typed into the top text box will be run through the BKRD hash algorithm and an asset ID will be generated from it in the bottom text box.

DYNA Search

Use Choose Root Directory to pick a folder; all HIP/HOP files in the folder and any subfolders will be included in the DYNA search. Click Perform Search and all DYNAS found in any of the files will be logged.

Event Search

Use Choose Root Directory to pick a folder; all HIP/HOP files in the folder and any subfolders will be included in the event search. Click Perform Search and all events which match the set filters found in any of the files will be logged. You can filter the asset types of the sender and reciever assets (Null allows for any) and the events which are recieved and sent in each link (Unknown allows for any). For example: if you leave sender asset as TRIG, target asset as Null, recieve event as Unknown and target event as Enable, you will be returned all links which are sent from TRIGs to any assets which have Enable as the event being sent in any HIP/HOPs in the folder you choose.

Pickup Searcher

Use Choose Root Directory to pick a folder; all HIP/HOP files in the folder and any subfolders will be included in the Pickup search. Click Perform Search and all Pickups found in any of the files will be logged.

External Links