Difference between revisions of "Single Player CCG Kit Installing the kit"
(→Build the content) |
|||
(28 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 | + | Open Unity (you will need to use Unity 2020.2.1f1 or higher) and create a new 2D project: |
https://wiki.gamevanilla.com/images/single-player-ccg-kit/new-project.png | https://wiki.gamevanilla.com/images/single-player-ccg-kit/new-project.png | ||
Line 11: | Line 11: | ||
Download and import the free [https://assetstore.unity.com/packages/tools/animation/dotween-hotween-v2-27676?aid=1100l3nzZ DOTween] asset into your project. | Download and import the free [https://assetstore.unity.com/packages/tools/animation/dotween-hotween-v2-27676?aid=1100l3nzZ DOTween] asset into your project. | ||
+ | |||
+ | == Import TextMeshPro Essential Resources into your project == | ||
+ | |||
+ | Select the ''TextMeshPro/Import TMP Essential Resources'' option in the ''Window'' menu. This will make sure you can use TextMeshPro in your project. | ||
== Import Single-Player CCG Kit into your project == | == Import Single-Player CCG Kit into your project == | ||
− | Download and import the Single-Player CCG Kit asset into your project. | + | Download and import the Single-Player CCG Kit asset into your project. |
+ | |||
+ | '''Make sure you import the kit as a complete project and that you answer "yes" when asked if you want to include the package dependencies. This will automatically install the package dependencies required.''' | ||
+ | |||
+ | == Build the content == | ||
+ | |||
+ | The kit uses the new ''Addressables'' package in Unity to manage its dynamic resources. In order to be able to use the kit without any issues, you need to build the content before playing for the first time as follows: | ||
+ | |||
+ | * Open the ''Window/Asset Management/Addressables/Groups'' window and click on the ''Create Addressables Settings'' button. | ||
+ | * Select the ''Tools/Single-Player CCG Kit/Build content'' menu option (please note this is not the ''Tools'' option in the ''Addressables'' window, but the menu option in the Unity editor itself). | ||
+ | |||
+ | And that is it! | ||
+ | |||
+ | Please note that, when generating a build of the game (e.g., desktop, mobile) and by the way Addressables-based content works, you always need to make sure to build the content before generating the build. The content is platform-specific and therefore you need to build it for every platform you are interested in (i.e., it is not enough to build it just once). It is highly recommended that you get familiar with how [https://docs.unity3d.com/Manual/com.unity.addressables.html Addressables] work in Unity, as it introduces a more advanced workflow suitable for games with a lot of dynamically-loaded content like a single-player CCG. | ||
− | + | == Enable Fast Play Mode in the Unity editor == | |
− | + | This step is optional but, because the kit is compatible with the new '''Fast Play Mode''' available since Unity 2019.3, you should always enable it to get a blazing fast experience when pressing the Play button in the Unity editor. You can change this in your ''Project Settings'' (located in the ''Edit/Project Settings'' menu option). In the ''Editor'' section, toggle the '''Enter Play Mode Options (Experimental)''' flag on. | |
− | + | == Play == | |
− | + | 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 ''Game'' scene and clicking on the ''Play'' button. Make sure you have added all the scenes (located in the ''SinglePlayerCCGKit/Scenes'' folder) to your build settings if you want to build a player. | |
− | + | If you run into any issues during the process, please reach our [https://www.wiki.gamevanilla.com/index.php?title=Support support] and we will be happy to help. | |
|} | |} |
Latest revision as of 23:32, 15 June 2021
ContentsCreate a new Unity projectOpen Unity (you will need to use Unity 2020.2.1f1 or higher) and create a new 2D project:
Import DOTween into your projectDownload and import the free DOTween asset into your project. Import TextMeshPro Essential Resources into your projectSelect the TextMeshPro/Import TMP Essential Resources option in the Window menu. This will make sure you can use TextMeshPro in your project. Import Single-Player CCG Kit into your projectDownload and import the Single-Player CCG Kit asset into your project. Make sure you import the kit as a complete project and that you answer "yes" when asked if you want to include the package dependencies. This will automatically install the package dependencies required. Build the contentThe kit uses the new Addressables package in Unity to manage its dynamic resources. In order to be able to use the kit without any issues, you need to build the content before playing for the first time as follows:
And that is it! Please note that, when generating a build of the game (e.g., desktop, mobile) and by the way Addressables-based content works, you always need to make sure to build the content before generating the build. The content is platform-specific and therefore you need to build it for every platform you are interested in (i.e., it is not enough to build it just once). It is highly recommended that you get familiar with how Addressables work in Unity, as it introduces a more advanced workflow suitable for games with a lot of dynamically-loaded content like a single-player CCG. Enable Fast Play Mode in the Unity editorThis step is optional but, because the kit is compatible with the new Fast Play Mode available since Unity 2019.3, you should always enable it to get a blazing fast experience when pressing the Play button in the Unity editor. You can change this in your Project Settings (located in the Edit/Project Settings menu option). In the Editor section, toggle the Enter Play Mode Options (Experimental) flag on. PlayIf all goes well, you should not have any errors on the console and you should be able to run the game by opening the Game scene and clicking on the Play button. Make sure you have added all the scenes (located in the SinglePlayerCCGKit/Scenes folder) to your build settings if you want to build a player. If you run into any issues during the process, please reach our support and we will be happy to help. |