Main Page: Difference between revisions

From Pummel Party Mod Documentation
Jump to navigation Jump to search
(Updated layout)
m (→‎Actions: Added remove trophy action)
 
(25 intermediate revisions by 2 users not shown)
Line 5: Line 5:


<div style="display: grid; grid-template-columns: 48% 50%; column-gap: 2%">
<div style="display: grid; grid-template-columns: 48% 50%; column-gap: 2%">
<div >
<div>
<div style="border-left: 1px solid black; background-color:#edf1f7; padding: 0.5em 1em; margin-bottom: 1em">
<div class="main-page-section">
== Getting started ==
== Getting started ==
If you're new to the mod editor, start here!
=== Information ===
=== Information ===
*[[Introduction to the Mod Editor]]
*[[Introduction to the Mod Editor]]
Line 18: Line 19:
</div>
</div>


<div style="border-left: 1px solid black; background-color:#edf1f7; padding: 0.5em 1em; margin-bottom: 1em">
<div class="main-page-section">
 
==Mod Editor Windows==
==Mod Editor Windows==
Learn about the different windows that make up the Mod Editor.
Learn about the different windows that make up the Mod Editor.
Line 27: Line 29:
|-
|-
| '''Other Windows'''
| '''Other Windows'''
| [[Mod Validator|Mod Validator Window]] - [[Publishing to the Steam Workshop|Publish Window]] - [[Published Mods Window]]
| [[Action Editor]] - [[Mod Validator|Mod Validator Window]] - [[Publishing to the Steam Workshop|Publish Window]] - [[Published Mods Window]]
|-
|-
|}
|}
</div>
<div class="main-page-section">
==Other Concepts==
These are some other miscellaneous concepts that are useful to know when creating mods.
'''General'''
* [[Mod Settings|Adjusting Mod Settings]]
* [[Unlocked Mod|Marking a published mod as Unlocked]]
* [[Mod Editor Shortcuts]]
'''Advanced'''
* [[Custom Board Space|Creating Custom Board Spaces]]
* [[Lighting Settings]]
* [[Screen Effects]]
</div>
</div>
</div>
</div>


<div>
<div>
<div style="border-left: 1px solid black; background-color:#edf1f7; padding: 0.5em 1em; margin-bottom: 1em">
<div class="main-page-section">
== Mod Editor Components ==  
 
[[Component|Components]] are blocks of logic that added to [[Gameobject|gameobjects]] to give them unique functionality.
== Components ==  
[[Component]]s are blocks of logic that are added to [[Gameobject]]s to give them unique functionality.
{| class="wikitable"
{| class="wikitable"
|-
|-
Line 42: Line 61:
|-
|-
| style="padding-left: 2em;" |  '''General'''
| style="padding-left: 2em;" |  '''General'''
| [[Mover Component|Mover]] - [[Simple Animator Component|Simple Animator]]  
| [[Logic Component|Logic]] - [[Mover Component|Mover]] - [[Simple Animator Component|Simple Animator]]
|-
|-
| style="padding-left: 2em;" |  '''Minigame only'''
| style="padding-left: 2em;" |  '''Minigame only'''
| [[Item Component|Item]] - [[AI Navigation Node Component|AI Navigation Node]] - [[Logic Component|Logic]] - [[Player Spawn Component|Player Spawn]] - [[Spawner Component|Spawner]] - [[Trigger Component|Trigger]] - [[Weapon Component|Weapon]]
| [[Item Component|Item]] - [[AI Navigation Node Component|AI Navigation Node]] - [[Player Spawn Component|Player Spawn]] - [[Spawner Component|Spawner]] - [[Trigger Component|Trigger]] - [[Weapon Component|Weapon]]
|-
|-
| style="padding-left: 2em;" |  '''Board only'''
| style="padding-left: 2em;" |  '''Board only'''
Line 64: Line 83:
</div>
</div>


<div style="border-left: 1px solid black; background-color:#edf1f7; padding: 0.5em 1em; margin-bottom: 1em">
<div class="main-page-section">
== Mod Editor Assets ==  
 
== Assets ==  
[[:Category:Assets|Assets]] are objects used in the creation of mods.
[[:Category:Assets|Assets]] are objects used in the creation of mods.
{| class="wikitable"
{| class="wikitable"
Line 77: Line 97:
</div>
</div>


<div style="border-left: 1px solid black; background-color:#edf1f7; padding: 0.5em 1em; margin-bottom: 1em">
<div class="main-page-section">
 
== Actions ==  
== Actions ==  
[[:Category:Actions|Actions]] are used with gameplay components to perform tasks whenever an event is fired.
[[:Category:Actions|Actions]] are used with gameplay components to perform tasks whenever an [[Event]] is fired.
{| class="wikitable"
{| class="wikitable"
|-
|-
| '''General'''
| '''Minigame Logic'''
|[[Change Score Action]] - [[Kill Action]] - [[Play Sound Action]] - [[Play Tween Animation Action]] - [[Position Action]] - [[Rotation Action]] - [[Scale Action]] - [[Set Active Action]] - [[Set Color Action]] - [[Show Message Action]] - [[Spawn Effect Action]] - [[Spawn Prefab Action]] - [[Wait Action]]
| [[Change Health Action]] - [[Change Player Velocity Action]] - [[Change Score Action]] - [[Drop Minigame Item Action]] - [[Give Minigame Item Action]] - [[Modify Player Action]] - [[Set Gravity Action]] - [[Set Placement Action]] - [[Stun Player Action]]
|-
| '''Board Logic'''
| [[Display Popup Action]] - [[Damage Player Action]] - [[Drop Keys Action]] - [[Give Item Action]] - [[Give Keys Action]] - [[Give Trophy Action]] - [[Heal Player Action]] - [[Move To Space Action]] - [[Remove Trophy Action]] - [[Set Board Space Active Action]] - [[Set Connection Active Action]] - [[Spawn Keys Action]]
|-
| '''Utility'''
|[[Kill Action]] - [[Play Sound Action]] - [[Set Active Action]] - [[Spawn Prefab Action]] - [[Wait Action]]
|-
|-
| '''Minigame only'''
| '''Movement'''
| [[Change Health Action]] - [[Change Player Velocity Action]] - [[Give Minigame Item Action]] - [[Modify Player Action]] - [[Set Gravity Action]] - [[Set Placement Action]] - [[Stun Player Action]]
| [[Match Transform Action]] - [[Play Tween Animation Action]] - [[Position Action]] - [[Rotation Action]] - [[Scale Action]]
|-
|-
| '''Board only'''
| '''Visuals'''
| [[Damage Player Action]] - [[Drop Keys Action]] - [[Give Item Action]] - [[Give Keys Action]] - [[Give Trophy Action]] - [[Heal Player Action]] - [[Move To Space Action]] - [[Spawn Keys Action]]
| [[Set Color Action]] - [[Set Player Visual Action]] - [[Spawn Effect Action]] - [[Show Message Action]]
|-
|-
|}
|}

Latest revision as of 20:15, 17 December 2023

Welcome to the Pummel Party Mod Editor Documentation

Using the Mod Editor you can create your own Minigames and Board Maps for Pummel Party.

Mod Editor Windows

Learn about the different windows that make up the Mod Editor.

Primary Windows Hierarchy Window - Inspector Window - Scene View - Asset Browser - Log Window
Other Windows Action Editor - Mod Validator Window - Publish Window - Published Mods Window

Other Concepts

These are some other miscellaneous concepts that are useful to know when creating mods.

General

Advanced

Assets

Assets are objects used in the creation of mods.

Assets Mesh Asset - Texture Asset - Audio Clip Asset - Material Asset - Prefab Asset
Importing Assets Importing Audio - Importing Images - Importing Models