Difference between revisions of "Manual"

From gamevanilla wiki
Jump to: navigation, search
(Puzzle Match Kit editor)
Line 2: Line 2:
 
|
 
|
  
= Puzzle Match Kit editor =
+
= Manual =
  
Puzzle Match Kit provides a visual editor that allows you to change the settings of the game and create new levels easily and without the need of programming. You can access the editor by selecting the ''Editor'' option located in the ''Window/Puzzle Match Kit'' menu. The editor is divided in three areas and we are going to cover every one of them in the following sections.
+
== How can I add a background music? ==
  
There are two other useful options in the menu, ''Delete PlayerPrefs'' and ''Delete EditorPrefs'', that are shortcuts for deleting your [https://docs.unity3d.com/ScriptReference/PlayerPrefs.html PlayerPrefs] and your [https://docs.unity3d.com/ScriptReference/EditorPrefs.html EditorPrefs] respectively. They are particularly convenient when you are testing your game and need to start from a clean state.
+
We use a background music in the demo but we are not allowed to redistribute it, so you need to do it yourself. You can find the download link in the ''Credits.pdf'' file located inside the ''Sounds'' folder. Once you have downloaded the music and added it to your project (remember to set its ''Load Type'' as ''Streaming'', which is the recommended setting for background music), you just need to drag it into the ''Audio Source'' component of the ''BackgroundMusic'' object located in the home scene.
 
+
All the game files are stored in JSON format and serialized via [https://github.com/jacobdufault/fullserializer Full Serializer]. The game configuration file is by default stored in the ''PuzzleMatchKit/Resources'' folder and named ''game_configuration.json''. The level files are by default stored in the ''PuzzleMatchKit/Resources/Levels'' folder and named ''X.json'', where ''X'' is the corresponding level number.
+
 
+
== Game settings tab ==
+
 
+
The ''Game settings'' tab allows you to change the general settings of the game. At the top of the ''Game settings'' tab, we have the menu, in which you can create a new game setting, open an existing one or save the current one:
+
 
+
https://wiki.gamevanilla.com/images/editor_game_settings_menu.png
+
 
+
In the ''Score'' area, you can set the default score given to the player when a tile entity (block, blocker or booster) explodes. You can also set different values for specific types of tile entities.
+
 
+
https://wiki.gamevanilla.com/images/editor_game_settings_score.png
+
 
+
In the ''Lives'' area, you can change the following properties of the lives system:
+
 
+
* Max lives: The maximum number of lives the player can have.
+
* Time to next life: The time left (in seconds) until a free life is given to the player.
+
* Refill cost: The cost in coins to fill the number of lives to its maximum.
+
 
+
https://wiki.gamevanilla.com/images/editor_game_settings_lives.png
+
 
+
In the ''Coins'' area, you can change the number of coins initially given to the player.
+
 
+
https://wiki.gamevanilla.com/images/editor_game_settings_coins.png
+
 
+
In the ''Boosters'' area, you can set the number of matches needed for a booster to appear. If two or more boosters share the same number of matches, a random one will always be selected from them.
+
 
+
https://wiki.gamevanilla.com/images/editor_game_settings_boosters.png
+
 
+
In the ''Purchasable boosters'' area, you can set the amount and cost of the in-game purchasable boosters.
+
 
+
https://wiki.gamevanilla.com/images/editor_game_settings_purchasable_boosters.png
+
 
+
In the ''Continue game'' area, you can change the following properties of the continue system (i.e., after he loses a game):
+
 
+
* Extra moves: The number of extra moves given to the player when he purchases additional moves.
+
* Moves cost: The cost in coins of the extra moves.
+
* Extra time: The number of extra seconds given to the player when he purchases additional time.
+
* Time cost: The cost in coins of the extra time.
+
 
+
https://wiki.gamevanilla.com/images/editor_game_settings_continue.png
+
 
+
== Level editor tab ==
+
 
+
The ''Level editor'' tab allows you to create your own levels for the game. At the top of the ''Level editor'' tab, we have the menu, in which you can create a new level, open an existing one or save the current one:
+
 
+
https://wiki.gamevanilla.com/images/editor_level_editor_menu.png
+
 
+
In the ''General'' area, you can change the following settings of the level:
+
 
+
* Level number: The number of the level.
+
* Limit type: The type of limit of the level. Can be ''Moves'' (the player will have a fixed amount of moves to accomplish the goals of the level) or ''Time'' (the player will have a fixed amount of seconds to accomplish the goals of the level).
+
* Moves: The number of moves/seconds the player has to accomplish the goals of the level.
+
* Star 1 score: The score needed to unlock the first star of the level.
+
* Star 2 score: The score needed to unlock the second star of the level.
+
* Star 3 score: The score needed to unlock the third star of the level.
+
 
+
https://wiki.gamevanilla.com/images/editor_level_editor_general.png
+
 
+
In the ''Goals'' area, you can specify the goals that the player needs to accomplish in order to complete the level.
+
 
+
https://wiki.gamevanilla.com/images/editor_level_editor_goals.png
+
 
+
In the ''Available color blocks'' area, you can specify which color blocks are available when generating new random color blocks on the level.
+
 
+
https://wiki.gamevanilla.com/images/editor_level_editor_available_color_blocks.png
+
 
+
In the ''Level editor'' area, you can design the layout of your level.
+
 
+
https://wiki.gamevanilla.com/images/editor_level_editor_level.png
+
 
+
== About tab ==
+
 
+
The ''About'' tab contains useful links to the kit's documentation and licensing information.
+
  
 
|}
 
|}

Revision as of 05:38, 4 December 2017

Manual

How can I add a background music?

We use a background music in the demo but we are not allowed to redistribute it, so you need to do it yourself. You can find the download link in the Credits.pdf file located inside the Sounds folder. Once you have downloaded the music and added it to your project (remember to set its Load Type as Streaming, which is the recommended setting for background music), you just need to drag it into the Audio Source component of the BackgroundMusic object located in the home scene.