Difference between revisions of "Installing the kit"

From gamevanilla wiki
Jump to: navigation, search
(Running the game on mobile)
 
(9 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
== Create a new Unity project ==
 
== Create a new Unity project ==
  
Open Unity (you will need to use Unity 2019.3.7 or higher) and create a new 2D project:
+
Open Unity (you will need to use Unity 2020.3.20 LTS or higher) and create a new 2D project:
  
 
<span style="color:red">'''IMPORTANT:'''</span> We always make sure to keep our assets up-to-date so that they work with the latest versions of the engine. Unfortunately, sometimes certain Unity versions have bugs that are outside our control. We keep a list of these known issues [[Unity_compatibility| here]].
 
<span style="color:red">'''IMPORTANT:'''</span> We always make sure to keep our assets up-to-date so that they work with the latest versions of the engine. Unfortunately, sometimes certain Unity versions have bugs that are outside our control. We keep a list of these known issues [[Unity_compatibility| here]].
Line 12: Line 12:
 
== Import Puzzle Match Kit into your project ==
 
== Import Puzzle Match Kit into your project ==
  
Download and import the [https://www.assetstore.unity3d.com/#!/content/100199?aid=1100l3nzZ Puzzle Match Kit] asset into your project. If all goes well, you should not have any errors on the console and you should be able to run the game by opening the Home scene and clicking on the ''Play'' button. Make sure you have added all the scenes (located in the ''PuzzleMatchKit/Scenes'' folder) to your build settings:
+
Download and import the [https://assetstore.unity.com/packages/templates/systems/puzzle-match-kit-100199?aid=1100l3nzZ Puzzle Match Kit] asset into your project. If all goes well, you should not have any errors on the console and you should be able to run the game by opening the Home scene and clicking on the ''Play'' button. Make sure you have added all the scenes (located in the ''PuzzleMatchKit/Scenes'' folder) to your build settings:
  
 
https://wiki.gamevanilla.com/images/installation_build_settings.png
 
https://wiki.gamevanilla.com/images/installation_build_settings.png
  
Please note that the Home scene always needs to be the first scene you run and also the first scene in your build settings, as it contains the code that initializes the entire game.
+
Please note that the Home scene always needs to be the first scene you run and also the first scene in your build settings, as it contains the code that initializes the entire game. Also, please make sure you select a portrait aspect ratio in your ''Game'' tab of the Unity editor, as the game is designed around a portrait orientation.
  
== NOTE: Only if you are using Unity 2018.4.0 ==
+
== Running the game on mobile ==
  
We still provide a Unity 2018.4.0 download of the kit in case you are using Unity 2018 (but we recommend using Unity 2019 for new projects). If you are using the Unity 2018.4.0 version, please make sure to import the free Lean Tween and Full Serializer libraries before importing Candy Match 3 Kit into your Unity project. We explain how to do so here:
+
In order to run the game on a mobile device, you will need to be familiar with the process of generating a mobile build with Unity. Please refer to the official Unity documentation available here:
  
* Download and import the free [https://assetstore.unity.com/packages/tools/animation/leantween-3595?aid=1100l3nzZ LeanTween] asset into your project.
+
* [https://docs.unity3d.com/Manual/iphone-GettingStarted.html iOS]
* Download and import the free [https://github.com/jacobdufault/fullserializer Full Serializer] library into your project. Make sure you only import the ''Assets/FullSerializer/Source'' folder; importing the ''Assets/FullSerializer/Testing'' folder will result in compilation errors.
+
* [https://docs.unity3d.com/Manual/android.html Android].
  
'''This is NOT needed if you are using Unity 2019.'''
+
Please make sure you have enabled the Unity Ads service on your project as explained [https://www.wiki.gamevanilla.com/index.php?title=Monetization here] before generating the mobile build. Otherwise, you may face crashes at runtime due to a bug in the current version of the Unity Ads package.
  
 
|}
 
|}

Latest revision as of 11:46, 19 November 2021

Create a new Unity project

Open Unity (you will need to use Unity 2020.3.20 LTS or higher) and create a new 2D project:

IMPORTANT: We always make sure to keep our assets up-to-date so that they work with the latest versions of the engine. Unfortunately, sometimes certain Unity versions have bugs that are outside our control. We keep a list of these known issues here.

installation_new_project.png

Import Puzzle Match Kit into your project

Download and import the Puzzle Match Kit asset into your project. If all goes well, you should not have any errors on the console and you should be able to run the game by opening the Home scene and clicking on the Play button. Make sure you have added all the scenes (located in the PuzzleMatchKit/Scenes folder) to your build settings:

installation_build_settings.png

Please note that the Home scene always needs to be the first scene you run and also the first scene in your build settings, as it contains the code that initializes the entire game. Also, please make sure you select a portrait aspect ratio in your Game tab of the Unity editor, as the game is designed around a portrait orientation.

Running the game on mobile

In order to run the game on a mobile device, you will need to be familiar with the process of generating a mobile build with Unity. Please refer to the official Unity documentation available here:

Please make sure you have enabled the Unity Ads service on your project as explained here before generating the mobile build. Otherwise, you may face crashes at runtime due to a bug in the current version of the Unity Ads package.