Home

3D-2D Sprite Tool

Welcome to the 3D-2D Sprite Tool wiki!

This wiki contains the documentation for the 3D-2D Sprite Tool for GameMaker.

Using the Tool

1. Load and configure a main model in the Model tab of the Main Pane:
   1. Select a main model file using the ellipsis ... and load it using the Import button.
   2. If needed, adjust the transform to position it in the Viewport.
   3. Configure the materials. Click each of the materials under Materials to load the correct texture images to use for them. Flip UVs if needed.
   4. Configure the lighting to use for the model. Under Ambient Light and Directional Lights, configure the ambient light and up to 8 directional lights.
2. Open the Attachments tab of the Main Pane to add attachments to the main model.
   For every attachment that you want to add:
   1. Click Add Attachment to add a new attachment to the list, then click the ellipsis ... under Settings to select and load the model file for the attachment.
   2. Adjust the attachment's transform relative to the main model or relative to the selected bone of the main model.
   3. Configure the materials in the same way as the main model.
3. If needed, adjust the animation frame rate in the Animation Player and deselect the frames that you want to exclude from the final animation.
4. Open the Export Options on the right of the tool:
   1. Set the sprite size that you want to use.
   2. Select the camera to use.
   3. Adjust the transform to keep the entire model within the chosen sprite size.
   4. Choose which parts of the model to export: only the main model, the main model with attachments or attachments only.
   5. Choose the number of rotations.
   6. Set the export file path by clicking the ellipsis ...
   7. Click Export to export all animations as image strips and wait for the tool to complete the export.
5. Import the generated images in GameMaker.

If you created a save file with the tool earlier, you can load that using File > Open in the Top Menu Bar. Save files store all required information and have a .json file extension. The original model files and texture images are stored together with the .json file.

Overview

This is the main interface of the 3D-2D tool:

Top Menu Bar

Here you can find the typical File menu. Under File you can create a new empty project, save the current one or load a saved project.

Main Pane

This is where you will spend most of your time configuring your models and lighting.

Viewport

Here you can navigate around the model and preview it from any angle. You can also change its position, rotation and scale using a transformation gizmo.

Animation Player

Here you will see every frame of the currently selected animation. You can also configure animation framerate and select which animation frames you would like to export.

Exporting from Blender

You may already have a model file, complete with textures and animations. If not, you can create or import a model in Blender and then export it for use with the Sprite Tool.

To learn more about preparing models for use with the Sprite Tool and exporting them, see Exporting From Blender.

Importing in GameMaker

Once you've generated image files with this tool you can import them in GameMaker.

Current limitations

• All models loaded need to have texture coordinates (i.e. be UV unwrapped) and have normal vectors because of the shaders currently used for rendering models and the vertex format specified in them.
• If you don't wish to use textures, use the Smart UV Project option in Blender to ensure the texture coordinates are there.
• There is also a limit of maximum bones that a model can have currently set to 128. If your model has more bones than that, it will not render correctly!