DLC Editor - Revision history

PkR at 18:47, 2 October 2025

2025-10-02T18:47:35Z

← Older revision		Revision as of 18:47, 2 October 2025
Line 88:		Line 88:
	* '''15''': Music and voices		* '''15''': Music and voices

	There is a [~~https://github.com/X-Hax/SADXModdingGuide/wiki/~~List-of-Sound-Effects list of sound effect IDs] for SADX, which is the same as SA1 for the most part.		There is a [[List of Sound Effects (SA1)\|list of sound effect IDs]] for SADX, which is the same as SA1 for the most part.

	=== Messages Tab ===		=== Messages Tab ===
Line 115:		Line 115:
	The tool can import and export Dreamcast Multi-Unit (MLT) files.		The tool can import and export Dreamcast Multi-Unit (MLT) files.
	* The soundbank in the MLT file is loaded as Bank 8 in the game.		* The soundbank in the MLT file is loaded as Bank 8 in the game.
	* At the moment SA Tools cannot edit MLT files, although you can extract some information from them using the MLTExtract command line tool on the [https://github.com/X-Hax/~~sa''tools''research~~ SA Tools Research repo].		* At the moment SA Tools cannot edit MLT files, although you can extract some information from them using the MLTExtract command line tool on the [https://github.com/X-Hax/sa_tools_research SA Tools Research repo]. [https://github.com/dakrk/manatools A new suite of tools] for working with MLT files is also in development.

	=== Import and Export ===		=== Import and Export ===
Line 172:		Line 172:

	= Credits =		= Credits =
	Sappharad: providing C# code to decrypt VMS files and cracking the DLC checksum		Sappharad: providing C# code to decrypt VMS files and cracking the DLC checksum.

	Darksecond: original Perl code to decrypt VMS files		Darksecond: original Perl code to decrypt VMS files.

	= SA1 DLC File Format =		= SA1 DLC File Format =

PkR at 18:44, 2 October 2025

2025-10-02T18:44:59Z

← Older revision		Revision as of 18:44, 2 October 2025
Line 179:		Line 179:
	For nerds here's an overview of SA1 DLC structures:		For nerds here's an overview of SA1 DLC structures:

	~~BBB~~		<pre>
			* VMU HEADER
			* OFFSET SIZE TYPE DESCRIPTION
			* 0 16 string DLC title
			* 10 32 string DLC description
			* 30 16 string Application title
			* 40 2 ushort Number of icons
			* 42 2 ushort Animation speed
			* 44 2 ushort Eyecatch type (unused)
			* 46 2 ushort CRC (unused)
			* 48 4 uint32 Size without the header
			* 4C 20 null Reserved
			* 60 32 ushort Icon palette, 16 colors
			* 80 512 byte Icon graphics
			*
			* SECTIONS HEADER (SIZE 64 BYTES)
			* 280 4 uint32 Pointer to item layout table
			* 284 4 uint32 Item count
			* 288 4 uint32 Pointer to string table
			* 28C 4 uint32 String item count
			* 290 4 uint32 Pointer to PVM
			* 294 4 uint32 Number of PVMs (always 1)
			* 298 4 uint32 Number of textures in the PVM
			* 29C 4 uint32 Pointer to MLT
			* 2A0 4 uint32 Number of MLTs (either 0 or 1)
			* 2A4 4 uint32 Pointer to PRS
			* 2A8 4 uint32 Number of PRSes (always 1)
			* 2AC 4 uint32 Checksum
			* 2B0 16 null Unused
			*
			* ITEM LAYOUT TABLE HEADER (SIZE 12 BYTES)
			* 2C0 4 uint32 DLC ID (e.g. 504 in SONICADV_504)
			* 2C4 1 byte Enable Sonic / Enable Tails
			* 2C5 1 byte Enable Knuckles / Enable Gamma
			* 2C6 1 byte Enable Amy / Enable Big
			* 2C7 1 byte Unknown, probably unused
			* 2C8 4 uint32 Regional lock
			*
			* ITEM LAYOUT TABLE (ARRAY BEGINS AT 0x2CC, ITEM SIZE 30 BYTES)
			* 0 1 uint8 Level ID
			* 1 1 uint8 Act ID
			* 2 1 uint8 Scale X multiplied by 10
			* 3 1 uint8 Scale Y multiplied by 10
			* 4 1 uint8 Scale Z multiplied by 10
			* 5 1 uint8 Rotation speed X
			* 6 1 uint8 Rotation speed Y
			* 7 1 uint8 Rotation speed Z
			* 8 1 sint8 Item type (0: model, -128: sprite, -1: invisible)
			* 9 1 uint8 Texture ID
			* A 2 ushort Flags
			* C 1 uint8 Object ID used for collectible items or the number of objects to collect
			* D 1 byte Unknown
			* E 1 uint8 Message ID to show when touching the object
			* F 1 uint8 Trigger distance
			* 10 1 uint8 Level ID to warp or soundbank ID (8 for MLT, 15 for ADX music)
			* 11 1 uint8 Act ID to warp to or sound/music ID to play when touching the object
			* 12 2 ushort Rotation X
			* 14 2 ushort Rotation Y
			* 16 2 ushort Rotation Z
			* 18 2 short Position X
			* 1A 2 short Position Y
			* 1C 2 short Position Z
			*
			* DLC OBJECT FLAGS
			* BIT_0 Unknown
			* BIT_4 Unknown
			* BIT_8 Solid
			* BIT_9 Play sound
			* BIT_10 Show message
			* BIT_11 Hide object and disable everything except collision
			* BIT_12 Warp
			* BIT_13 Collectible item
			* BIT_14 Timer item
			* BIT_15 Starts the challenge
			*
			* REGIONAL LOCK BITS
			* -1 Disable regional lock
			* 1 Japan
			* 3 US
			* 4 Europe
			* 7 All regions
			</pre>

PkR at 18:44, 2 October 2025

2025-10-02T18:44:19Z

@@ Line 128: / Line 128: @@
 Although this is no longer necessary, you can edit this data manually in a text editor. Here's an example of an item with comments:
-<code>ss</code>
+<pre>
+[Item 0] // Item index, increases for every next item.
-<code>SS</code>
+Level=26 // Internal ID of the level where the object will be loaded. 1-10 are Action Stages, 26 is Station Square etc.
+Act=3 // Act ID where the object will be loaded.
-<code>S</code>
+ScaleX=10 // Scale of the model/sprite multiplied by 10, e.g. 10 means the object will not be scaled.
 == Additional Notes ==

PkR at 18:42, 2 October 2025

2025-10-02T18:42:34Z

← Older revision		Revision as of 18:42, 2 October 2025
Line 128:		Line 128:
	Although this is no longer necessary, you can edit this data manually in a text editor. Here's an example of an item with comments:		Although this is no longer necessary, you can edit this data manually in a text editor. Here's an example of an item with comments:

	~~AAA~~		<code>ss</code>

			<code>SS</code>

			<code>S</code>

	== Additional Notes ==		== Additional Notes ==

PkR at 18:40, 2 October 2025

2025-10-02T18:40:21Z

@@ Line 128: / Line 128: @@
 Although this is no longer necessary, you can edit this data manually in a text editor. Here's an example of an item with comments:
-<code>
+AAA
 == Additional Notes ==
@@ Line 172: / Line 148: @@
 = Credits =
-'''Sappharad''': providing C# code to decrypt VMS files and cracking the DLC checksum
+Sappharad: providing C# code to decrypt VMS files and cracking the DLC checksum
-'''Darksecond''': original Perl code to decrypt VMS files
+Darksecond: original Perl code to decrypt VMS files
 = SA1 DLC File Format =
 For nerds here's an overview of SA1 DLC structures:
-<code>
+BBB

PkR at 18:38, 2 October 2025

2025-10-02T18:38:37Z

← Older revision		Revision as of 18:38, 2 October 2025
Line 157:		Line 157:
	* Sound data (MLT) is not compatible with the PC version.		* Sound data (MLT) is not compatible with the PC version.
	* At the moment you have to replace an existing DLC in the mod to load your DLC in the PC version.		* At the moment you have to replace an existing DLC in the mod to load your DLC in the PC version.
	* For editing message strings manually, use </code>\n<code> for newlines and </code>TAB<code> (actual tabulation) for text centering.		* For editing message strings manually, use <code>\n</code> for newlines and <code>TAB</code> (actual tabulation) for text centering.

	= Troubleshooting =		= Troubleshooting =
	If the browser or the emulator cannot import your DLC file, check the following:		If the browser or the emulator cannot import your DLC file, check the following:
	# Make sure the filename in the VMI file matches the VMS filename.		# Make sure the filename in the VMI file matches the VMS filename.
	# Make sure </code>Resource Name<code> in the VMI is 8 characters or less.		# Make sure <code>Resource Name</code> in the VMI is 8 characters or less.

	If the file is imported successfully but the game doesn't load the DLC, check the following:		If the file is imported successfully but the game doesn't load the DLC, check the following:
	# The filename on the VMU must be </code>SONICADV_XXX<code>, where </code>XXX<code> is a 3-digit number. For example, a file named </code>SONICADV_512<code> will be detected by the game.		# The filename on the VMU must be <code>SONICADV_XXX</code>, where <code>XXX</code> is a 3-digit number. For example, a file named <code>SONICADV_512</code> will be detected by the game.
	# Make sure you aren't uploading an unencrypted file to the VMU. </code>Encrypt VMS files<code> in the </code>Edit<code> menu must be checked before you save the file.		# Make sure you aren't uploading an unencrypted file to the VMU. <code>Encrypt VMS files</code> in the <code>Edit</code> menu must be checked before you save the file.
	# Check region and character locks.		# Check region and character locks.

PkR at 18:37, 2 October 2025

2025-10-02T18:37:24Z

← Older revision		Revision as of 18:37, 2 October 2025
Line 128:		Line 128:
	Although this is no longer necessary, you can edit this data manually in a text editor. Here's an example of an item with comments:		Although this is no longer necessary, you can edit this data manually in a text editor. Here's an example of an item with comments:

	``<code>		<code>
	[Item 0] // Item index, increases for every next item.		[Item 0] // Item index, increases for every next item.
	Level=26 // Internal ID of the level where the object will be loaded. 1-10 are Action Stages, 26 is Station Square etc.		Level=26 // Internal ID of the level where the object will be loaded. 1-10 are Action Stages, 26 is Station Square etc.
Line 152:		Line 152:
	Y=0		Y=0
	Z=1600		Z=1600
	</~~code>`<~~code>		</code>

	== Additional Notes ==		== Additional Notes ==
Line 165:		Line 165:

	If the file is imported successfully but the game doesn't load the DLC, check the following:		If the file is imported successfully but the game doesn't load the DLC, check the following:
	# The filename on the VMU must be </code>~~SONICADV''XXX~~<code>, where </code>XXX<code> is a 3-digit number. For example, a file named </code>~~SONICADV''512~~<code> will be detected by the game.		# The filename on the VMU must be </code>SONICADV_XXX<code>, where </code>XXX<code> is a 3-digit number. For example, a file named </code>SONICADV_512<code> will be detected by the game.
	# Make sure you aren't uploading an unencrypted file to the VMU. </code>Encrypt VMS files<code> in the </code>Edit<code> menu must be checked before you save the file.		# Make sure you aren't uploading an unencrypted file to the VMU. </code>Encrypt VMS files<code> in the </code>Edit<code> menu must be checked before you save the file.
	# Check region and character locks.		# Check region and character locks.
Line 179:		Line 179:
	For nerds here's an overview of SA1 DLC structures:		For nerds here's an overview of SA1 DLC structures:

	~~</code>`~~<code>		<code>
	* VMU HEADER		* VMU HEADER
	* OFFSET SIZE TYPE DESCRIPTION		* OFFSET SIZE TYPE DESCRIPTION
Line 255:		Line 255:
	* 4 Europe		* 4 Europe
	* 7 All regions		* 7 All regions
	</code>``		</code>

PkR at 18:36, 2 October 2025

2025-10-02T18:36:06Z

← Older revision		Revision as of 18:36, 2 October 2025
Line 15:		Line 15:

	== Main Tab ==		== Main Tab ==
	![~~https~~:~~//github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''~~main.png ~~Main tab~~]		[[File:Dlc main.png]]

	Here you can change header information, set DLC regional and character locks and access the item table.		Here you can change header information, set DLC regional and character locks and access the item table.
Line 44:		Line 44:
	=== Object Editor ===		=== Object Editor ===

	![~~https~~:~~//github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''~~object.png ~~Object Editor~~]		[[File:Dlc object.png]]

	This editor lets you change the item table.		This editor lets you change the item table.

	~~####~~ Object Flags		==== Object Flags ====
	<code>Solid</code> - Enable collision.		<code>Solid</code> - Enable collision.

Line 65:		Line 65:
	<code>Challenge Start</code> - Use the object to start the timer.		<code>Challenge Start</code> - Use the object to start the timer.

	~~####~~ Notes and Tips		==== Notes and Tips ====
	* You can use SALVL to get coordinates and rotation for your objects. Use any SET file or Sonic's start position as a placeholder. Alternatively, you could use the [https://gitlab.com/PiKeyAr/sadx-debug-mode/ Debug Mode mod] to retrieve the player's coordinates ingame and use them for your objects.		* You can use SALVL to get coordinates and rotation for your objects. Use any SET file or Sonic's start position as a placeholder. Alternatively, you could use the [https://gitlab.com/PiKeyAr/sadx-debug-mode/ Debug Mode mod] to retrieve the player's coordinates ingame and use them for your objects.
	* An object cannot have both <code>Play Sound</code> and <code>Change Level</code> flags at the same time.		* An object cannot have both <code>Play Sound</code> and <code>Change Level</code> flags at the same time.
Line 75:		Line 75:
	* You can stop the stage's regular ADX music by playing bank 15 sound 110.		* You can stop the stage's regular ADX music by playing bank 15 sound 110.

	~~####~~ Soundbank IDs		==== Soundbank IDs ====
	The game uses the following soundbank IDs:		The game uses the following soundbank IDs:
	* '''0''': Common sounds (<code>COMMON_BANK00</code> in SADX)		* '''0''': Common sounds (<code>COMMON_BANK00</code> in SADX)
Line 91:		Line 91:

	=== Messages Tab ===		=== Messages Tab ===
	![~~https~~:~~//github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''~~message.png ~~Messages tab~~]		[[File:Dlc message.png]]

	Text strings must be 64 characters long or less. Japanese strings must be 32 characters or less. Use TAB (actual tabulation) for text centering.		Text strings must be 64 characters long or less. Japanese strings must be 32 characters or less. Use TAB (actual tabulation) for text centering.

	=== Textures Tab ===		=== Textures Tab ===
	![~~https~~:~~//github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''~~texture.png ~~Textures tab~~]		[[File:Dlc texture.png]]

	The tool can import PVM files created with Texture Editor or ArchiveTool.		The tool can import PVM files created with [[Texture Editor]] or [[Command Line Tools\|ArchiveTool]].
	* To save space, use as few textures as possible and compress them using the VQ4 PVR format. You can save textures in this format using the PVR plugin for Photoshop.		* To save space, use as few textures as possible and compress them using the VQ4 PVR format. You can save textures in this format using the [[PVR plugin for Photoshop]].
	* You can also squish rectangular textures into squares for use with rectangular banners. Use the <code>Rectangle</code> checkbox to preview them in stretched mode.		* You can also squish rectangular textures into squares for use with rectangular banners. Use the <code>Rectangle</code> checkbox to preview them in stretched mode.

	=== Model Tab ===		=== Model Tab ===
	![~~https~~:~~//github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''~~model.png ~~Model tab~~]		[[File:Dlc model.png]]

	The DLC can store a single Ninja Basic model. You can add a model in SAModel's .sa1mdl format using the <code>Load...</code> button, or import a model from another DLC's extracted data (PRS or BIN file) using the <code>Import Binary...</code> button. The tool manages model data automatically. If you use a model in .sa1mdl format, you don't need to create a PRS file.		The DLC can store a single Ninja Basic model. You can add a model in SAModel's .sa1mdl format using the <code>Load...</code> button, or import a model from another DLC's extracted data (PRS or BIN file) using the <code>Import Binary...</code> button. The tool manages model data automatically. If you use a model in .sa1mdl format, you don't need to create a PRS file.
Line 111:		Line 111:

	=== Sound Tab ===		=== Sound Tab ===
	![~~https~~:~~//github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''~~sound.png ~~Sound tab~~]		[[File:Dlc sound.png]]

	The tool can import and export Dreamcast Multi-Unit (MLT) files.		The tool can import and export Dreamcast Multi-Unit (MLT) files.
Line 121:		Line 121:
	The <code>Export</code> option in the <code>File</code> menu lets you export the VMS file as a folder that can be loaded by the Dreamcast DLC mod in the PC version of SADX. The <code>Import</code> option allows to load exported data back into the editor.		The <code>Export</code> option in the <code>File</code> menu lets you export the VMS file as a folder that can be loaded by the Dreamcast DLC mod in the PC version of SADX. The <code>Import</code> option allows to load exported data back into the editor.

	![~~https~~:~~//github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''~~export.png ~~Export~~]		[[File:Dlc export.png]]

	When you export DLC data, the model is extracted in the <code>SA1MDL</code> format supported by [~~https://github.com/sonicretro/sa_tools/wiki/SAMDL~~ SAMDL]. Other sections are converted to a single INI file (metadata), which are explained below.		When you export DLC data, the model is extracted in the <code>SA1MDL</code> format supported by [[SAMDL]]. Other sections are converted to a single INI file (metadata), which are explained below.

	The metadata INI file contains things like the name of the DLC, the messages displayed when you touch objects, and the item table.		The metadata INI file contains things like the name of the DLC, the messages displayed when you touch objects, and the item table.

PkR: Created page with "This tool lets you edit and create your own downloadable content for Sonic Adventure on the Dreamcast. The DLCs created with this tool can be played on real Dreamcast hardware without hacking the base game. = DLC VMS File Structure = A VMS file with SA1 DLC contains the following sections: # A general header common for all VMS files; # An object layout (item table) to tell which objects to load in which level as well as flags to restrict the DLC to specific characters..."

2025-10-02T18:30:18Z

Created page with "This tool lets you edit and create your own downloadable content for Sonic Adventure on the Dreamcast. The DLCs created with this tool can be played on real Dreamcast hardware without hacking the base game. = DLC VMS File Structure = A VMS file with SA1 DLC contains the following sections: # A general header common for all VMS files; # An object layout (item table) to tell which objects to load in which level as well as flags to restrict the DLC to specific characters..."

New page

This tool lets you edit and create your own downloadable content for Sonic Adventure on the Dreamcast. The DLCs created with this tool can be played on real Dreamcast hardware without hacking the base game.

= DLC VMS File Structure =

A VMS file with SA1 DLC contains the following sections:
# A general header common for all VMS files;
# An object layout (item table) to tell which objects to load in which level as well as flags to restrict the DLC to specific characters or versions of the game;
# A string table containing messages in different languages (up to 16 per language);
# A PVM file containing textures;
# (Optional) An MLT file containing sequenced sound effects or music;
# A PRS-compressed binary containing a model in the Ninja Basic format.

= Using the Editor =
The easiest way to get started is to open the VMS file of [https://dreamcastlive.net/sonic-adventure-dlc/ any official DLC] or [http://dcmods.unreliable.network/owncloud/data/PiKeyAr/files/Various/TikalDLC.7z Tikal's Challenge DLC], change it the way you want and save it as a new VMS file.

== Main Tab ==
![https://github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''main.png Main tab]

Here you can change header information, set DLC regional and character locks and access the item table.

=== Icon ===
The icon must be a 32x32 bitmap. It's recommended to prepare a 16-color image for the icon. If the icon has more colors, it will be converted to a 16-color image with quality loss.

=== About the DLC ID field ===

For the game to recognize the DLC, its filename on the memory card should be <code>SONICADV_XXX</code>, where <code>XXX</code> is a 3-digit number unique to each DLC. IDs 0-199 are reserved for Japan-only DLCs. If you use a number lower than 200 for the ID, the game will only display messages in Japanese.

Apart from the filename, DLC ID can also be stored in the VMS file itself. If the DLC sets up a challenge with a timer, the DLC ID is saved in the upload data produced by the game. The <code>DLC ID</code> field in this tool sets both the filename and the field in the file.

=== Regional locks ===

Regional locks have been tested on the following versions of the game:
* JP: Original Japanese release (1.007)
* US: Original US release (1.004) and All Stars re-release (1.005)
* EU: European release (1.003)
* INT: Second Japanese release known as "Sonic Adventure International" (1.003)

The behavior of the locks is as follows:
* <code>Disabled</code> and <code>All Regions</code>: works on all versions of the game
* <code>Japan</code>: JP, INT
* <code>Exclude Europe</code>: All versions except EU
* <code>Europe Only</code>: EU only

=== Object Editor ===

![https://github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''object.png Object Editor]

This editor lets you change the item table.

#### Object Flags
<code>Solid</code> - Enable collision.

<code>Play Sound</code> - Play a sound when the object is triggered. The sounds are restricted to currently loaded soundbanks which depend on where you are in the game. You can add a custom soundbank with sound effects or sequenced music via an MLT file. You can also play ADX music from the disc.

<code>Show Message</code> - Show a message when the object is triggered.

<code>Collision Only</code> - Disable all interactive elements and use the object as invisible collision.

<code>Change Level</code> - Teleport the character to a different level when the object is triggered.

<code>Collectible</code> - Make the object collectible. You can have up to 255 collectible objects.

<code>Timer</code> - Use the object to count the time and keep track of how many items have been collected. The timer works everywhere and does not reset if you go to another area, including different Acts of a stage, a different Action Stage or a different Adventure Field.

<code>Challenge Start</code> - Use the object to start the timer.

#### Notes and Tips
* You can use SALVL to get coordinates and rotation for your objects. Use any SET file or Sonic's start position as a placeholder. Alternatively, you could use the [https://gitlab.com/PiKeyAr/sadx-debug-mode/ Debug Mode mod] to retrieve the player's coordinates ingame and use them for your objects.
* An object cannot have both <code>Play Sound</code> and <code>Change Level</code> flags at the same time.
* The <code>Texture</code> field sets texture ID on the sprite or the first material of the model.
* For <code>Timer</code> objects, the <code>ID/Time/Total</code> field stores the number of objects to collect.
* For <code>Challenge Start</code> objects, the same field stores the time limit. The format is the number of seconds divided by 10, e.g. 60 is 10 minutes.
* For <code>Change Level</code> objects, the <code>Warp to: Level</code> field stores the level ID and the <code>Warp to: Act</code> field stores the act ID.
* For <code>Play Sound</code> objects, the <code>Bank</code> field stores the soundbank ID and the <code>ID</code> field stores the sound ID in the soundbank. Bank 8 is the DLC soundbank, 15 is ADX music.
* You can stop the stage's regular ADX music by playing bank 15 sound 110.

#### Soundbank IDs
The game uses the following soundbank IDs:
* '''0''': Common sounds (<code>COMMON_BANK00</code> in SADX)
* '''1''': Level-specific object sounds (<code>BANK01</code> files in SADX)
* '''2''': Common object sounds (<code>check''sheet''bank02</code> in SADX)
* '''3''': Character sounds (<code>BANK03</code> files in SADX)
* '''4''': Level-specific enemy sounds (<code>BANK04</code> files in SADX)
* '''5''': Level-specific background noises (<code>BANK05</code> files in SADX)
* '''6''': Character voice clips and cutscene sounds (<code>BANK06</code> and <code>E_</code> banks in SADX)
* '''7''': Chao-related music in SA1's ALIFE.MLT (does not exist in SADX)
* '''8''': Extra sounds and music in SA1 DLCs (does not exist in SADX)
* '''15''': Music and voices

There is a [https://github.com/X-Hax/SADXModdingGuide/wiki/List-of-Sound-Effects list of sound effect IDs] for SADX, which is the same as SA1 for the most part.

=== Messages Tab ===
![https://github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''message.png Messages tab]

Text strings must be 64 characters long or less. Japanese strings must be 32 characters or less. Use TAB (actual tabulation) for text centering.

=== Textures Tab ===
![https://github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''texture.png Textures tab]

The tool can import PVM files created with Texture Editor or ArchiveTool.
* To save space, use as few textures as possible and compress them using the VQ4 PVR format. You can save textures in this format using the PVR plugin for Photoshop.
* You can also squish rectangular textures into squares for use with rectangular banners. Use the <code>Rectangle</code> checkbox to preview them in stretched mode.

=== Model Tab ===
![https://github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''model.png Model tab]

The DLC can store a single Ninja Basic model. You can add a model in SAModel's .sa1mdl format using the <code>Load...</code> button, or import a model from another DLC's extracted data (PRS or BIN file) using the <code>Import Binary...</code> button. The tool manages model data automatically. If you use a model in .sa1mdl format, you don't need to create a PRS file.

You can also export the model in .sa1mdl format using the <code>Save...</code> button or export binary model data as BIN or PRS using the <code>Export Binary</code> button.
* To save space, make your model as low poly as possible. Reduce the number of materials, vertices, meshsets etc. You can see the amount of data occupied by the model at the bottom of the Model tab.

=== Sound Tab ===
![https://github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''sound.png Sound tab]

The tool can import and export Dreamcast Multi-Unit (MLT) files.
* The soundbank in the MLT file is loaded as Bank 8 in the game.
* At the moment SA Tools cannot edit MLT files, although you can extract some information from them using the MLTExtract command line tool on the [https://github.com/X-Hax/sa''tools''research SA Tools Research repo].

=== Import and Export ===

The <code>Export</code> option in the <code>File</code> menu lets you export the VMS file as a folder that can be loaded by the Dreamcast DLC mod in the PC version of SADX. The <code>Import</code> option allows to load exported data back into the editor.

![https://github.com/sonicretro/sa''tools/wiki/images/DLCTool/dlc''export.png Export]

When you export DLC data, the model is extracted in the <code>SA1MDL</code> format supported by [https://github.com/sonicretro/sa_tools/wiki/SAMDL SAMDL]. Other sections are converted to a single INI file (metadata), which are explained below.

The metadata INI file contains things like the name of the DLC, the messages displayed when you touch objects, and the item table.
Although this is no longer necessary, you can edit this data manually in a text editor. Here's an example of an item with comments:

``<code>
[Item 0] // Item index, increases for every next item.
Level=26 // Internal ID of the level where the object will be loaded. 1-10 are Action Stages, 26 is Station Square etc.
Act=3 // Act ID where the object will be loaded.
ScaleX=10 // Scale of the model/sprite multiplied by 10, e.g. 10 means the object will not be scaled.
ScaleY=10
ScaleZ=10
ObjectType=TYPE''MODEL // Kind of object. Can be TYPE''MODEL (3D model), TYPE''SPRITE (flat model), TYPE''INVISIBLE (no geometry).
Flags=FLAG''MESSAGE, FLAG''WARP // Object flags.
MessageID=3 // ID of text string to display when you touch the object.
CollectibleID=1 // IDs for collectible objects. Each collectible needs to have a different ID that ranges from 1 to the total number of objects (up to 255).
TriggerRadius=20 // Distance required to trigger the object's action.
TextureID=1 // Force the model's material to a specific texture ID, useful for billboards but can work with 3D models too.
WarpLevelOrSoundbank=35 // Level ID to warp to or soundbank ID to play the sound when the object is triggered.
WarpActOrSoundID=2 // Act ID to warp to or sound ID to play when the object is triggered.
RotSpeedX=0 // Rotation speed.
RotSpeedY=10
RotSpeedZ=0
RotationX=49152 // Object rotation.
RotationY=4000
RotationZ=0
X=698 // Object position.
Y=0
Z=1600
</code>`<code>

== Additional Notes ==
* Sound data (MLT) is not compatible with the PC version.
* At the moment you have to replace an existing DLC in the mod to load your DLC in the PC version.
* For editing message strings manually, use </code>\n<code> for newlines and </code>TAB<code> (actual tabulation) for text centering.

= Troubleshooting =
If the browser or the emulator cannot import your DLC file, check the following:
# Make sure the filename in the VMI file matches the VMS filename.
# Make sure </code>Resource Name<code> in the VMI is 8 characters or less.

If the file is imported successfully but the game doesn't load the DLC, check the following:
# The filename on the VMU must be </code>SONICADV''XXX<code>, where </code>XXX<code> is a 3-digit number. For example, a file named </code>SONICADV''512<code> will be detected by the game.
# Make sure you aren't uploading an unencrypted file to the VMU. </code>Encrypt VMS files<code> in the </code>Edit<code> menu must be checked before you save the file.
# Check region and character locks.

If the result file is not created on the VMU upon completing the challenge, make sure your Dreamcast has the browser settings configured.

= Credits =
'''Sappharad''': providing C# code to decrypt VMS files and cracking the DLC checksum

'''Darksecond''': original Perl code to decrypt VMS files

= SA1 DLC File Format =
For nerds here's an overview of SA1 DLC structures:

</code>`<code>
* VMU HEADER
* OFFSET SIZE TYPE DESCRIPTION
* 0 16 string DLC title
* 10 32 string DLC description
* 30 16 string Application title
* 40 2 ushort Number of icons
* 42 2 ushort Animation speed
* 44 2 ushort Eyecatch type (unused)
* 46 2 ushort CRC (unused)
* 48 4 uint32 Size without the header
* 4C 20 null Reserved
* 60 32 ushort Icon palette, 16 colors
* 80 512 byte Icon graphics
* * SECTIONS HEADER (SIZE 64 BYTES)
* 280 4 uint32 Pointer to item layout table
* 284 4 uint32 Item count
* 288 4 uint32 Pointer to string table
* 28C 4 uint32 String item count
* 290 4 uint32 Pointer to PVM
* 294 4 uint32 Number of PVMs (always 1)
* 298 4 uint32 Number of textures in the PVM
* 29C 4 uint32 Pointer to MLT
* 2A0 4 uint32 Number of MLTs (either 0 or 1)
* 2A4 4 uint32 Pointer to PRS
* 2A8 4 uint32 Number of PRSes (always 1)
* 2AC 4 uint32 Checksum
* 2B0 16 null Unused
* * ITEM LAYOUT TABLE HEADER (SIZE 12 BYTES)
* 2C0 4 uint32 DLC ID (e.g. 504 in SONICADV_504)
* 2C4 1 byte Enable Sonic / Enable Tails
* 2C5 1 byte Enable Knuckles / Enable Gamma
* 2C6 1 byte Enable Amy / Enable Big
* 2C7 1 byte Unknown, probably unused
* 2C8 4 uint32 Regional lock
* * ITEM LAYOUT TABLE (ARRAY BEGINS AT 0x2CC, ITEM SIZE 30 BYTES)
* 0 1 uint8 Level ID
* 1 1 uint8 Act ID
* 2 1 uint8 Scale X multiplied by 10
* 3 1 uint8 Scale Y multiplied by 10
* 4 1 uint8 Scale Z multiplied by 10
* 5 1 uint8 Rotation speed X
* 6 1 uint8 Rotation speed Y
* 7 1 uint8 Rotation speed Z
* 8 1 sint8 Item type (0: model, -128: sprite, -1: invisible)
* 9 1 uint8 Texture ID
* A 2 ushort Flags
* C 1 uint8 Object ID used for collectible items or the number of objects to collect
* D 1 byte Unknown
* E 1 uint8 Message ID to show when touching the object
* F 1 uint8 Trigger distance
* 10 1 uint8 Level ID to warp or soundbank ID (8 for MLT, 15 for ADX music)
* 11 1 uint8 Act ID to warp to or sound/music ID to play when touching the object
* 12 2 ushort Rotation X
* 14 2 ushort Rotation Y
* 16 2 ushort Rotation Z
* 18 2 short Position X
* 1A 2 short Position Y
* 1C 2 short Position Z
* * DLC OBJECT FLAGS
* BIT_0 Unknown
* BIT_4 Unknown
* BIT_8 Solid
* BIT_9 Play sound
* BIT_10 Show message
* BIT_11 Hide object and disable everything except collision
* BIT_12 Warp
* BIT_13 Collectible item
* BIT_14 Timer item
* BIT_15 Starts the challenge
* * REGIONAL LOCK BITS
* -1 Disable regional lock
* 1 Japan
* 3 US
* 4 Europe
* 7 All regions
</code>``