Modding:Race Modding Guide - Revision history

Sightglass: /* Body Generation */ Typo

2024-04-11T20:47:43Z

Body Generation: Typo

← Older revision		Revision as of 20:47, 11 April 2024
Line 168:		Line 168:
	#ENDIF		#ENDIF

	]]></applyRaceChanges></blockquote>~~The~~, subspecies changes. These changes are usually for traits specific to the subspecies and used to differentiate them from other subspecies of the race. An example from Innoxia's [[Hyena-morph#Spotted Hyena-morph\|Spotted Hyena-Morph]], ensuring the coat is spotted for the subspecies check, and additionally making them taller:<blockquote> <applySubspeciesChanges><![CDATA[		]]></applyRaceChanges></blockquote>Then, subspecies changes. These changes are usually for traits specific to the subspecies and used to differentiate them from other subspecies of the race. An example from Innoxia's [[Hyena-morph#Spotted Hyena-morph\|Spotted Hyena-Morph]], ensuring the coat is spotted for the subspecies check, and additionally making them taller:<blockquote> <applySubspeciesChanges><![CDATA[

	[#targetedBody.setCoveringPattern(BODY_COVERING_TYPE_innoxia_hyena_fur, true, COVERING_PATTERN_SPOTTED)]		[#targetedBody.setCoveringPattern(BODY_COVERING_TYPE_innoxia_hyena_fur, true, COVERING_PATTERN_SPOTTED)]

Sightglass: /* Parser Primer */ Link instead of transclude

2024-04-11T20:31:37Z

Parser Primer: Link instead of transclude

← Older revision		Revision as of 20:31, 11 April 2024
Line 147:		Line 147:

	=== Parser Primer ===		=== Parser Primer ===
	{{Modding:Parser Primer}}		Main article: [[Modding:Parser Primer]]

	=== Body Generation ===		=== Body Generation ===

Sightglass: /* Coverings */

2024-03-02T05:59:32Z

Coverings

Show changes

Sightglass: /* Body Parts */ Xref with other parts

2024-03-02T05:11:42Z

Body Parts: Xref with other parts

← Older revision		Revision as of 05:11, 2 March 2024
Line 958:		Line 958:
	=== Body Parts ===		=== Body Parts ===
	These files each define a single part type, and are found in the folder as <code>res\mods\<author>\race\<race name>\bodyParts\<part name>.xml</code>, and the internal name for each is <code><author>_<race name>_<part name></code>. While the file name doesn't necessarily have to match what body part it is, it is recommended that you name them so they match (such as keeping the face type in <code>face.xml</code>). There can be multiple types for each body part, for example different tail variants as seen in the [[salamander-morph]] race: <code>tailFlame.xml</code> and <code>tailFrost.xml</code>.		These files each define a single part type, and are found in the folder as <code>res\mods\<author>\race\<race name>\bodyParts\<part name>.xml</code>, and the internal name for each is <code><author>_<race name>_<part name></code>. While the file name doesn't necessarily have to match what body part it is, it is recommended that you name them so they match (such as keeping the face type in <code>face.xml</code>). There can be multiple types for each body part, for example different tail variants as seen in the [[salamander-morph]] race: <code>tailFlame.xml</code> and <code>tailFrost.xml</code>.

			These parts appear in the [[#Body Definition]] and could also appear in subspecies changes. Many of these will use the [[#Coverings]] you define for this race mod.

	Depending on the body part, the elements required for each XML differs. Using existing parts from another race as a template is the easiest way to make sure all the required elements are present. You can also refer to the abstract types in [https://github.com/Innoxia/liliths-throne-public/tree/dev/src/com/lilithsthrone/game/character/body/abstractTypes src/com/lilithsthrone/game/character/body/abstractTypes]. The constructor that takes in an XML file (example <code>public AbstractArmType(File XMLFile, String author, boolean mod)</code> in [https://github.com/Innoxia/liliths-throne-public/blob/dev/src/com/lilithsthrone/game/character/body/abstractTypes/AbstractArmType.java AbstractArmType.java]) shows how the object loads up from the XML. Though the elements differ, there are common elements shared between different files:		Depending on the body part, the elements required for each XML differs. Using existing parts from another race as a template is the easiest way to make sure all the required elements are present. You can also refer to the abstract types in [https://github.com/Innoxia/liliths-throne-public/tree/dev/src/com/lilithsthrone/game/character/body/abstractTypes src/com/lilithsthrone/game/character/body/abstractTypes]. The constructor that takes in an XML file (example <code>public AbstractArmType(File XMLFile, String author, boolean mod)</code> in [https://github.com/Innoxia/liliths-throne-public/blob/dev/src/com/lilithsthrone/game/character/body/abstractTypes/AbstractArmType.java AbstractArmType.java]) shows how the object loads up from the XML. Though the elements differ, there are common elements shared between different files:

Sightglass: /* Testing */

2024-03-02T04:10:54Z

Testing

← Older revision		Revision as of 04:10, 2 March 2024
Line 247:		Line 247:
	# As a human, drink the potion. Read the transformation description for typos or error messages, and look in the error log.		# As a human, drink the potion. Read the transformation description for typos or error messages, and look in the error log.
	# Test combat moves. Check whether the critical condition works correct, and check the descriptions in both crit and non-crit hits for errors and typos.		# Test combat moves. Check whether the critical condition works correct, and check the descriptions in both crit and non-crit hits for errors and typos.
			# Whatever other extras you may have. Try to be thorough!

	== Specific File Guides ==		== Specific File Guides ==

Sightglass: /* Body Parts */ unused_bodyParts

2024-03-02T04:10:18Z

Body Parts: unused_bodyParts

← Older revision		Revision as of 04:10, 2 March 2024
Line 956:		Line 956:

	=== Body Parts ===		=== Body Parts ===
	These files each define a single part type, and are found in the folder <code>res\mods\<author>\race\<race name>\bodyParts\<part name>.xml</code>, and the internal name for each is <code><author>_<race name>_<part name></code>. While the file name doesn't necessarily have to match what body part it is, it is recommended that you name them so they match (such as keeping the face type in <code>face.xml</code>). There can be multiple types for each body part, for example different tail variants as seen in the [[salamander-morph]] race: <code>tailFlame.xml</code> and <code>tailFrost.xml</code>.		These files each define a single part type, and are found in the folder as <code>res\mods\<author>\race\<race name>\bodyParts\<part name>.xml</code>, and the internal name for each is <code><author>_<race name>_<part name></code>. While the file name doesn't necessarily have to match what body part it is, it is recommended that you name them so they match (such as keeping the face type in <code>face.xml</code>). There can be multiple types for each body part, for example different tail variants as seen in the [[salamander-morph]] race: <code>tailFlame.xml</code> and <code>tailFrost.xml</code>.

	Depending on the body part, the elements required for each XML differs. Using existing parts from another race as a template is the easiest way to make sure all the required elements are present. You can also refer to the abstract types in [https://github.com/Innoxia/liliths-throne-public/tree/dev/src/com/lilithsthrone/game/character/body/abstractTypes src/com/lilithsthrone/game/character/body/abstractTypes]. The constructor that takes in an XML file (example <code>public AbstractArmType(File XMLFile, String author, boolean mod)</code> in [https://github.com/Innoxia/liliths-throne-public/blob/dev/src/com/lilithsthrone/game/character/body/abstractTypes/AbstractArmType.java AbstractArmType.java]) shows how the object loads up from the XML. Though the elements differ, there are common elements shared between different files:		Depending on the body part, the elements required for each XML differs. Using existing parts from another race as a template is the easiest way to make sure all the required elements are present. You can also refer to the abstract types in [https://github.com/Innoxia/liliths-throne-public/tree/dev/src/com/lilithsthrone/game/character/body/abstractTypes src/com/lilithsthrone/game/character/body/abstractTypes]. The constructor that takes in an XML file (example <code>public AbstractArmType(File XMLFile, String author, boolean mod)</code> in [https://github.com/Innoxia/liliths-throne-public/blob/dev/src/com/lilithsthrone/game/character/body/abstractTypes/AbstractArmType.java AbstractArmType.java]) shows how the object loads up from the XML. Though the elements differ, there are common elements shared between different files:
Line 1,054:		Line 1,054:
	\|}		\|}
	Depending on the part, there will be other elements (ex: default girth, penetration modifiers for a penis). In the hyena body parts, there are comments for each.		Depending on the part, there will be other elements (ex: default girth, penetration modifiers for a penis). In the hyena body parts, there are comments for each.

			In the race folder, you can put parts that are not in use (such as horns, wings, etc.) into <code>res\mods\<author>\race\<race name>\unused_bodyParts\</code>. This isn't strictly necessary, as that folder is just ignored, but it can be handy to keep track of what parts are not used (or what parts are WIP).

	=== Coverings ===		=== Coverings ===

Sightglass: /* Testing */

2024-03-02T04:07:33Z

Testing

← Older revision		Revision as of 04:07, 2 March 2024
Line 233:		Line 233:

	=== Testing ===		=== Testing ===
			Whether you intend to publish the mod to the mod-sharing channel in the Discord, or just use it for your own game, {{Color\|#FF2222\|'''TEST YOUR MOD'''}}.

			While testing out the various parts of the mod, try keeping the error log (found in <code>data/error.log</code>) open in Notepad++. If the game encounters an error, it will write a line to that file, and the next time you click into NPP, it will ask to refresh the file.

			Mods are loaded when the game executable starts up. That means that after modifying mod files, you need to close and open the game again for it to update.

			I generally follow these steps when testing a mod to find potential issues:
			# When the game starts up, check the error log.
			# Go into the [[Debug Menu]] > Main tab > Race Resets, and transform the player character to each of your subspecies. Make sure that you are correctly recognized as each subspecies. This checks to see if the subspecies changes and race weighting are applied correctly. Also check the subspecies icon and status effect. If the subspecies is not set correctly, check the error log to see if the issue is in the subspecies changes, subspecies weighting, or both.
			# With the player character as the race, open the player's character description. Check for typos and error messages, and look in the error log.
			# Try to make a transformative potion for the race (and probably each subspecies). Make sure all the part names are correct.
			# Check items for typos, icon issues and errors in the description. Try using the items on both the PC and NPCs, to check the use messages for errors or typos.
			# As a human, drink the potion. Read the transformation description for typos or error messages, and look in the error log.
			# Test combat moves. Check whether the critical condition works correct, and check the descriptions in both crit and non-crit hits for errors and typos.

	== Specific File Guides ==		== Specific File Guides ==

Sightglass: /* General Guide */ Add Testing section

2024-03-02T03:46:42Z

General Guide: Add Testing section

← Older revision		Revision as of 03:46, 2 March 2024
Line 231:		Line 231:
	* [https://github.com/Innoxia/liliths-throne-public/tree/dev/src/com/lilithsthrone/game/character/body/valueEnums src/com/lilithsthrone/game/character/body/valueEnums] has enumerations for things like body shape, covering patterns and modifiers (textures), and leg configurations. These values are used throughout the mod, especially making [[Modding:Race Modding Guide#Body Parts\|#Body Part]] definitions and the [[#Racial Body]] definition.		* [https://github.com/Innoxia/liliths-throne-public/tree/dev/src/com/lilithsthrone/game/character/body/valueEnums src/com/lilithsthrone/game/character/body/valueEnums] has enumerations for things like body shape, covering patterns and modifiers (textures), and leg configurations. These values are used throughout the mod, especially making [[Modding:Race Modding Guide#Body Parts\|#Body Part]] definitions and the [[#Racial Body]] definition.
	* [https://github.com/Innoxia/liliths-throne-public/blob/dev/src/com/lilithsthrone/game/character/attributes/Attribute.java src/com/lilithsthrone/game/character/attributes/Attribute.java] enumerates the attributes, useful for making the subspecies stat bonuses.		* [https://github.com/Innoxia/liliths-throne-public/blob/dev/src/com/lilithsthrone/game/character/attributes/Attribute.java src/com/lilithsthrone/game/character/attributes/Attribute.java] enumerates the attributes, useful for making the subspecies stat bonuses.

			=== Testing ===

	== Specific File Guides ==		== Specific File Guides ==

Sightglass: Fix missing heading

2024-03-02T03:44:53Z

Fix missing heading

← Older revision		Revision as of 03:44, 2 March 2024
Line 231:		Line 231:
	* [https://github.com/Innoxia/liliths-throne-public/tree/dev/src/com/lilithsthrone/game/character/body/valueEnums src/com/lilithsthrone/game/character/body/valueEnums] has enumerations for things like body shape, covering patterns and modifiers (textures), and leg configurations. These values are used throughout the mod, especially making [[Modding:Race Modding Guide#Body Parts\|#Body Part]] definitions and the [[#Racial Body]] definition.		* [https://github.com/Innoxia/liliths-throne-public/tree/dev/src/com/lilithsthrone/game/character/body/valueEnums src/com/lilithsthrone/game/character/body/valueEnums] has enumerations for things like body shape, covering patterns and modifiers (textures), and leg configurations. These values are used throughout the mod, especially making [[Modding:Race Modding Guide#Body Parts\|#Body Part]] definitions and the [[#Racial Body]] definition.
	* [https://github.com/Innoxia/liliths-throne-public/blob/dev/src/com/lilithsthrone/game/character/attributes/Attribute.java src/com/lilithsthrone/game/character/attributes/Attribute.java] enumerates the attributes, useful for making the subspecies stat bonuses.		* [https://github.com/Innoxia/liliths-throne-public/blob/dev/src/com/lilithsthrone/game/character/attributes/Attribute.java src/com/lilithsthrone/game/character/attributes/Attribute.java] enumerates the attributes, useful for making the subspecies stat bonuses.

			== Specific File Guides ==

	=== Table Format ===		=== Table Format ===

Sightglass: Undo revision 8526 by Sightglass (talk)

2024-03-02T03:44:21Z

Undo revision 8526 by Sightglass (talk)

Show changes