Setting up Unity - Revision history

Dandoesstuff at 17:28, 16 November 2025

2025-11-16T17:28:30Z

← Older revision		Revision as of 19:28, 16 November 2025
Line 25:		Line 25:
	# After the process is finished, to check if the game was correctly imported, select or create any game object and in the inspector click '''Add Component''' and search for '''Core Part Data.'''		# After the process is finished, to check if the game was correctly imported, select or create any game object and in the inspector click '''Add Component''' and search for '''Core Part Data.'''
	# Once you've confirmed that Core Part Data is there, you now have to browse to '''Assets -> and find ImportKsp2ToEditor.'''		# Once you've confirmed that Core Part Data is there, you now have to browse to '''Assets -> and find ImportKsp2ToEditor.'''
	# ~~Copy~~ ImportKsp2ToEditor ~~to Assets~~, ~~and then~~ click on ~~that copy~~ and press '''Execute.'''		# Once you've found ImportKsp2ToEditor, click on it and press '''Execute.'''

	=== Creating a mod and setting up swinfo.json ===		=== Creating a mod and setting up swinfo.json ===

Dandoesstuff at 17:27, 16 November 2025

2025-11-16T17:27:50Z

← Older revision		Revision as of 19:27, 16 November 2025
Line 6:		Line 6:
	# Download Unity 2022.3.5f1 by clicking on the '''Install this version with Unity Hub''' link on this page: https://unity.com/releases/editor/whats-new/2022.3.5.		# Download Unity 2022.3.5f1 by clicking on the '''Install this version with Unity Hub''' link on this page: https://unity.com/releases/editor/whats-new/2022.3.5.
	# Download and install Git from https://git-scm.com/downloads.		# Download and install Git from https://git-scm.com/downloads.
	# Download/Clone the Redux.Template repo from https://github.com/KSP2Redux/Redux.Template		# Download/Clone/Use the Redux.Template repo from https://github.com/KSP2Redux/Redux.Template

	== Initializing the Unity project ==		== Initializing the Unity project ==

Dandoesstuff at 17:27, 16 November 2025

2025-11-16T17:27:24Z

← Older revision		Revision as of 19:27, 16 November 2025
Line 24:		Line 24:
	# If Unity asks you to restart your project, confirm it by clicking on '''Restart Project'''.		# If Unity asks you to restart your project, confirm it by clicking on '''Restart Project'''.
	# After the process is finished, to check if the game was correctly imported, select or create any game object and in the inspector click '''Add Component''' and search for '''Core Part Data.'''		# After the process is finished, to check if the game was correctly imported, select or create any game object and in the inspector click '''Add Component''' and search for '''Core Part Data.'''
	# Once you've confirmed that Core Part Data is there, you now have to browse to '''~~Packages -> KSP2 Unity Tools~~ -> and find ImportKsp2ToEditor.'''		# Once you've confirmed that Core Part Data is there, you now have to browse to '''Assets -> and find ImportKsp2ToEditor.'''
	# Copy ImportKsp2ToEditor to Assets, and then click on that copy and press '''Execute.'''		# Copy ImportKsp2ToEditor to Assets, and then click on that copy and press '''Execute.'''

Line 35:		Line 35:
	# You should now have a folder with your mod name with a swinfo asset, Pipelines folder and if you ticked Add Code to Mod, a Code folder.		# You should now have a folder with your mod name with a swinfo asset, Pipelines folder and if you ticked Add Code to Mod, a Code folder.
	# Setting up swinfo is simple. Select swinfo.asset and edit all the values to your liking.		# Setting up swinfo is simple. Select swinfo.asset and edit all the values to your liking.
	# Once you've finished your mod, you will have to export it. Select the mod in KSP2 Unity Tools and then click '''Deploy Selected Mods To Zip File.'''		# If you want to test your mod in the editor, navigate to KSP2 Unity Tools, select your mod and then click '''Test Selected Mods in Editor.'''
	# The mod will then be stored in the Redux.Template in a folder called "Deploy". ~~Place this folder in~~ the ~~"mods" folder and test out your mod in game~~.		# Once you've finished your mod and are ready to distribute it, you will have to export it. Select the mod in KSP2 Unity Tools and then click '''Deploy Selected Mods To Zip File.'''
			# The mod will then be stored in the Redux.Template in a folder called "Deploy". You will then have to share the zip on SpaceDock or whichever other websites you please.

	[[Category:Getting started]]		[[Category:Getting started]]

Dandoesstuff at 17:15, 16 November 2025

2025-11-16T17:15:56Z

← Older revision		Revision as of 19:15, 16 November 2025
Line 20:		Line 20:

	# The ''ThunderKit'' Settings window should open, if it doesn’t, just go to '''Tools>ThunderKit>Settings''' in the toolbar at the top of Unity.		# The ''ThunderKit'' Settings window should open, if it doesn’t, just go to '''Tools>ThunderKit>Settings''' in the toolbar at the top of Unity.
	# Go to '''ThunderKit Settings''' and in '''Locate and load game files for project,''' click on '''Browse''' and select your main Kerbal Space Program 2 executable found at <code><KSP2 root folder>/KSP2_x64.exe</code>.		# Go to '''ThunderKit Settings''' and in '''Locate and load game files for project,''' click on '''Browse''' and select your main Kerbal Space Program 2 executable found at <code><KSP2 root folder>/KSP2_x64.exe</code>. '''Note: This must be a Redux install of the game.'''
	# Click '''Import''' and wait for KSP2 to be imported. If asked, click '''I made a backup, Go Ahead'''.		# Click '''Import''' and wait for KSP2 to be imported. If asked, click '''I made a backup, Go Ahead'''.
	# If Unity asks you to restart your project, confirm it by clicking on '''Restart Project'''.		# If Unity asks you to restart your project, confirm it by clicking on '''Restart Project'''.

Dandoesstuff: Update to instead use the Redux Template

2025-11-16T17:13:02Z

Update to instead use the Redux Template

← Older revision		Revision as of 19:13, 16 November 2025
Line 6:		Line 6:
	# Download Unity 2022.3.5f1 by clicking on the '''Install this version with Unity Hub''' link on this page: https://unity.com/releases/editor/whats-new/2022.3.5.		# Download Unity 2022.3.5f1 by clicking on the '''Install this version with Unity Hub''' link on this page: https://unity.com/releases/editor/whats-new/2022.3.5.
	# Download and install Git from https://git-scm.com/downloads.		# Download and install Git from https://git-scm.com/downloads.
			# Download/Clone the Redux.Template repo from https://github.com/KSP2Redux/Redux.Template

	== Initializing the Unity project ==		== Initializing the Unity project ==
	# Open '''Unity Hub'''.		# Open '''Unity Hub'''.
	# Click on '''~~New Project~~''' at the top right of the window.		# Click on '''Add''' at the top right of the window.
	# ~~At the top of the new interface, set the~~ '''~~Editor Version''' to <code>2022.3.5f1</code>. You can keep the~~ project ~~template set to '''3D (Core)'''~~.		# Click on '''Add project from disk.'''
	~~# Set the '''Project name~~'''~~, it can be whatever you want, for example <code>MyModId.Unity</code>.~~		# Select the Redux template you downloaded.
	# ~~Set~~ the ~~'''Location''' to the folder~~ you ~~want the Unity project to be saved in.~~
	~~# Click '''Create project'''~~.

	== Configuring the Unity project ==		== Configuring the Unity project ==

	=== ~~Installing the Addressables package~~ ===		=== Configuring ThunderKit ===
	Unity ~~doesn’t come with this package natively, so~~ we ~~need~~ to ~~install it first:~~		''ThunderKit'' is a package for Unity which we use to import the game's components into the Unity editor. This is included with the Redux Template

	~~# Open the Package Manager by clicking '''Window>Package Manager''' in the toolbar at the top of Unity.~~
	~~# This will open a new window where you can manage most of the packages in your project.~~
	~~# Go where it says '''Packages: In Project''' and change that to '''Unity Registry'''.~~
	# In the search bar, look for '''Addressables'''. Select it and click '''Install'''. It will show a couple pop-ups, and once it is finished, it will show a green checkmark next to the '''Addressables''' package version.

	~~=== Installing ThunderKit ===~~
	''ThunderKit'' is a package for Unity which we use to import the game's components into the Unity editor. However, it is not hosted in the official Unity package repository and needs to be installed directly from its GitHub repository.

	# Go to '''Window>Package Manager''' and click on the '''+''' sign in the top left corner of the window that opens, after that click on '''Add Package from Git URL''', paste <code>https://github.com/PassivePicasso/ThunderKit.git</code> and click '''Add'''.
	# The ''ThunderKit'' Settings window should open, if it doesn’t, just go to '''Tools>ThunderKit>Settings''' in the toolbar at the top of Unity.		# The ''ThunderKit'' Settings window should open, if it doesn’t, just go to '''Tools>ThunderKit>Settings''' in the toolbar at the top of Unity.
	~~# Go to '''Import Configuration''' and in '''Import Project Settings,''' change the dropdown value to '''Everything.'''~~
	# Go to '''ThunderKit Settings''' and in '''Locate and load game files for project,''' click on '''Browse''' and select your main Kerbal Space Program 2 executable found at <code><KSP2 root folder>/KSP2_x64.exe</code>.		# Go to '''ThunderKit Settings''' and in '''Locate and load game files for project,''' click on '''Browse''' and select your main Kerbal Space Program 2 executable found at <code><KSP2 root folder>/KSP2_x64.exe</code>.
	# Click '''Import''' and wait for KSP2 to be imported. If asked, click '''I made a backup, Go Ahead'''.		# Click '''Import''' and wait for KSP2 to be imported. If asked, click '''I made a backup, Go Ahead'''.
	# If Unity asks you to restart your project, confirm it by clicking on '''Restart Project'''.		# If Unity asks you to restart your project, confirm it by clicking on '''Restart Project'''.
	# After the process is finished, to check if the game was correctly imported, select or create any game object and in the inspector click '''Add Component''' and search for '''Core Part Data'''.		# After the process is finished, to check if the game was correctly imported, select or create any game object and in the inspector click '''Add Component''' and search for '''Core Part Data.'''
			# Once you've confirmed that Core Part Data is there, you now have to browse to '''Packages -> KSP2 Unity Tools -> and find ImportKsp2ToEditor.'''
	~~=== Installing KSP2 Unity Tools ===~~		# Copy ImportKsp2ToEditor to Assets, and then click on that copy and press '''Execute.'''

	# Go to '''~~Window~~>~~Package Manager~~''' and click on ~~the '''+''' sign in the top left corner of the window~~ that ~~opens, after that click on '''Add Package from Git URL~~'''~~, paste <code>https://github.com/KSP2Community/KSP2UnityTools~~.~~git</code> and click '''Add~~'''.
	If you have previously installed an older version of KSP2 Unity Tools manually from a .unitypackage file, you will need to delete the whole "KSP2UnityTools" folder from your Assets folder and then do the installation.

	=== ~~Setting~~ up swinfo.json ~~and addressables~~ ===		=== Creating a mod and setting up swinfo.json ===

	# ~~After installing KSP2UnityTools, go~~ to '''~~Tools~~>KSP2 Unity Tools.'''		# Go to '''Modding>KSP2 Unity Tools.'''
	# ~~Follow one of two following steps, depending on which applies for you:~~		# Click Create Mod
	# ~~'''If~~ you ~~have~~ a mod ~~you want to copy addressables into''':~~		# Give the mod a ModId and if you want a small code template in your mod, click '''Add Code to Mod.'''
	~~## Set '''Build Mode~~''' to "'''~~Copy Assets Only'''"~~.		# Click Create.
	#~~# In the build path select the <code>addressables</code>~~ folder in your mod~~'s directory~~.		# You should now have a folder with your mod name with a swinfo asset, Pipelines folder and if you ticked Add Code to Mod, a Code folder.
	#~~# At the bottom of the window, press '''Import~~ swinfo.~~json'''~~ and ~~select~~ your ~~mod's <code>swinfo.json</code>~~.		# Setting up swinfo is simple. Select swinfo.asset and edit all the values to your liking.
	# '~~''If~~ you ~~want~~ to ~~build a full~~ mod ~~from~~ Unity''':		# Once you've finished your mod, you will have to export it. Select the mod in KSP2 Unity Tools and then click '''Deploy Selected Mods To Zip File.'''
	~~## Set '''Build Mode''' to "'''Everything~~'''".		# The mod will then be stored in the Redux.Template in a folder called "Deploy". Place this folder in the "mods" folder and test out your mod in game.
	#~~# Set build path to where you want to output your packaged~~ mod ~~(you can set this later, just set it before build).~~
	~~## If you already have a swinfo.json file, you can skip the next steps using~~ the ~~import swinfo~~.~~json button as described~~ in ~~the previous section~~.
	~~## Input your mod's ID (~~this ~~is critically important).~~
	~~## Setup~~ the ~~rest of~~ your mod~~'s info (these correspond to the swinfo).~~
	~~# After following one of the previous two processes, press '''Set Up Addressables From Mod Info''', and it should automatically set up the addressables groups for you~~.

	[[Category:Getting started]]		[[Category:Getting started]]

Munix: Removed link to Lux's Notion (broken)

2025-10-15T21:47:20Z

Removed link to Lux's Notion (broken)

← Older revision		Revision as of 23:47, 15 October 2025
Line 11:		Line 11:
	# Click on '''New Project''' at the top right of the window.		# Click on '''New Project''' at the top right of the window.
	# At the top of the new interface, set the '''Editor Version''' to <code>2022.3.5f1</code>. You can keep the project template set to '''3D (Core)'''.		# At the top of the new interface, set the '''Editor Version''' to <code>2022.3.5f1</code>. You can keep the project template set to '''3D (Core)'''.
	# Set the '''Project name''', it can be whatever you want ~~like~~ for example <code>MyModId.Unity</code>.		# Set the '''Project name''', it can be whatever you want, for example <code>MyModId.Unity</code>.
	# Set the '''Location''' to the folder you want the Unity project to be saved in.		# Set the '''Location''' to the folder you want the Unity project to be saved in.
	# Click '''Create project'''.		# Click '''Create project'''.

	~~<blockquote>For a quick presentation of the Unity interface: https://luxstice.notion.site/Learning-Unity-faf0ab10f24c4925bf4b51a997a41666.</blockquote>~~

	== Configuring the Unity project ==		== Configuring the Unity project ==

KiwiShark: 21 revisions imported

2024-10-09T16:46:01Z

21 revisions imported

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

Spacewarp>Safarte: Unity project creation instructions and page cleanup

2024-02-21T07:58:37Z

Unity project creation instructions and page cleanup

← Older revision		Revision as of 09:58, 21 February 2024
Line 8:		Line 8:

	== Initializing the Unity project ==		== Initializing the Unity project ==
	# ~~Follow~~ the ~~instructions on this page: https:~~/~~/luxstice~~.~~notion~~.~~site/Creating-a-Unity-~~Project~~-dae1a51ab2a84fc4b5c5e1eeef4b90b3 but use~~ Unity ~~2022~~.3.~~5f1 instead~~.		# Open '''Unity Hub'''.
			# Click on '''New Project''' at the top right of the window.
			# At the top of the new interface, set the '''Editor Version''' to <code>2022.3.5f1</code>. You can keep the project template set to '''3D (Core)'''.
			# Set the '''Project name''', it can be whatever you want like for example <code>MyModId.Unity</code>.
			# Set the '''Location''' to the folder you want the Unity project to be saved in.
			# Click '''Create project'''.

	<blockquote>For a quick presentation of the Unity interface: https://luxstice.notion.site/Learning-Unity-faf0ab10f24c4925bf4b51a997a41666.</blockquote>		<blockquote>For a quick presentation of the Unity interface: https://luxstice.notion.site/Learning-Unity-faf0ab10f24c4925bf4b51a997a41666.</blockquote>

	== ~~Configure~~ the Unity project ==		== Configuring the Unity project ==

	=== Installing the Addressables package ===		=== Installing the Addressables package ===
Line 19:		Line 24:
	# Open the Package Manager by clicking '''Window>Package Manager''' in the toolbar at the top of Unity.		# Open the Package Manager by clicking '''Window>Package Manager''' in the toolbar at the top of Unity.
	# This will open a new window where you can manage most of the packages in your project.		# This will open a new window where you can manage most of the packages in your project.
	# Go where it says '''Packages: In Project''' and change that to '''Unity Registry.'''		# Go where it says '''Packages: In Project''' and change that to '''Unity Registry'''.
	# In the search bar, look for '''Addressables'''. Select it and click '''Install'''. It will show a couple pop-ups, and once it is finished, it will show a green checkmark next to the Addressables package version.		# In the search bar, look for '''Addressables'''. Select it and click '''Install'''. It will show a couple pop-ups, and once it is finished, it will show a green checkmark next to the '''Addressables''' package version.

	=== Installing ThunderKit ===		=== Installing ThunderKit ===
	ThunderKit is a package for Unity, ~~however~~ it is not hosted in the official Unity package repository~~, so it~~ needs to be installed directly from its GitHub repository.		''ThunderKit'' is a package for Unity which we use to import the game's components into the Unity editor. However, it is not hosted in the official Unity package repository and needs to be installed directly from its GitHub repository.

	# Go to '''Window>Package Manager''' and click on the '''+''' sign in the top left corner of the window that opens, after that click on '''Add Package from Git URL''' ~~and~~ paste <code>https://github.com/PassivePicasso/ThunderKit.git</code> and click '''Add'''.		# Go to '''Window>Package Manager''' and click on the '''+''' sign in the top left corner of the window that opens, after that click on '''Add Package from Git URL''', paste <code>https://github.com/PassivePicasso/ThunderKit.git</code> and click '''Add'''.
	#		# The ''ThunderKit'' Settings window should open, if it doesn’t, just go to '''Tools>ThunderKit>Settings''' in the toolbar at the top of Unity.
	# The ThunderKit Settings window should open, if it doesn’t, just go to '''Tools>ThunderKit>Settings''' in the toolbar at the top of Unity.
	# Go to '''Import Configuration''' and in '''Import Project Settings,''' change the dropdown value to '''Everything.'''		# Go to '''Import Configuration''' and in '''Import Project Settings,''' change the dropdown value to '''Everything.'''
	# Go to '''ThunderKit Settings''' and in '''Locate and load game files for project,''' click on '''Browse''' and select your main Kerbal Space Program 2 executable ~~('''~~KSP2_x64.exe~~''')~~.		# Go to '''ThunderKit Settings''' and in '''Locate and load game files for project,''' click on '''Browse''' and select your main Kerbal Space Program 2 executable found at <code><KSP2 root folder>/KSP2_x64.exe</code>.
	# Click '''Import''' and wait for KSP2 to be imported. If asked, click '''I made a backup, Go Ahead.'''		# Click '''Import''' and wait for KSP2 to be imported. If asked, click '''I made a backup, Go Ahead'''.
	# If Unity asks you to restart your project, confirm it by clicking on '''Restart Project'''.		# If Unity asks you to restart your project, confirm it by clicking on '''Restart Project'''.
	# After the process is finished, to check if the game was correctly imported, select or create any game object, and in the inspector click '''Add Component''' and search for '''Core Part Data'''.		# After the process is finished, to check if the game was correctly imported, select or create any game object and in the inspector click '''Add Component''' and search for '''Core Part Data'''.

	=== Installing KSP2 Unity Tools ===		=== Installing KSP2 Unity Tools ===

	# Go to '''Window>Package Manager''' and click on the '''+''' sign in the top left corner of the window that opens, after that click on '''Add Package from Git URL''', paste <code~~><nowiki~~>https://github.com/KSP2Community/KSP2UnityTools.git~~</nowiki>~~</code> and click '''Add'''.		# Go to '''Window>Package Manager''' and click on the '''+''' sign in the top left corner of the window that opens, after that click on '''Add Package from Git URL''', paste <code>https://github.com/KSP2Community/KSP2UnityTools.git</code> and click '''Add'''.
	If you have previously installed an older version of KSP2 Unity Tools manually from a .unitypackage file, you will need to delete the whole "KSP2UnityTools" folder from your Assets folder and then do the installation.		If you have previously installed an older version of KSP2 Unity Tools manually from a .unitypackage file, you will need to delete the whole "KSP2UnityTools" folder from your Assets folder and then do the installation.

Line 44:		Line 48:
	# Follow one of two following steps, depending on which applies for you:		# Follow one of two following steps, depending on which applies for you:
	# '''If you have a mod you want to copy addressables into''':		# '''If you have a mod you want to copy addressables into''':
	## ~~Select "Copy Assets Only" as the~~ '''Build Mode'''.		## Set '''Build Mode''' to "'''Copy Assets Only'''".
	## In the build path select the addressables ~~for~~ your mod.		## In the build path select the <code>addressables</code> folder in your mod's directory.
	## At the bottom of the window, press '''Import swinfo.json''' and select your ~~mods~~ swinfo.json.		## At the bottom of the window, press '''Import swinfo.json''' and select your mod's <code>swinfo.json</code>.
	# '''If you want to build a full mod from Unity''':		# '''If you want to build a full mod from Unity''':
	## Set '''Build Mode''' to "Everything".		## Set '''Build Mode''' to "'''Everything'''".
	## Set build path to where you want to output your packaged mod (you can set this later, just set it before build).		## Set build path to where you want to output your packaged mod (you can set this later, just set it before build).
	## If you already have a swinfo.json file, you can skip the next steps using the import swinfo.json button as described in the previous section.		## If you already have a swinfo.json file, you can skip the next steps using the import swinfo.json button as described in the previous section.

Spacewarp>Munix: /* Importing Unity KSP tools */

2024-02-20T03:38:29Z

Importing Unity KSP tools

← Older revision		Revision as of 05:38, 20 February 2024
Line 14:		Line 14:
	== Configure the Unity project ==		== Configure the Unity project ==

	=== Installing the ~~addressables~~ package ===		=== Installing the Addressables package ===
	Unity doesn’t come with this package natively, so we need to install it first:		Unity doesn’t come with this package natively, so we need to install it first:

Line 22:		Line 22:
	# In the search bar, look for '''Addressables'''. Select it and click '''Install'''. It will show a couple pop-ups, and once it is finished, it will show a green checkmark next to the Addressables package version.		# In the search bar, look for '''Addressables'''. Select it and click '''Install'''. It will show a couple pop-ups, and once it is finished, it will show a green checkmark next to the Addressables package version.

	=== ~~Importing~~ ThunderKit ===		=== Installing ThunderKit ===
	ThunderKit is a package for Unity, however it is not hosted in the official Unity package repository, so it needs to be installed directly from its GitHub repository.		ThunderKit is a package for Unity, however it is not hosted in the official Unity package repository, so it needs to be installed directly from its GitHub repository.

Line 34:		Line 34:
	# After the process is finished, to check if the game was correctly imported, select or create any game object, and in the inspector click '''Add Component''' and search for '''Core Part Data'''.		# After the process is finished, to check if the game was correctly imported, select or create any game object, and in the inspector click '''Add Component''' and search for '''Core Part Data'''.

	=== ~~Importing~~ Unity ~~KSP tools~~ ===		=== Installing KSP2 Unity Tools ===

	# Go to '''Window>Package Manager''' and click on the '''+''' sign in the top left corner of the window that opens, after that click on '''Add Package from Git URL''', paste <code><nowiki>https://github.com/KSP2Community/KSP2UnityTools.git</nowiki></code> and click '''Add'''.		# Go to '''Window>Package Manager''' and click on the '''+''' sign in the top left corner of the window that opens, after that click on '''Add Package from Git URL''', paste <code><nowiki>https://github.com/KSP2Community/KSP2UnityTools.git</nowiki></code> and click '''Add'''.

Spacewarp>Munix: /* Installing Unity */

2024-02-01T12:27:13Z

Installing Unity

← Older revision		Revision as of 14:27, 1 February 2024
Line 5:		Line 5:
	# Download Unity Hub from https://unity.com/download.		# Download Unity Hub from https://unity.com/download.
	# Download Unity 2022.3.5f1 by clicking on the '''Install this version with Unity Hub''' link on this page: https://unity.com/releases/editor/whats-new/2022.3.5.		# Download Unity 2022.3.5f1 by clicking on the '''Install this version with Unity Hub''' link on this page: https://unity.com/releases/editor/whats-new/2022.3.5.
			# Download and install Git from https://git-scm.com/downloads.

	== Initializing the Unity project ==		== Initializing the Unity project ==