Skip to main content

Debug messages

Documentation: Pixel Character Creator 2D

Table of contents

In this section, we’ll go over all of the debug messages that you might receive, whilst creating your character. Some debug messages are harmless reminders that a specific action, such as saving your changes, needs to be taken. Other debug messages may indicate that there’s an underlying problem that needs to be taken care of before the creation process is continued.

6.1

Regular notifications

Upon opening the Pixel Character Creator 2D window you may notice a bar at the top of the window. Inside of that bar, you’ll find a white text with an icon next to it. This is a debug message that will notify you if a certain action is required, if something is wrong, or if certain settings aren’t set correctly. Below you can view all the possible debug messages as of version 1.0.0. You can expand the sections for more information about when these messages appear and how to resolve them.

Before we cover the warning and error messages, I’ll briefly show you the regular notifications that may pop up. These notifications are purely meant to inform you of the current status of your workflow with the Character Creator 2D and don’t require any action.

No errors detected!

This is the default message that’s shown if no errors or problems have been detected.

6.2

Warning messages

Warning messages don’t require a lot of urgency but are meant to remind you of something that you should probably do because it is recommended. It is possible to just ignore these warnings and continue your workflow. Error messages will still pop up because those messages are treated with a higher priority. Those notifications will temporarily overwrite the warning notifications until the errors are dealt with.

Unsaved changes detected!

If you make any changes to the character’s design without updating the character, this message will pop up. This isn’t indicative of a problem but is rather meant as a reminder that you should update the design of your character by pressing the “Save Changes & Update Character” button.

The selected Template Character is unnamed. For organizational purposes, giving your template a name is recommended.

If you see this message you have added and selected a Template Character Prefab without giving it a name. While this doesn’t break anything, I always recommend properly naming your templates to avoid confusion during your workflow. This warning message will disappear immediately as soon as the selected Template Character has been given a name.

Scriptable Object 'Saved Body Designs' is missing. This prevents saving and quick-selecting your designs from the Body Window!

This warning appears if you didn’t add a Saved Designs Database for the body to the Character Data Manager. All you have to do to fix this is click the white dot next to the empty Saved Designs Database field and select the proper database. If such a database doesn’t exist yet, you can create one by selecting Create > Game Between The Lines > Character Creator 2D > Database > Saved Designs Database. After doing so, give it a descriptive name so you know what its purpose is, and drag it into the empty Saved Designs Database field in the Character Data Manager. The warning message should now disappear.

Scriptable Object 'Saved Clothing Designs' is missing. This prevents saving and quick-selecting designs from the Clothing Window!

This warning message pops up if you haven’t added a Saved Designs Database for clothing to the Character Data Manager. To fix this, click the white dot next to the empty Saved Designs Database field and select the correct database. If such a database doesn’t exist, create a new one by selecting Create > Game Between The Lines > Character Creator 2D > Database > Saved Designs Database. Then, give it a descriptive name to avoid confusion about its purpose, and drag it into the empty slot in the Character Data Manager. This warning notification should have disappeared.

Scriptable Object 'Global Character Data' is missing. This causes unwanted behavior if you're using the Basic Dialogue System!

This message indicates that the ‘Global Character Data’ Scriptable Object inside of the Character Data Manager is missing. If you’re not using this Character Creator in conjunction with the Basic Dialogue System, this warning can be ignored. If you are using the Dialogue System, we need to fix this issue by adding a new ‘Global Character Data’ Scriptable Object. You can do so by selecting Create > Game Between The Lines > Character Creator 2D > Database > Global Character Data. Drag the newly created Scriptable Object into the empty slot and the warning message should go away.

6.3

Error messages

Error messages have a high priority and will often indicate that something is either missing or broken. It is almost always required to deal with these errors before you can continue with the creation process of your character. There are a lot of different errors that may pop up. Understanding what these messages mean will go a long way in helping you solve them and continue with your workflow.

Below you will find the most common error messages that you may encounter while working with the Pixel Character Creator 2D. If you found an error message and you are unsure of how to solve it, please view the list below first to see if your specific case is covered here. If you encountered an error that isn’t covered on this page, scroll down further for more instructions.

Database not found!

This message will appear in the following scenarios:

  • One or more of your Character Data Clusters have “Use Databases” set to “Both” but are missing a Character Segment Database and/or Character Color Database.
  • One or more of your Character Data Clusters have “Use Databases” set to “Segments” but are missing a Character Segment Database.
  • One or more of your Character Data Clusters have “Use Databases” set to “Colors” but are missing a Character Color Database.

This message can be resolved by checking all of your Character Data Clusters and viewing if you are missing a database or if the “Use Databases” field should be adjusted.

At least 1 database appears to be empty!

This message appears if one or more of the Character Data Clusters contains an empty database. This can either be an empty Segment Database or an empty Color Database. Double-check your databases to ensure that all of them include at least one option to pick from the Character Creator window.

At least 1 database contains a Segment or Color Group without a name!

This message appears if any of the Segment Databases or Color Databases contain a segment or color group without a name. Double-check your databases and ensure all selectable segments and colors have a name.

At least 1 invisible color was detected in a Color Group Database!

If you see this message pop up, odds are you recently made changes to one or more color groups. This message tells you that a fully transparent color (with alpha 0) was found within one of the Color Groups. This is an easy “mistake” to make because Unity gives all color fields a default alpha value of 0. Be sure to check whether your recently added colors all have an alpha value of 1. This problem may be patched in the future so the alpha is set to 1 by default upon adding a new color.

Scriptable Object 'Character Creator Depencies' is missing. This will cause unwanted behavior!

This message requires a quick but urgent fix. The Scriptable Object called “Character Creator Dependencies” is needed for the Character Creator 2D to work properly. This Scriptable Object holds data for visual elements such as icons and other GUI-related settings. To fix this error, navigate to the bottom of the Character Data Manager. There you will find a field called “Character Creator Dependencies”. If you click the white dot at the far right of that field you should be able to select a Scriptable Object called “Character Creator Dependencies” that’s given to you by default upon downloading the project. If for some reason no such object exists, I highly recommend reimporting the project.

Export settings currently include prefabs, but no template characters are assigned yet!

You’re seeing this message if you enable the “Export Character as Prefab” option in the Export Settings, but leave the list of Character Templates in the Character Data Manager empty. If you don’t want to export a prefab for your characters, you may ignore this error message and set “Export Character as Prefab” to false. If you do want to export prefabs, you’ll have to add at least one Character Template for your prefabs to use as a blueprint. In Chapter 4, you can read more about why this is necessary.

Export settings currently include prefabs, but at least one template character misses a prefab!

This message shows up when you create a Template Character without adding a prefab to it, whilst having the “Export Character as Prefab” variable in the Export Settings set to true. If you have no intention of exporting a prefab for your characters, feel free to ignore this error message and keep “Export Character as Prefab” set to false. If you do want to export prefabs, I recommend double-checking your Template Characters to find out which of those characters is causing the error to appear. If you add a prefab to all of your templates, the error should disappear.

Animation exports are enabled, but the selected Character Template Prefab lacks an Animator Component with clips!

If this message is shown, you have enabled the “Export Character Animations” option in the Export Settings while selecting a character template that doesn’t have an Animator Component. If you want to use a non-animated character as a template you can ignore this error message by disabling the “Export Character Animations” boolean in the Export Setting window. If you do want to export animations for your character, check your Character Template Prefab again to ensure it or one of its children contains an Animator Component with at least one animation clip.

Animation exports are enabled, but the selected Character Template Prefab has animations clips with missing sprites!

If this message is shown, you have enabled the “Export Character Animations” option in the Export Settings while selecting a character template that misses at least one sprite in one of its animations. If you want to use a non-animated character as a template you can ignore this error message by disabling the “Export Character Animations” boolean in the Export Setting window. If you do want to export animations for your character, check your Character Template Prefab again to ensure all associated animation clips contain sprites.

6.4

Found an undetected error?

If you found a problem that wasn’t caught by the Debug Section, you may have encountered a bug or triggered unintended behavior that’s yet to be covered by the Debug Section. In this case, I recommend reporting the problem on the contact page. There you can select this asset and specify the exact nature of your problem. If possible, I also encourage you to visualize the problem with a screenshot.