Tutorial:Mass Sprite Import - Revision history

Imbion: Imbion moved page Mass Sprite Import to Tutorial:Mass Sprite Import

2025-10-16T15:47:49Z

Imbion moved page Mass Sprite Import to Tutorial:Mass Sprite Import

← Older revision	Revision as of 15:47, 16 October 2025
(No difference)

IDK: link conversion flags

2025-08-12T20:56:45Z

link conversion flags

← Older revision		Revision as of 20:56, 12 August 2025
Line 115:		Line 115:
	You will also see that <code>./PMDODump/RawAsset/portrait_diff.csv</code> <code>./PMDODump/RawAsset/sprite_diff.csv</code> have been changed. These lists offer a comprehensive breakdown of which files changed and where.		You will also see that <code>./PMDODump/RawAsset/portrait_diff.csv</code> <code>./PMDODump/RawAsset/sprite_diff.csv</code> have been changed. These lists offer a comprehensive breakdown of which files changed and where.

	Now, you must run PMDO with the conversion flags turned on to convert the sprites to PMDO's format. In windows, it would be like this:		Now, you must run PMDO with the [[Mass_Importing_Assets\|conversion flags]] turned on to convert the sprites to PMDO's format. In windows, it would be like this:

	<pre>PMDO.exe -raw ../../RawAsset/ -convert chara portrait</pre>		<pre>PMDO.exe -raw ../../RawAsset/ -convert chara portrait</pre>

IDK at 19:01, 20 July 2025

2025-07-20T19:01:17Z

← Older revision		Revision as of 19:01, 20 July 2025
Line 89:		Line 89:
	[[File:Maintenance_Added_Nodes.png\|frameless]]		[[File:Maintenance_Added_Nodes.png\|frameless]]

	The script automatically sets Alternates and AltColors to be ignored, as seen with the asterisk preceding their names. However, some ~~fors~~ that we don't want in PMDO might still slip through the cracks. PMDO sticks to only canon Pokemon that are not barred from ~~intergenerational~~ transfer. The "baseline pokedex" so to speak. We see here that Pikachu has a number of hat forms that must be manually excluded from transfer.		The script automatically sets Alternates and AltColors to be ignored, as seen with the asterisk preceding their names. However, some forms that we don't want in PMDO might still slip through the cracks. PMDO sticks to only canon Pokemon that are not barred from inter-generational transfer. The "baseline pokedex" so to speak. We see here that Pikachu has a number of hat forms that must be manually excluded from transfer.

	To do this, open up <code>./PMDODump/RawAsset/transfer.json</code> which contains the node structure for transferring portraits and sprites.		To do this, open up <code>./PMDODump/RawAsset/transfer.json</code> which contains the node structure for transferring portraits and sprites.

IDK: images

2023-10-20T03:51:43Z

images

← Older revision		Revision as of 03:51, 20 October 2023
Line 87:		Line 87:
	Open <code>./PMDODump/RawAsset/added_nodes.txt</code>. This is a generated file showing what new nodes have been added to the pokemon list compared to the current repository. This will include all manner of new species/forms due to a new game coming out, or new alternate portraits created by fans.		Open <code>./PMDODump/RawAsset/added_nodes.txt</code>. This is a generated file showing what new nodes have been added to the pokemon list compared to the current repository. This will include all manner of new species/forms due to a new game coming out, or new alternate portraits created by fans.

	[~~image~~]		[[File:Maintenance_Added_Nodes.png\|frameless]]

	The script automatically sets Alternates and AltColors to be ignored, as seen with the asterisk preceding their names. However, some fors that we don't want in PMDO might still slip through the cracks. PMDO sticks to only canon Pokemon that are not barred from intergenerational transfer. The "baseline pokedex" so to speak. We see here that Pikachu has a number of hat forms that must be manually excluded from transfer.		The script automatically sets Alternates and AltColors to be ignored, as seen with the asterisk preceding their names. However, some fors that we don't want in PMDO might still slip through the cracks. PMDO sticks to only canon Pokemon that are not barred from intergenerational transfer. The "baseline pokedex" so to speak. We see here that Pikachu has a number of hat forms that must be manually excluded from transfer.
Line 93:		Line 93:
	To do this, open up <code>./PMDODump/RawAsset/transfer.json</code> which contains the node structure for transferring portraits and sprites.		To do this, open up <code>./PMDODump/RawAsset/transfer.json</code> which contains the node structure for transferring portraits and sprites.

	[~~image~~]		[[File:Maintenance_Transfer_Json.png\|frameless]]

	When <code>portrait_dest</code> is set to -1, it means to import the portrait from the source to the same slot as in the destination. If it's set to 0 or above, it gets imported to that specific numbered slot. If it's set to -2, it is not imported at all. The same policy goes for sprites.		When <code>portrait_dest</code> is set to -1, it means to import the portrait from the source to the same slot as in the destination. If it's set to 0 or above, it gets imported to that specific numbered slot. If it's set to -2, it is not imported at all. The same policy goes for sprites.

	[~~image~~]		[[File:Maintenance_Transfer_Json_Ignored.png\|frameless]]

	In this case, we have set all of the pikachu forms' <code>portrait_dest</code> and <code>sprite_dest</code> to -2, preventing them from being imported.		In this case, we have set all of the pikachu forms' <code>portrait_dest</code> and <code>sprite_dest</code> to -2, preventing them from being imported.

IDK: post-import inspection

2023-10-20T03:43:30Z

post-import inspection

← Older revision		Revision as of 03:43, 20 October 2023
Line 125:		Line 125:
	Wait for the conversion to finish. It takes hours.		Wait for the conversion to finish. It takes hours.

			Run the game in debug mode and change sprites to confirm everything imported okay. Use the <code>./PMDODump/RawAsset/portrait_diff.csv</code> <code>./PMDODump/RawAsset/sprite_diff.csv</code> as a guide to see which sprites/portraits deserve more attention in inspection.

	== Contributing ==		== Contributing ==

IDK at 03:40, 20 October 2023

2023-10-20T03:40:04Z

← Older revision		Revision as of 03:40, 20 October 2023
Line 3:		Line 3:
	PMDO gets its sprites and portraits from two repositories:		PMDO gets its sprites and portraits from two repositories:

	1. https://github.com/PMDCollab/SpriteCollab , which is the repo of the PMD Sprite Repository. This contains all canon sprites and portraits from PMD2 plus custom ones by fans.		# https://github.com/PMDCollab/SpriteCollab , which is the repo of the PMD Sprite Repository. This contains all canon sprites and portraits from PMD2 plus custom ones by fans.
	2. https://github.com/audinowho/CustomSpriteCollab , which is a custom repo of sprites and portraits meant to serve as an override to the sprites in the above repository. It consists of exceptional cases or textures that weren't accepted in the repo but still preferred for PMDO.		# https://github.com/audinowho/CustomSpriteCollab , which is a custom repo of sprites and portraits meant to serve as an override to the sprites in the above repository. It consists of exceptional cases or textures that weren't accepted in the repo but still preferred for PMDO.

	Every so often, the RawAsset repo is updated with textures from these two repos in a mass import action.		Every so often, the RawAsset repo is updated with textures from these two repos in a mass import action.
Line 130:		Line 130:
	Sprite and portrait updates are an occasional occurrence because of how long the conversion steps take. If you want to contribute an update to PMDO's sprite repo yourself, you will need to provide the converted files in <code>Content/Chara</code> and <code>Content/Portrait</code>, as well as the changes in <code>./PMDODump/RawAsset</code>.		Sprite and portrait updates are an occasional occurrence because of how long the conversion steps take. If you want to contribute an update to PMDO's sprite repo yourself, you will need to provide the converted files in <code>Content/Chara</code> and <code>Content/Portrait</code>, as well as the changes in <code>./PMDODump/RawAsset</code>.

	This can be done either by sending a zip, or a pull request.		This can be done either by sending a zip, or making a [[Contributing_Code\| pull request]].

	[[Category:Maintenance]]		[[Category:Maintenance]]

IDK: Created page with "PMDO's sprites and portraits are found in the `sprite/` and `portrait/` subdirectories of the https://github.com/PMDCollab/RawAsset repository. PMDO gets its sprites and portraits from two repositories: 1. https://github.com/PMDCollab/SpriteCollab , which is the repo of the PMD Sprite Repository. This contains all canon sprites and portraits from PMD2 plus custom ones by fans. 2. https://github.com/audinowho/CustomSpriteCollab , which is a custom..."

2023-10-20T03:37:47Z

Created page with "PMDO's sprites and portraits are found in the <code>sprite/</code> and <code>portrait/</code> subdirectories of the https://github.com/PMDCollab/RawAsset repository. PMDO gets its sprites and portraits from two repositories: 1. https://github.com/PMDCollab/SpriteCollab , which is the repo of the PMD Sprite Repository. This contains all canon sprites and portraits from PMD2 plus custom ones by fans. 2. https://github.com/audinowho/CustomSpriteCollab , which is a custom..."

New page

PMDO's sprites and portraits are found in the <code>sprite/</code> and <code>portrait/</code> subdirectories of the https://github.com/PMDCollab/RawAsset repository.

PMDO gets its sprites and portraits from two repositories:

1. https://github.com/PMDCollab/SpriteCollab , which is the repo of the PMD Sprite Repository. This contains all canon sprites and portraits from PMD2 plus custom ones by fans.
2. https://github.com/audinowho/CustomSpriteCollab , which is a custom repo of sprites and portraits meant to serve as an override to the sprites in the above repository. It consists of exceptional cases or textures that weren't accepted in the repo but still preferred for PMDO.

Every so often, the RawAsset repo is updated with textures from these two repos in a mass import action.

This page outlines the workflow used to import all of these textures into PMDO.

== Filesystem Setup ==

These are all of the relevant folders and files needed to do a mass update of sprites and portraits.

<pre>
./PMDODump
./PMDODump/RawAsset
./PMDODump/RawAsset/added_nodes.txt
./PMDODump/RawAsset/transfer.json
./PMDODump/RawAsset/custom_transfer.json
./PMDODump/RawAsset/portrait_diff.csv
./PMDODump/RawAsset/sprite_diff.csv
./PMDODump/Scripts
./PMDODump/Scripts/sprite_sync.py
./SpriteBot/SpriteCollab
./SpriteBot/SpriteCollab/portrait
./SpriteBot/SpriteCollab/sprite
./SpriteBot/Custom
./SpriteBot/Custom/portrait
./SpriteBot/Custom/sprite
</pre>

You will need to set up your directory structure such that it looks like this.

This will involve cloning 4 repositories from github.

First, you will need to find a suitable folder to begin in, and clone https://github.com/audinowho/PMDODump into it.

<pre>git clone https://github.com/audinowho/PMDODump.git</pre>

Then, update its submodule https://github.com/PMDCollab/RawAsset within PMDODump:

<pre>git submodule update --init --remote -- RawAsset</pre>

This will result in the following file structure:

<pre>
./PMDODump
./PMDODump/RawAsset
</pre>

Then, you must create a <code>SpriteBot/</code> folder on the same level as the PMDODump folder.

Then, clone both https://github.com/PMDCollab/SpriteCollab and https://github.com/audinowho/CustomSpriteCollab to this location.

<pre>
git clone https://github.com/PMDCollab/SpriteCollab.git
git clone https://github.com/audinowho/CustomSpriteCollab.git
</pre>

This will result in the following file structure:

<pre>
./PMDODump
./PMDODump/RawAsset
./SpriteBot/SpriteCollab
./SpriteBot/Custom
</pre>

You've now set up all the needed repositories.

== Importing to RawAsset ==

Locate the file <code>./PMDODump/Scripts/sprite_sync.py</code> and run the file using python. You may need to install the requirements from <code>./PMDODump/Scripts/requirements.txt</code>

You will arrive at this message:

<pre>
Updating Transfer Map
Transfer json updated. Review the added_nodes.txt and make your changes before proceeding.
</pre>

Open <code>./PMDODump/RawAsset/added_nodes.txt</code>. This is a generated file showing what new nodes have been added to the pokemon list compared to the current repository. This will include all manner of new species/forms due to a new game coming out, or new alternate portraits created by fans.

[image]

The script automatically sets Alternates and AltColors to be ignored, as seen with the asterisk preceding their names. However, some fors that we don't want in PMDO might still slip through the cracks. PMDO sticks to only canon Pokemon that are not barred from intergenerational transfer. The "baseline pokedex" so to speak. We see here that Pikachu has a number of hat forms that must be manually excluded from transfer.

To do this, open up <code>./PMDODump/RawAsset/transfer.json</code> which contains the node structure for transferring portraits and sprites.

[image]

When <code>portrait_dest</code> is set to -1, it means to import the portrait from the source to the same slot as in the destination. If it's set to 0 or above, it gets imported to that specific numbered slot. If it's set to -2, it is not imported at all. The same policy goes for sprites.

[image]

In this case, we have set all of the pikachu forms' <code>portrait_dest</code> and <code>sprite_dest</code> to -2, preventing them from being imported.

This node system also applies to <code>./PMDODump/RawAsset/custom_transfer.json</code>. However, given that repo is specific to PMDO there is no need to review it for unexpected changes.

The process of reviewing the nodes needs to be done every time an import happens to ensure a consistent PMDO sprite repo.

Once this is completed, save the transfer file and press enter to continue the python script. It will begin the hours-long process of copying the desired files over and examining the contents for changes.

== Converting from RawAsset ==

Once the import is complete, you can confirm there are changed files in your repository by viewing RawAsset in git.

<pre>git status</pre>

You will also see that <code>./PMDODump/RawAsset/portrait_diff.csv</code> <code>./PMDODump/RawAsset/sprite_diff.csv</code> have been changed. These lists offer a comprehensive breakdown of which files changed and where.

Now, you must run PMDO with the conversion flags turned on to convert the sprites to PMDO's format. In windows, it would be like this:

<pre>PMDO.exe -raw ../../RawAsset/ -convert chara portrait</pre>

Replace the <code>../../RawAsset/</code> argument with the path of RawAsset relative to your own installation. This will import character and portrait textures to the <code>Content/Chara</code> and <code>Content/Portrait</code> folders in your PMDO installation.

Alternatively, if you are running PMDO from source, you can do this conversion just by adding <code>-convert chara portrait</code> to your debug arguments.

Wait for the conversion to finish. It takes hours.

== Contributing ==

Sprite and portrait updates are an occasional occurrence because of how long the conversion steps take. If you want to contribute an update to PMDO's sprite repo yourself, you will need to provide the converted files in <code>Content/Chara</code> and <code>Content/Portrait</code>, as well as the changes in <code>./PMDODump/RawAsset</code>.

This can be done either by sending a zip, or a pull request.

[[Category:Maintenance]]