Import 3D Models as Wrestlers

This tutorial shows how to use the Community Content Creation Package, Wrestler Creator and Content Pack Definition to import a humanoid 3D model as a wrestler into Casual Pro Wrestling.

Basic knowledge about using Unity is assumed. Please refer to the Unity Manual.

Video Tutorial

Step-By-Step Guide

1. Import your 3D model into Unity

Setup the Community Content Creation package as described in the Installation section. Then, import a 3D model using a standard Unity workflow.

Make sure of the following:

Your model must feature a Humanoid rig. Ensure that the bottom of the feet are on the ground (XZ) plane.
Your wrestler should roughly match the height of other wrestlers to make them work best with the game. The CPW Wrestler Studio scene template (found under File → New Scene in the Unity menu) contains reference models, which is best used in orthographic mode. Use the Scale Factor in the model importer to scale your model up or down, do not scale the Transform in the scene, it may cause strange behaviour of the ragdoll.
Make sure all the materials use the Universal Render Pipeline/Lit shader. Other shaders are not supported by the game as of now.

2. Setup the Wrestler Creator

Place your model in a scene. It is recommended to put it at the origin (0,0,0) with identity transform (no rotation, scale one).

Enter the wrestler's Name and Author in the inspector as they should appear in the game.

On the root object of the model (which also has the Animator component), add the Wrestler Creator component. This will create a new child object called Scanners, which contains several scanner objects. In the Scene view, these are indicated by (red or green) arrows and white selection handles. The arrows should point to selected points on the model's surface. Carefully place all scanners according to the instructions box that appears in the top left corner of the scene view.

The initial automatic placement is based on the model's rig and several heuristics. While it does save work, it can be very off for some scanners.

The more faithfully you place the scanners, the better your wrestler will work with the game. Don't rush it.

For more details tips, please refer to the Wrestler Creator reference page.

3. Create Body Description

Once you (and the automatic checker) are happy with the placement of the scanners, go to the Wrestler Creator component and click Create Body Description. This will create the Body Description component, which the game uses internally. You should see points appear all over the body (the result of the scanners) and – more prominently – boxes and cylinders around the main body parts, which define the wreslter's ragdoll.

Reiteration

If you find anything is not right after creating the body description (e.g., after playtesting), you can always reiterate. The scanners are still there, they have just been hidden.

Once you fixed your issues, click Replace Body Description.

If you want to start over with all scanners, you can also click Reset.

4. Create Prefab

Drag your object from the Hierarchy to the Project view to create a Prefab (technically, this will likely create a Prefab Variant, which is just fine).

5. Create a Content Pack Definition and Export

Create a Content Pack Definition from the Assets → Create → Casual Pro Wrestling → Content Pack Definition menu.

Enter the Display Name, Author and Description in the inspector as they should appear in the game (in the Content Screen). This can be the same information as for the wrestler.

Add your prefab from the previous step to the Wrestlers list and click Export. After a while, your operating system's file browser should open at the location where the content pack was saved. This should already be where the game needs it to be.

You need to save the current scene before Export works. This is a Unity limitation. It does not matter where you save it and you can safely delete it afterwards.

6. Create A Wrestler

Start the game and activate your Content Pack in the Content Screen.

Then, go to Create A Wrestler and find your imported wrestler in the list on the left and Edit to edit attributes, moves and entrance. Save and exit normally.

7. Ready to Go!

Go and let your wrestler have a match!

If you find anything off, consider reiterating. You can always export your content pack again; attributes, moves and other information will be retained.

You can share your Content Pack on the Steam Workshop the as any other.

Note that by the Steam Subscriber Agreement, it is your responsibility to make sure you hold the necessary rights to publish the content that you share.