Parts Pack Production Procedure - Revision history

KiwiShark: 19 revisions imported

2024-10-09T16:46:08Z

19 revisions imported

← Older revision		Revision as of 18:46, 9 October 2024
(No difference)

Spacewarp>Munix: /* Material setup */

2024-03-08T19:41:06Z

Material setup

← Older revision		Revision as of 21:41, 8 March 2024
Line 56:		Line 56:
	# '''Apply the textures:''' For each material, assign the textures to the '''Albedo''', '''Metallic''', '''Normal''', '''Emissive''' and '''Paintable''' channels.		# '''Apply the textures:''' For each material, assign the textures to the '''Albedo''', '''Metallic''', '''Normal''', '''Emissive''' and '''Paintable''' channels.
	## For Normal channels, click the '''Fix Now''' button.		## For Normal channels, click the '''Fix Now''' button.
			#'''Set properties''': Set '''Metallic/Smoothness Map''' to 1 and check '''Use PaintMask for Paint Smoothness'''.
	# '''Apply materials:''' For each mesh, assign the materials to the corresponding locations. Click on '''Apply'''.		# '''Apply materials:''' For each mesh, assign the materials to the corresponding locations. Click on '''Apply'''.

Spacewarp>Safarte: /* Mesh setup */

2024-02-24T11:46:11Z

Mesh setup

← Older revision		Revision as of 13:46, 24 February 2024
Line 44:		Line 44:

	=== Mesh setup ===		=== Mesh setup ===
	# '''Bring in the Mesh''': Drag a copy of your part’s FBX file into the part folder.		# '''Bring in the Mesh''': Drag a copy of your part’s FBX file into the part folder. If you have baked textures for your part that go with the FBX (meaning, they’re based on the UV Unwrap specific to that FBX), then drag those into this same folder along with the FBX.
	## If you have baked textures for your part that go with the FBX (meaning, they’re based on the UV Unwrap specific to that FBX), then drag those into this same folder along with the FBX.
	# '''Create Part Mesh Object''': Drag a copy of the part's FBX from the Part folder in Unity to the <code>model</code> object created in step 2. Don’t drag the FBX file from your computer’s files system, you need to use the copy you just placed in step 4. This will create a '''prefab''' for your part as a child of the model object.		# '''Create Part Mesh Object''': Drag a copy of the part's FBX from the Part folder in Unity to the <code>model</code> object created in step 2. Don’t drag the FBX file from your computer’s files system, you need to use the copy you just placed in step 4. This will create a '''prefab''' for your part as a child of the model object.
	# '''Unpack Prefab''': Right-Click part object: '''Prefab > Unpack'''.		# '''Unpack Prefab''': Right-Click part object: '''Prefab > Unpack'''.

Spacewarp>Safarte: /* Magnificent Mesh Modelling (Creating the part asset) */

2024-02-24T11:20:39Z

Magnificent Mesh Modelling (Creating the part asset)

← Older revision		Revision as of 13:20, 24 February 2024
Line 8:		Line 8:
	# [[Modeling the mesh in Blender]]		# [[Modeling the mesh in Blender]]
	# [[Texturing the mesh in Substance 3D Painter]]		# [[Texturing the mesh in Substance 3D Painter]]
	~~# [[Preparing the mesh for Unity]]~~

	Here are some resources that can be useful for modelling and texturing, regardless of the software you're using:		Here are some resources that can be useful for modelling and texturing, regardless of the software you're using:

Spacewarp>Safarte at 00:29, 24 February 2024

2024-02-24T00:29:33Z

← Older revision		Revision as of 02:29, 24 February 2024
Line 66:		Line 66:
	## '''Position, Rotation, and Scale''': Set the position, rotation, and scale of the mesh to encompass the part. You should see a green mesh represented in the Scene window to help guide you to make sure you’ve got the right position, rotation, and scale.		## '''Position, Rotation, and Scale''': Set the position, rotation, and scale of the mesh to encompass the part. You should see a green mesh represented in the Scene window to help guide you to make sure you’ve got the right position, rotation, and scale.
	## '''Convex''': Check “Convex”		## '''Convex''': Check “Convex”

			=== Core Part Data setup ===
	# '''Add Core Part Data''': Select your Root Part Object. In the Inspector Window click “Add Component”. Search for “Core Part Data” and pick that. Open it up and configure as follows:		# '''Add Core Part Data''': Select your Root Part Object. In the Inspector Window click “Add Component”. Search for “Core Part Data” and pick that. Open it up and configure as follows:
	## '''Part Name''': The Part Name needs to be the same as what you’ve used for the Root Part object, i.e., my_awesome_mod_my_part or whatever you used.		## '''Part Name''': The Part Name needs to be the same as what you’ve used for the Root Part object, i.e., my_awesome_mod_my_part or whatever you used.

Spacewarp>Safarte at 00:28, 24 February 2024

2024-02-24T00:28:58Z

Show changes

Spacewarp>Safarte at 00:12, 24 February 2024

2024-02-24T00:12:13Z

← Older revision		Revision as of 02:12, 24 February 2024
Line 1:		Line 1:
	~~Prerequisites:~~
	~~[[Setting up Unity]]~~
	The aim of this tutorial is to guide you through the process of creating your first '''part mod''' for Kerbal Space Program 2. We will go over everything from creating the part's mesh and textures to setting up the part in Unity to be bundled into a KSP2 mod.		The aim of this tutorial is to guide you through the process of creating your first '''part mod''' for Kerbal Space Program 2. We will go over everything from creating the part's mesh and textures to setting up the part in Unity to be bundled into a KSP2 mod.

Line 17:		Line 15:
	* [[Texturing]]		* [[Texturing]]

	== Part Pack Prep (Basic Unity part setup) ==		== Part Pack Prep (Basic Unity part mod project setup) ==
	~~# '''Create Unity Project''': Create a new Unity project with an empty scene. You can use the sample scene.~~		Now that you have created a model and textures for your part, the next step is to set up a Unity project that will be used to configure your part and build the asset bundles that will contain your mod's contents.
	~~# '''Install Addressables package''': Open Window > Package Manger and select Packages: Unity Registry. Search for addressables and click Install.~~
	# '''Install ThunderKit in Unity'''. See [https://luxstice.notion.site/Installing-ThunderKit-7e00f13efe804f12a31a9f31d7f9fd6e Installing Tunderkit] from the Getting Ready section of the KSP2 Part Tutorial linked above for details. See figures for Thunderkit Settings and Thunderkit Import Process Complete for examples of what to expect in this process.
	# '''Install Unity KSP Tools in Unity'''. See Installing KSP2 Unity Tools from the Getting Ready section of the KSP2 Part Tutorial linked above for details. KSP2 Unity Tools takes care of much of the initial setup for you~~, greatly streamlining the process while reducing the likelihood of errors with~~ a single click <DESCRIBE WHAT NEEDS TO BE CLICKED>. <Describe KSP2 Unity Setup which takes care of swinfo, etc.>[[File:Thunderkit Settings.png\|alt=Thunderkit Settings\|thumb\|Figure 1: Thunderkit Settings]][[File:Import Process Complete dialog.png\|thumb\|Figure 2: Thunderkit: Import Process Complete]]
	~~# '''Create Parts Pack folder''': Under Assets, create a folder (L-Click Assets: Create > Folder)~~ and ~~name it the same as your parts pack mod. If your mod is called My Awesome Mod then this would be Assets\MyAwesomeMod.~~
	~~# '''Create Materials folder''': Inside your parts pack folder create a folder called Materials. You’ll be storing the~~ textures ~~and materials you need there. E.g., Assets\MyAwesomeMod\Materials. This is just to aid in organization.~~
	~~# '''Create Parts folder''': Inside~~ your ~~parts pack folder create a folder called Parts. You’ll be storing the~~ part ~~meshes and related things there. E.g.~~, Assets\MyAwesomeMod\Parts. You can have whatever organization you like here, so if you want to group some parts you might create group folders within Parts (e.g., Methalox Engines, Nuclear Engines, Ion Engines, etc.). This is ~~just~~ to ~~aid in organization and is optional.~~
	~~# '''Create Plugin Folder and Content''': In your~~ Unity project~~'s Assets\plugin_template folder create a “localizations” folder. NOTE! This is currently required to be exactly this – localizations (plural), not localization (singular). This~~ will be ~~where you put the localization files (e.g., english.csv, spanish.csv, etc.).~~
	~~## Create Localization file(s): Localization files are CSV files following a particular format. These must have lines ending with LF not LF/NL,~~ and ~~they must reference~~ the ~~same <part_name> you use in the Part Production process below. There are some other restrictions for content, particularly that if you want a string that contains a “,”~~ that ~~string needs to be enclosed in quotes or the comma~~ will ~~mess with how the strings are parsed. These files are where the part’s Title, Subtitle, Manufacturer, and Description are configured~~. ~~Here’s an example:<syntaxhighlight lang="text">~~
	~~Key,Type,Desc,English~~

	Parts/Title~~/spark_spt100~~,~~Text~~,,~~SPT-100~~		# '''Creating the project:''' Follow the [[Setting up Unity]] tutorial to create and set up a project for part modding.
			# '''Parts Pack folder''': Under Assets, create a folder (R-Click Assets: Create > Folder) and name it the same as your parts pack mod. If your mod is called My Awesome Mod then this would be <code>Assets\MyAwesomeMod</code>.
			# '''Materials folder''': Inside your parts pack folder create a folder called Materials. You’ll be storing the textures and materials you need there. E.g., <code>Assets\MyAwesomeMod\Materials</code>. This is just to aid in organization.
			# '''Parts folder''': Inside your parts pack folder create a folder called Parts. You’ll be storing the part meshes and related things there. E.g., <code>Assets\MyAwesomeMod\Parts</code>. You can have whatever organization you like here, so if you want to group some parts you might create group folders within Parts (e.g., Methalox Engines, Nuclear Engines, Ion Engines, etc.). This is just to aid in organization and is optional.
			# '''Plugin Folder and Content''': In your Unity project's <code>Assets\plugin_template</code> folder create a <code>localizations</code> folder. '''NOTE!''' This is currently required to be exactly this – localizations (plural), not localization (singular). This will be where you put the localization file.
			## Create Localization file: Localization files are CSV files following a particular format. These must have lines ending with LF not LF/NL, and they must reference the same <part_name> you use in the Part Production process below. There are some other restrictions for content, particularly that if you want a string that contains a “,” that string needs to be enclosed in quotes or the comma will mess with how the strings are parsed. These files are where the part’s Title, Subtitle, Manufacturer, and Description are configured. Here’s an example:<syntaxhighlight lang="text">
			Key,Type,Desc,English,French

	Parts/Subtitle/ spark_spt100,Text,,Hall Effect Thruster with Xenon Tank		Parts/Title/spark_spt100,Text,,SPT-100,SPT-100
			Parts/Subtitle/spark_spt100,Text,,Hall Effect Thruster with Xenon Tank,Moteur à Effet Hall et Réservoir de Xénon
			Parts/Manufacturer/spark_spt100,Text,,"Stellar Plasma-Assisted Rocket Kinetics, inc.","Stellar Plasma-Assisted Rocket Kinetics, inc."
			Parts/Description/spark_spt100,Text,,"The SPT-100 is the pinnacle in tiny (0.625m-class) Ion engines, providing high Isp and low thrust with an integral toroidal xenon tank. Strap this little guy onto a probe core and be sure to bring plenty of electrons because you're in for a long slow ride to anywhere!","Le SPT-100 a le dessus dans la catégorie des très petits (0.625m) moteurs ioniques, avec une haute impulsion spécifique et une poussée faible ainsi qu'un réservoir toroïdal de xénon intégré. Accrochez ce petit gars à vos sondes et assurez-vous d'avoir du stock d'électrons car vous allez aller de partout bien lentement!"

	~~Parts/Manufacturer/spark_spt100,Text,,"Stellar Plasma-Assisted Rocket Kinetics, inc."~~		Parts/Title/spark_x3,Text,,X3 NHT,X3 NHT
			Parts/Subtitle/spark_x3,Text,,Three-Channel Nested Hall Effect Thruster,Moteur à Effet Hall à 3 Canaux Concentriques
	Parts/Description/spark_spt100,Text,,"The SPT-100 is the pinnacle in tiny (0.625m-class) Ion engines, providing high Isp and low thrust with an integral toroidal xenon tank. Strap this little guy onto a probe core and be sure to bring plenty of electrons because you're in for a long slow ride to anywhere!"		Parts/Manufacturer/spark_x3,Text,,"Stellar Plasma-Assisted Rocket Kinetics, inc.","Stellar Plasma-Assisted Rocket Kinetics, inc."
			Parts/Description/spark_x3,Text,,"The SPARK X3 is the pinnacle in small (1.25m-class) Ion engines, providing high Isp and low thrust. Strap this bad boy onto your large probe or small capsule and be sure to bring plenty of electrons because you're in for a long slow ride to anywhere!","Le SPARK X3 a le dessus dans la catégorie des petits (1.25m) moteurs ioniques, avec une haute impulsion spécifique et une poussée faible ainsi qu'un réservoir toroïdal de xénon intégré. Accrochez ce petit gars à vos grandes sondes et assurez-vous d'avoir du stock d'électrons car vous allez aller de partout bien lentement!"
	Parts/Title/spark_x3,Text,,X3 NHT

	Parts/Subtitle/spark_x3,Text,,Three-Channel Nested Hall Effect Thruster

	Parts/Manufacturer/spark_x3,Text,,"Stellar Plasma-Assisted Rocket Kinetics, inc."

	Parts/Description/spark_x3,Text,,"The SPARK X3 is the pinnacle in small (1.25m-class) Ion engines, providing high Isp and low thrust. Strap this bad boy onto your large probe or small capsule and be sure to bring plenty of electrons because you're in for a long slow ride to anywhere!"
	</syntaxhighlight>		</syntaxhighlight>

Spacewarp>Safarte at 23:55, 23 February 2024

2024-02-23T23:55:18Z

Show changes

Spacewarp>Schlosrat: fixed typo

2024-02-04T22:31:18Z

fixed typo

← Older revision		Revision as of 00:31, 5 February 2024
Line 107:		Line 107:
	## '''Module_Gimbal''': Configure details as needed (e.g., Gimbal Range and Gimbal Speed, etc.), then drag this up to the Gimbal property in Module_Engine.		## '''Module_Gimbal''': Configure details as needed (e.g., Gimbal Range and Gimbal Speed, etc.), then drag this up to the Gimbal property in Module_Engine.
	## '''Module_Generator''': Configure details as needed, then drag this up to the Alternator property in Module_Engine.		## '''Module_Generator''': Configure details as needed, then drag this up to the Alternator property in Module_Engine.
	## [[File:Module Fairing Data.png\|thumb\|Figure 3: Example Fairing Data in Unity Editor]]'''Module_Fairing''': Unless you plan for your engine to only ever be on the very first stage (i.e., a big booster), then you probably want it to have a fairing so it can be used in the second stage and above. Figure 3 shows an example for a working fairing from a Size Small (1.25m-class) engine that was created using ~~the~~ process. Shown below is the corresponding example of the PartComponentModule_Fairing portion of the part JSON. As can be seen in Figure 3, the data fields that need to be populated in the Unity Editor include only a subset of what's in the auto-generated JSON. That said, everything the editor needs is in the example below and presenting it this way makes copy/paste possible where unity editor graphic would not allow that.<syntaxhighlight lang="json">		## [[File:Module Fairing Data.png\|thumb\|Figure 3: Example Fairing Data in Unity Editor]]'''Module_Fairing''': Unless you plan for your engine to only ever be on the very first stage (i.e., a big booster), then you probably want it to have a fairing so it can be used in the second stage and above. Figure 3 shows an example for a working fairing from a Size Small (1.25m-class) engine that was created using this process. Shown below is the corresponding example of the PartComponentModule_Fairing portion of the part JSON. As can be seen in Figure 3, the data fields that need to be populated in the Unity Editor include only a subset of what's in the auto-generated JSON. That said, everything the editor needs is in the example below and presenting it this way makes copy/paste possible where unity editor graphic would not allow that.<syntaxhighlight lang="json">
	{		{
	"Name": "PartComponentModule_Fairing",		"Name": "PartComponentModule_Fairing",

Spacewarp>Schlosrat: Updated Step 8 for new process.

2024-02-04T22:26:52Z

Updated Step 8 for new process.

← Older revision		Revision as of 00:26, 5 February 2024
Line 38:		Line 38:
	# '''Create Materials folder''': Inside your parts pack folder create a folder called Materials. You’ll be storing the textures and materials you need there. E.g., Assets\MyAwesomeMod\Materials. This is just to aid in organization.		# '''Create Materials folder''': Inside your parts pack folder create a folder called Materials. You’ll be storing the textures and materials you need there. E.g., Assets\MyAwesomeMod\Materials. This is just to aid in organization.
	# '''Create Parts folder''': Inside your parts pack folder create a folder called Parts. You’ll be storing the part meshes and related things there. E.g., Assets\MyAwesomeMod\Parts. You can have whatever organization you like here, so if you want to group some parts you might create group folders within Parts (e.g., Methalox Engines, Nuclear Engines, Ion Engines, etc.). This is just to aid in organization and is optional.		# '''Create Parts folder''': Inside your parts pack folder create a folder called Parts. You’ll be storing the part meshes and related things there. E.g., Assets\MyAwesomeMod\Parts. You can have whatever organization you like here, so if you want to group some parts you might create group folders within Parts (e.g., Methalox Engines, Nuclear Engines, Ion Engines, etc.). This is just to aid in organization and is optional.
	# '''Create Plugin Folder and Content''': In your ~~KSP2 install’s BepInEx~~\~~plugins~~ folder create a folder ~~for your mod~~. ~~You can name this whatever you like, but it should be unique. This will be the “mod” players will install to have your parts pack and we’ll refer to it as the Base Plugin Folder in this guide.~~		# '''Create Plugin Folder and Content''': In your Unity project's Assets\plugin_template folder create a “localizations” folder. NOTE! This is currently required to be exactly this – localizations (plural), not localization (singular). This will be where you put the localization files (e.g., english.csv, spanish.csv, etc.).
	~~## Create “localizations” folder: In the base plugin folder, create an “localizations” sub-folder (~~NOTE! This is currently required to be exactly this – localizations (plural), not localization (singular). This will be where you put the localization files (e.g., english.csv, spanish.csv, etc.).
	## Create Localization file(s): Localization files are CSV files following a particular format. These must have lines ending with LF not LF/NL, and they must reference the same <part_name> you use in the Part Production process below. There are some other restrictions for content, particularly that if you want a string that contains a “,” that string needs to be enclosed in quotes or the comma will mess with how the strings are parsed. These files are where the part’s Title, Subtitle, Manufacturer, and Description are configured. Here’s an example:<syntaxhighlight lang="text">		## Create Localization file(s): Localization files are CSV files following a particular format. These must have lines ending with LF not LF/NL, and they must reference the same <part_name> you use in the Part Production process below. There are some other restrictions for content, particularly that if you want a string that contains a “,” that string needs to be enclosed in quotes or the comma will mess with how the strings are parsed. These files are where the part’s Title, Subtitle, Manufacturer, and Description are configured. Here’s an example:<syntaxhighlight lang="text">
	Key,Type,Desc,English		Key,Type,Desc,English