Main Page: Difference between revisions

From Pummel Party Mod Documentation
Jump to navigation Jump to search
No edit summary
 
m (→‎Actions: Added remove trophy action)
 
(61 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<strong>MediaWiki has been installed.</strong>
__NOTOC__
'''Welcome to the Pummel Party Mod Editor Documentation'''


Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.
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 ==
== Getting started ==
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
If you're new to the mod editor, start here!
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
=== Information ===
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ MediaWiki release mailing list]
*[[Introduction to the Mod Editor]]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
*[[Publishing to the Steam Workshop|Publishing your mod to the Steam Workshop]]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]
 
=== Tutorials ===
*[[Tutorials/Creating Your First Mod|Creating your first mod]]
*[[Tutorials/Building A Board Mod|Building a board mod]]
*[[Tutorials/Building A Minigame Mod|Building a minigame mod]]
</div>
 
<div class="main-page-section">
 
==Mod Editor Windows==
Learn about the different windows that make up the Mod Editor.
{| class="wikitable"
|-
| '''Primary Windows'''
| [[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>

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