Your First Minigame: Difference between revisions

From Pummel Party Mod Documentation
Jump to navigation Jump to search
(Created page with "== Accessing The Mod Editor == To follow along with this tutorial you'll need to be in the Pummel Party Mod Editor. If you don't know how to open it read this. == Creating an empty Minigame ==")
 
(Added more content)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Accessing The Mod Editor ==
== Accessing the Mod Editor ==
To follow along with this tutorial you'll need to be in the Pummel Party Mod Editor. If you don't know how to open it [[Opening The Mod Editor|read this.]]
To follow along with this tutorial you'll need to be in the '''Pummel Party Mod Editor'''. It is recommended you read the [[Introduction to the Mod Editor]] to familiarize yourself with the core concepts.


== Creating an empty Minigame ==
== Creating the Minigame Mod==
From the welcome screen, select ''New Mod''. If you've closed the welcome screen you can instead use ''File > New Mod''
This displays the ''New Mod'' popup.
 
From here you can choose a mod template to use. To create a minigame mod, you want to choose from the templates that are of type 'Minigame Mod'. Don't select a board mod as you won't have access to minigame-specific functionality, and you cannot change the mod type once a mod has been created. When starting out it is recommended to use a template that closest matches the type of minigame you wish to build. Everything within the templates can be changed and removed; they are only there for convenience to help get you started with something playable.
 
Alternatively you can start from the ''Empty'' minigame mod template. This template has nothing in it, and all [[Mod Settings|mod settings]] are set to their default values. The minigame won't be playable right away as it lacks player spawn points.
 
== Getting Started ==
=== Minimum Requirements ===
* There must be a spawn point in the scene that all 8 players can spawn from.
That's it for now. There might be more requirements in the future to enforce the playability of minigame mods.
 
=== Tips for creating great minigames ===
* Try to create an experience that forces players to interact in some way.
 
== How to Play Minigame Mods ==
Minigame mods must be subscribed to from the Steam Workshop in order to show ingame.
This can be done in a few ways:
* If you created the mod (well done!), when you first published it you were automatically subscribed to it.
* You can locate the mod using the Mod Browser ingame then select the ''Subscribe'' button.
* You can also find it through the Steam Workshop then select the ''Subscribe'' button from its workshop page.
 
Once you're subscribed to a minigame mod, it will be included in the pool of possible minigames you can get while playing Pummel Party. If you want to have a greater chance of playing the minigame mod, you can edit your current ruleset to disable the built-in minigames and any other mod minigames.
 
Mod minigames can be played from both the ''Minigames only'' gamemode and from any board map (including board mods from the workshop).
If you host a lobby, all other players will download the minigame mods in your current ruleset.

Latest revision as of 03:40, 25 October 2022

Accessing the Mod Editor

To follow along with this tutorial you'll need to be in the Pummel Party Mod Editor. It is recommended you read the Introduction to the Mod Editor to familiarize yourself with the core concepts.

Creating the Minigame Mod

From the welcome screen, select New Mod. If you've closed the welcome screen you can instead use File > New Mod This displays the New Mod popup.

From here you can choose a mod template to use. To create a minigame mod, you want to choose from the templates that are of type 'Minigame Mod'. Don't select a board mod as you won't have access to minigame-specific functionality, and you cannot change the mod type once a mod has been created. When starting out it is recommended to use a template that closest matches the type of minigame you wish to build. Everything within the templates can be changed and removed; they are only there for convenience to help get you started with something playable.

Alternatively you can start from the Empty minigame mod template. This template has nothing in it, and all mod settings are set to their default values. The minigame won't be playable right away as it lacks player spawn points.

Getting Started

Minimum Requirements

  • There must be a spawn point in the scene that all 8 players can spawn from.

That's it for now. There might be more requirements in the future to enforce the playability of minigame mods.

Tips for creating great minigames

  • Try to create an experience that forces players to interact in some way.

How to Play Minigame Mods

Minigame mods must be subscribed to from the Steam Workshop in order to show ingame. This can be done in a few ways:

  • If you created the mod (well done!), when you first published it you were automatically subscribed to it.
  • You can locate the mod using the Mod Browser ingame then select the Subscribe button.
  • You can also find it through the Steam Workshop then select the Subscribe button from its workshop page.

Once you're subscribed to a minigame mod, it will be included in the pool of possible minigames you can get while playing Pummel Party. If you want to have a greater chance of playing the minigame mod, you can edit your current ruleset to disable the built-in minigames and any other mod minigames.

Mod minigames can be played from both the Minigames only gamemode and from any board map (including board mods from the workshop). If you host a lobby, all other players will download the minigame mods in your current ruleset.