Building the SPUM environment - soonsoon2/SPUM GitHub Wiki
Install Compatibility
1. Installation Environment SPUM is available in the Unity version below.
- Unity 2019.x and later stabilization version
- Unity 2020.x and later stabilization version
- Unity 2021. x and later stabilization version
- More recent stabilized versions
It may also be available in versions not described above, but may not be official support. If there is a problem using the installation above the latest version, please contact the manufacturer.
2. Usage Compatibility
SPUM supports the Unity Editor on the platform listed below.
- Windows Desktop & Mac Standalone
- WebGL Web
- Android & iOS Mobile
< It is compatible with many other platforms.>
However, it is officially used in the Editor environment of the platform, so it is not that SPUM’s editor function can be built and used as it is.
*. Most features of SPUM are available on the Unity Editor, and most features are not available after the build.
Setting an environment
- Install SPUM in Unity Editor *. This tutorial was created in the Mac environment, Unity 2021.3.14f1 version.
- In the Unity Editor, create a new project to install SPUM. If you are adding SPUM to an existing project, you do not need to create a new project.
- In the Unity Editor, enter [Windows – Package Manager].
- Press the ‘Packages’ button in the upper left corner to select ‘My Assets’ where you can view the list of my purchased assets.
- Select [2D Pixel Unit Maker – SPUM] from the purchase list. This activates the ‘Download’ button in the lower right. Press the ‘Download’ button to prepare for import.
- Once ‘Download’ is complete, you can add it to the Unity project through ‘Import’. Press the ‘Import’ button to add SPUM to the Unity project.
- When the ‘Import Unity Package’ window appears, check the resources to be added and press the ‘Import’ button in the lower right to proceed with the import process.
- Once added, you can check the SPUM folder and resources in Unity’s project folder as shown below.
- To use SPUM, you must run the [SPUM-Scene-SPUM_Scene] scene file. Open the scene.
- When you open ‘SPUM_Scene’, the object ‘SPUM_Manager’ is visible on the Hierarchy tab. When you select that object, you will see the warning message “You need to install SPUM Sprite Data by below install buttons” printed on the ‘SPUM_Manager’ component.
Press the ‘Install Resources Data’ button to install the initial resource environment required for SPUM use.
- SPUM resource installation is complete. Now, we need to check some things to use SPUM.
SPUM is available in 2D views. Therefore, we recommend that you click the “2D” tab in the thin window to set it to the 2D screen and use it.
To use SPUM, the required resources must be located within the [Assets-Resources-SPUM folder]. If these data are lost, it may not be possible to create and save characters correctly. You can identify the problem through the log messages in the SPUM_Manager or Unity Console window.