Mod Validator: Difference between revisions

From Pummel Party Mod Documentation
Jump to navigation Jump to search
m (Added category)
mNo edit summary
 
Line 3: Line 3:


==Accessing the mod validator==
==Accessing the mod validator==
You can open the mod validator by selecting ''File > Validator Mod'' from the toolbar. The Mod validator will also appear if entering playmode while there are errors.
You can open the mod validator by selecting ''File > Validator Mod'' from the toolbar. The Mod validator will also appear if entering play mode while there are errors.


The mod validator can also be accessed from the [[Publishing to the Steam Workshop|publish window]] if there are any issues.
The mod validator can also be accessed from the [[Publishing to the Steam Workshop|publish window]] if there are any issues.
Line 10: Line 10:
Any errors are shown with a red exclamation mark. This type of issue must be fixed before the mod can be [[Publishing to the Steam Workshop|published]].  
Any errors are shown with a red exclamation mark. This type of issue must be fixed before the mod can be [[Publishing to the Steam Workshop|published]].  


Warnings are shown with a yellow exclamation mark. These issues could result in unexpected behavior, or are highly suggested changes to improve the mod quality. These are not required to publish the mod, but you should strongly consider resolving them.
Warnings are shown with a yellow exclamation mark. These issues could result in unexpected behaviour or are highly suggested changes to improve the mod quality. These are not required to publish the mod, but you should strongly consider resolving them.


Click on an issue to view a description or more information about it and how to resolve it. Some issues can be fixed automatically; in this case the "Fix Issue" button will be available.
Click on an issue to view a description or more information about it and how to resolve it. Some issues can be fixed automatically; in this case, the "Fix Issue" button will be available.


[[Category:Mod Editor Windows]]
[[Category:Mod Editor Windows]]

Latest revision as of 23:36, 15 December 2022

The mod validator on a board mod with issues that need to be fixed.

The Mod Validator window can display information about the validation state of the mod. Validation checks for any issues with the mod that should be resolved to improve the mod's playability. Mods are validated each time the mod is tested in play mode, each time the mod validator is opened, and before publishing to the workshop.

Accessing the mod validator

You can open the mod validator by selecting File > Validator Mod from the toolbar. The Mod validator will also appear if entering play mode while there are errors.

The mod validator can also be accessed from the publish window if there are any issues.

Understanding the mod validator window

Any errors are shown with a red exclamation mark. This type of issue must be fixed before the mod can be published.

Warnings are shown with a yellow exclamation mark. These issues could result in unexpected behaviour or are highly suggested changes to improve the mod quality. These are not required to publish the mod, but you should strongly consider resolving them.

Click on an issue to view a description or more information about it and how to resolve it. Some issues can be fixed automatically; in this case, the "Fix Issue" button will be available.