Main Page: Difference between revisions

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.

Getting started

If you're new to the mod editor, start here!

Information

Tutorials

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

Components

Components are blocks of logic that are added to Gameobjects to give them unique functionality.

Gameplay
General	Logic - Mover - Simple Animator
Minigame only	Item - AI Navigation Node - Player Spawn - Spawner - Trigger - Weapon
Board only	Board Space - Board Space Event
Rendering	Light - Line Renderer - Mesh Renderer - Particle System - Prop - Text - Water
Audio	Audio Source
Physics	Box Collider - Capsule Collider - Mesh Collider - Sphere Collider
Other	Transform - Prefab Instance - Note

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

Actions

Actions are used with gameplay components to perform tasks whenever an Event is fired.

Minigame Logic	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
Movement	Match Transform Action - Play Tween Animation Action - Position Action - Rotation Action - Scale Action
Visuals	Set Color Action - Set Player Visual Action - Spawn Effect Action - Show Message Action

@@ Line 1: / Line 1: @@
+__NOTOC__
 '''Welcome to the Pummel Party Mod Editor Documentation'''
 Using the Mod Editor you can create your own Minigames and Board Maps for Pummel Party.
+<div style="display: grid; grid-template-columns: 48% 50%; column-gap: 2%">
+<div>
+<div class="main-page-section">
 == Getting started ==
+If you're new to the mod editor, start here!
+=== Information ===
 *[[Introduction to the Mod Editor]]
-*[[Your First Minigame|Creating your first Minigame]]
-*[[Your First Board Map|Creating your first Board Map]]
 *[[Publishing to the Steam Workshop|Publishing your mod to the Steam Workshop]]
-== Importing Audio/Images/Models ==
+=== Tutorials ===
-*[[Importing Audio]]
+*[[Tutorials/Creating Your First Mod|Creating your first mod]]
-*[[Importing Images]]
+*[[Tutorials/Building A Board Mod|Building a board mod]]
-*[[Importing Models]]
+*[[Tutorials/Building A Minigame Mod|Building a minigame mod]]
+</div>
-== Mod Editor Components ==
+<div class="main-page-section">
-[[Component|Components]] are blocks of logic that added to [[Gameobject|gameobjects]] to give them unique functionality.
-* [[Transform Component]]
-* [[:Category:Gameplay Components|Gameplay Components]]
-* [[:Category:Rendering Components|Rendering Components]]
-* [[:Category:Physics Components|Physics Components]]
-* [[:Category:Audio Components|Audio Components]]
-== Mod Editor Assets ==
+==Mod Editor Windows==
-*[[Mesh Asset]]
+Learn about the different windows that make up the Mod Editor.
-*[[Texture Asset]]
+{| class="wikitable"
-*[[Audio Asset]]
+|-
-*[[Material]]
+| '''Primary Windows'''
-*[[Prefab]]
+| [[Hierarchy Window]] - [[Inspector Window]] - [[Scene View]] - [[Asset Browser]] - [[Log Window]]
+|-
+| '''Other Windows'''
+| [[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 class="main-page-section">
+== Components ==
+[[Component]]s are blocks of logic that are added to [[Gameobject]]s to give them unique functionality.
+{| class="wikitable"
+|-
+| '''[[:Category:Gameplay Components|Gameplay]]'''
+|-
+| style="padding-left: 2em;" |  '''General'''
+| [[Logic Component|Logic]] - [[Mover Component|Mover]] - [[Simple Animator Component|Simple Animator]]
+|-
+| style="padding-left: 2em;" |  '''Minigame only'''
+| [[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'''
+| [[Board Space Component|Board Space]] - [[Board Space Event Component|Board Space Event]]
+|-
+| '''[[:Category:Rendering Components|Rendering]]'''
+| [[Light Component|Light]] - [[Line Renderer Component|Line Renderer]] - [[Mesh Renderer Component|Mesh Renderer]] - [[Particle System Component|Particle System]] - [[Prop Component|Prop]] - [[Text Component|Text]] - [[Water Component|Water]]
+|-
+| '''[[:Category:Audio Components|Audio]]'''
+| [[Audio Source Component| Audio Source]]
+|-
+| '''[[:Category:Physics Components|Physics]]'''
+| [[Box Collider Component|Box Collider]] - [[Capsule Collider Component|Capsule Collider]] - [[Mesh Collider Component|Mesh Collider]] - [[Sphere Collider Component|Sphere Collider]]
+|-
+| '''Other'''
+| [[Transform Component|Transform]] - [[Prefab Instance Component|Prefab Instance]] - [[Note Component|Note]]
+|}
+</div>
+<div class="main-page-section">
+== Assets ==
+[[:Category:Assets|Assets]] are objects used in the creation of mods.
+{| class="wikitable"
+|-
+| '''Assets'''
+| [[Mesh Asset]] - [[Texture Asset]] - [[Audio Clip Asset]] - [[Material Asset]] - [[Prefab Asset]]
+|-
+| '''Importing Assets'''
+| [[Importing Audio]] - [[Importing Images]] - [[Importing Models]]
+|}
+</div>
+<div class="main-page-section">
+== Actions ==
+[[:Category:Actions|Actions]] are used with gameplay components to perform tasks whenever an [[Event]] is fired.
+{| class="wikitable"
+|-
+| '''Minigame Logic'''
+| [[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]]
+|-
+| '''Movement'''
+| [[Match Transform Action]] - [[Play Tween Animation Action]] - [[Position Action]] - [[Rotation Action]] - [[Scale Action]]
+|-
+| '''Visuals'''
+| [[Set Color Action]] - [[Set Player Visual Action]] - [[Spawn Effect Action]] - [[Show Message Action]]
+|-
+|}
+</div>
+</div>
+</div>