Setting up Unity: Difference between revisions

From KSP 2 Modding Wiki
VisualWikitext
(Updated KSP2UT install)
(Removed advice to only have one Unity project per mod.)
Line 8: Line 8:


== Initializing the Unity project ==
== Initializing the Unity project ==
As the Unity project is very large (~4 GB), we will use it for all our mods.
# Follow the instructions on this page: https://luxstice.notion.site/Creating-a-Unity-Project-dae1a51ab2a84fc4b5c5e1eeef4b90b3.
 
# Follow the instructions on this page : https://luxstice.notion.site/Creating-a-Unity-Project-dae1a51ab2a84fc4b5c5e1eeef4b90b3.


<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>
Line 49: Line 47:


# Go to '''Window>Package Manager''' and click on the '''+''' sign on the top left corner of the window that opens, after that click on '''Add Package from Git URL''' and paste <code><nowiki>https://github.com/KSP2Community/KSP2UnityTools.git</nowiki></code> and click Add.
# Go to '''Window>Package Manager''' and click on the '''+''' sign on the top left corner of the window that opens, after that click on '''Add Package from Git URL''' and paste <code><nowiki>https://github.com/KSP2Community/KSP2UnityTools.git</nowiki></code> and click Add.
 
If it's already installed, you'll need to delete the whole "KSP2UnityTools" folder from your Assets folder and then do the installation.
=== Other configurations ===
 
# In the project explorer, go to Assets > AddressablesAssetData > AssetGroups > Built In Data.
# In the Inspector window, click on “Inspect Top Level Settings”.
# Set the “Shader Bundle Naming Prefix” field to “Default Group GUID”.
 
<blockquote>Without this manipulation, Unity generates bundles with an ID calculated from the project name. Since we are using the same project for multiple mods, there will be a name conflict for the standard shader that Unity incorporates into all addressables. Using the GUID of the default group will help avoid collisions (you will need to remember to make the mod group the default group).</blockquote>
[[Category:Getting started]]
[[Category:Getting started]]

Revision as of 16:46, 29 October 2023

This page will help you install everything you need to work your on Unity.

Installing Unity

  1. Download Unity Hub. https://unity.com/download
  2. Download Unity 2022.3.5f1. https://unity.com/releases/editor/whats-new/2022.3.5
  3. Click on “Install this version with Unity Hub”.

Initializing the Unity project

  1. Follow the instructions on this page: https://luxstice.notion.site/Creating-a-Unity-Project-dae1a51ab2a84fc4b5c5e1eeef4b90b3.

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

Configure the Unity project

Installing the addressables package

Unity doesn’t come with this package natively, so we need to install it. Its easy!

  1. You start by going into Window>Package Manager on the top left area of Unity.
  2. This will open a new window where you can manage almost all the packages inside Unity.
  3. Go where it says Packages: In Project and change that to Unity Registry.
  4. On the search bar, look for Addressables. Select it and click install! It will show a couple pop-ups, and once its finished, it will show a green checkmark next to the Addressables’s version.

Importing ThunderKit

ThunderKit is a package for unity. but its instalation is a bit different from the usual.

  1. Go to Window>Package Manager and click on the + sign on the top left corner of the window that opens, after that click on Add Package from Git URL and paste https://github.com/PassivePicasso/ThunderKit.git and click Add.
  2. Download the latest version of ThunderKit Installer here : https://github.com/KSP2Community/ThunderKitInstaller/releases.
  3. Open the file with Unity Hub. When Unity opens, choose "Import" in the import window.
  4. Go to Tools>Thunderkit>Reinstall.
  5. The ThunderKit Settings window should open, if it doesn’t just go to Tools>Thunderkit>Settings on the top part of Unity.
  6. Go to Import Configuration and on Import Project Settings change the dropdown to Nothing.
  7. Go to ThunderKit Settings and on Locate and load game files for project click on Browse and select your main Kerbal Space Program 2 executable (KSP2_x64.exe).
  8. Click Import and wait for KSP2 to be imported, if asked click I made a backup, Go Ahead
  9. If Unity asks you to restart your project, click Restart Project
  10. To check if the game was correctly imported, select any game object and on the inspector click Add Component then search for Core Part Data.
Sometimes, the component wont appear right after the import, if so:
1. Go to your Project window on unity
2. Open the Packages tree view and scroll to KSP2_x64
3. Right click and select "Reimport" (DON’T SELECT REIMPORT ALL, it takes way longer)
4. Wait for the folder to be reimported, once finished you should be good to go

This also fixes if Unity looses track of KSP2’s components like so. If your components look like this, do the same shown above.

Importing Unity KSP tools

  1. Go to Window>Package Manager and click on the + sign on the top left corner of the window that opens, after that click on Add Package from Git URL and paste https://github.com/KSP2Community/KSP2UnityTools.git and click Add.
If it's already installed, you'll need to delete the whole "KSP2UnityTools" folder from your Assets folder and then do the installation.
Retrieved from "https://wiki.spacewarp.org/index.php?title=Setting_up_Unity&oldid=206"