Hello everyone! Mod support for UEBS is finally here! I figured what better place to post a tutorial than on the Unity forums! So lets get your Unity assets in the game!
Disclaimer:
The process of importing characters to UEBS will require some basic knowledge in using Unity engine. Besides a few important tips, I cannot teach you how to use Unity, there are thousands of tutorials and documentation available across the internet, so if you have no experience using Unity, or rigging characters in Unity, I suggest researching and get the hang of things before attempting to do any of this.
Getting Started:
The tools designed for preparing your character for import are designed to be fast and flexible. Setting up the basics can often only take minutes!
IMPORTANT: All separate mods must be done using a unique project! Please do not use any versions of Unity greater than 2018! In fact, using Unity 5.6 is ideal as the tutorial files were made in this version. Otherwise Unity can get confliction errors if multiple mods made in the same project are imported. This will cause and error during import and import will cancel! Please be responsible and make all your mods in unique projects!
Video Tutorial:
-
Start a new project in Unity, and import the UEBSCharacterSetup(Located in UEBSWorkshopTools) into your new project. If you have not yet downloaded the UEBSWorkshopTools, you can download them here: UEBSWorkshopTools.zip - Google Drive
-
Create a new scene and save it. Drag the âSETUPâ prefab into your scene. You should see a yellow box in your scene view which represents the collision box of your new character.
-
Import your rigged character into your scene(Legacy or Mecanim). Make your character the child of the âSETUPâ prefab by dragging the character onto it in the hierarchy.
-
Make sure your characters position is zeroed and its feet are lined up with the floor and center of the yellow box in the scene view.
-
In the Character Setup inspector, assign your Character Animator component from your rigged character (Or Character Animator Legacy, which only works with custom animations). You can do this by simply dragging your character from the hierarchy into the Character Animator tab.
-
Now the meshes from your character must be assigned. Click open the âMeshesâ drop down in the Character Setup inspector and assign all the appropriate skinned and solid meshes from your character.(If a mesh is skinned, the object will have a âSkinned Mesh Rendererâ attached to it, and if it is solid, it will have just the âMesh Rendererâ attached.
-
Set your mods name and category. Currently your character can only work in a category that exists in the game like Animals or Medieval. Keep in mind you must spell them correctly and the category names are case sensitive.
-
The basics of your character setup should now be ready for export. Click the small gear at the top of the âCharacter Setupâ inspector, and click âExport Allâ.
-
If there were no errors, your exported character should be located in your project folder above âAssetsâ.
-
Before you go and upload your character to Steam workshop, you should first test it. The easiest way to test your character mod, is by copying and pasting your exported character file to the StreamingAssets/CharacterMods folder located in the UEBS_Data folder which you can find in your steam apps folder. UEBS Steam app folder should be located in C:\Program Files (x86)\Steam\steamapps\common\Ultimate Epic Battle Simulator.
-
Once you have pasted your character mod to the CharacterMods folder, open the game and it should automatically import in startup.
Uploading To Steam Workshop:
Uploading to Steam Workshop is made easy with the UEBS Steam Workshop tools. Upload new packages and update old ones in minutes!
-
Create a folder in a location of your choosing and add your exported character to it.
-
IMPORTANT! All mods require an icon image for uploading to workshop. Take a screenshot of your character in the game, save your screen image and name it âiconâ in your content folder. The image file format should be png, and shouldnât be any larger than 512x512.
-
In your UEBS Workshop tools, open the folder called SteamManager and run the UEBS-SteamManager exe.
-
Once UEBS-SteamManager is running you need to specify the folder location of your content folder. The easiest way to do this is by going to your content folder in explorer and copying the directory location on the top into the UEBS-SteamManager.
-
Once you have put in the folder location, click âCreate New Modâ.
-
Fill in the mod name and description, and hit âUploadâ. Wait for your mod to finish uploading and close the application.
-
Your mod should now be published and a part of Steam Workshop!
