Essentials Docs Wiki

The Essentials wiki has moved and is now at: Essentials Engine wiki

This wiki will no longer be updated.

READ MORE

Essentials Docs Wiki
(Created page with "The '''example maps''' are the collection of maps that come with a fresh copy of Essentials. == What are they for? == As the name suggests, the example maps contain example...")
Tag: Visual edit
 
Maruno (talk | contribs)
mNo edit summary
Line 1: Line 1:
The '''example maps''' are the collection of maps that come with a fresh copy of Essentials.
+
The '''example maps''' are a collection of [[maps]] that come with a fresh copy of Essentials.
   
 
== What are they for? ==
 
== What are they for? ==
  +
 
As the name suggests, the example maps contain examples of many different features available in Essentials.
 
As the name suggests, the example maps contain examples of many different features available in Essentials.
   
The example maps are joined together to form a small "region" (and thus provide an example of that too, along with map connections and various ways of moving between maps). Examples of similar features are usually grouped on the same map/maps, and are usually in logical places.
+
The example maps are joined together to form a small "region" (and thus provide an example of that too, along with [[Connecting maps|map connections]] and various [[Map transfers|ways of moving between maps]]). Examples of similar features are usually grouped on the same map/maps, and are usually in logical places.
   
 
They are very useful when wanting to find out how to do something relatively simple (for a Pokémon game).
 
They are very useful when wanting to find out how to do something relatively simple (for a Pokémon game).
Line 11: Line 12:
   
 
== The Intro map ==
 
== The Intro map ==
  +
Map 001 is the Intro map. This is the map which should contain the player's starting position, as the player is put there immediately after choosing to start a new game.
+
Map 001 is the [[Game intro|Intro map]]. This is the map which should contain the player's starting position, as the player is put there immediately after choosing to start a new game.
   
 
The map is entirely blank, and contains a single Autorun event in the top left corner which plays the Professor's lecture (including name/gender selection). The version of the lecture that comes with Essentials is based on the FireRed/LeafGreen one, and is rather robust.
 
The map is entirely blank, and contains a single Autorun event in the top left corner which plays the Professor's lecture (including name/gender selection). The version of the lecture that comes with Essentials is based on the FireRed/LeafGreen one, and is rather robust.
Line 20: Line 22:
   
 
== Things related to the example maps ==
 
== Things related to the example maps ==
  +
 
The example maps are not the only things in Essentials which exist just to show off features. There is information elsewhere which is used by them, which you should also remove when clearing the example maps. This information includes:
 
The example maps are not the only things in Essentials which exist just to show off features. There is information elsewhere which is used by them, which you should also remove when clearing the example maps. This information includes:
  +
* Map-specific metadata in the PBS file "metadata.txt".
 
* Map connections in the PBS file "connections.txt".
+
* [[Metadata|Map-specific metadata]] in the [[PBS file]] "metadata.txt".
* Trainer information for the example trainers in the PBS file "trainers.txt".
+
* [[Connecting maps|Map connections]] in the [[PBS file]] "connections.txt".
  +
* [[Defining a trainer|Trainer information]] for the example trainers in the [[PBS file]] "trainers.txt".
* Common events used by phone NPC contacts.
+
* Common events used by [[Phone|phone NPC contacts]].
* Regional Dex names/numbers in the Settings and the PBS file "pokemon.txt".
+
* [[Multiple regions|Regional Dex names/numbers]] in the [[script section]] '''Settings''' and the [[PBS file]] "pokemon.txt".
* Map numbers for Pokémon species which evolve due to levelling up on a certain map, in the PBS file "pokemon.txt" (i.e. Magneton, Eevee (Leafeon and Glaceon), and Nosepass).
 
* Map numbers which determine the form of certain Pokémon in the script section '''Pokemon_MultipleForms''' (i.e. Shellos, Gastrodon and Giratina).
+
* Map numbers for Pokémon species which evolve due to levelling up on a certain map, in the [[PBS file]] "pokemon.txt" (i.e. Magneton, Eevee (Leafeon and Glaceon), and Nosepass).
  +
* Map numbers which determine [[Forms|the form of certain Pokémon]] in the [[script section]] '''Pokemon_Forms''' (i.e. Shellos, Gastrodon and Giratina).
* Wild Pokémon encounters in the PBS file "encounters.txt".
+
* [[Wild encounters|Wild Pokémon encounters]] in the [[PBS file]] "encounters.txt".
* Roaming Pokémon information and roaming paths in the Settings.
 
* Region map point information for the example regions in the PBS file "townmap.txt".
+
* [[Roaming Pokémon]] information and roaming paths in the [[script section]] '''Settings'''.
  +
* [[Region map]] point information for the example regions in the [[PBS file]] "townmap.txt".
* Region map graphics in the folder Graphics/Pictures, including graphics of secret locations defined in the Settings.
+
* [[Region map]] graphics in the folder "Graphics/Pictures", including graphics of secret locations defined in the [[script section]] '''Settings'''.
* Global Switches used by various events in the example maps.
+
* [[Events|Game Switches]] used by various events in the example maps.
* The location to which the player is transferred after the Professor's lecture has finished.
+
* The location to which the player is transferred after the [[Game intro|Professor's lecture]] has finished.
This may seem like a lot of information to deal with. However, most of them can be quickly deleted, and/or you will end up editing them anyway during the course of making your game. Of the above, the only thing which will take more than a couple of seconds to clear are the Regional Dex numbers associated with each Pokémon species the PBS file "pokemon.txt"; however, you can either ignore these if you won't be using any Regional Dexes in your game, or you can use a feature in the External Editor to quickly delete the two example Regional Dexes.
 
  +
 
This may seem like a lot of information to deal with. However, most of them can be quickly deleted, and/or you will end up editing them anyway during the course of making your game. Of the above, the only thing which will take more than a couple of seconds to clear are the Regional Dex numbers associated with each Pokémon species in the [[PBS file]] "pokemon.txt"; however, you can either ignore these if you won't be using any Regional Dexes in your game, or you can use a [[Debug mode]] feature to quickly delete the two example Regional Dexes.
   
 
This list may not be complete, and assumes that you are not changing anything else (such as trainer types).
 
This list may not be complete, and assumes that you are not changing anything else (such as trainer types).

Revision as of 19:12, 26 August 2019

The example maps are a collection of maps that come with a fresh copy of Essentials.

What are they for?

As the name suggests, the example maps contain examples of many different features available in Essentials.

The example maps are joined together to form a small "region" (and thus provide an example of that too, along with map connections and various ways of moving between maps). Examples of similar features are usually grouped on the same map/maps, and are usually in logical places.

They are very useful when wanting to find out how to do something relatively simple (for a Pokémon game).

When you start making your game, probably the first thing you will do is delete (at least most of) the example maps and start making your own. See below for what would be involved in this.

The Intro map

Map 001 is the Intro map. This is the map which should contain the player's starting position, as the player is put there immediately after choosing to start a new game.

The map is entirely blank, and contains a single Autorun event in the top left corner which plays the Professor's lecture (including name/gender selection). The version of the lecture that comes with Essentials is based on the FireRed/LeafGreen one, and is rather robust.

At the end of the lecture, the player is transferred to the place where they actually start the game.

There is a second event on this map, in the bottom left corner, which exists only for debugging purposes. It is used to skip the lecture, automatically assign the player a pre-determined gender and name (male and "Red", respectively), and quickly start the game proper. By default, it is set to trigger via Action Button (which means it cannot be run during a proper game because there's no way it could be interacted with). To use this rather than the lecture, set this event to Autorun and the lecture event to Action Button - remember to change it back once you're finished!

Things related to the example maps

The example maps are not the only things in Essentials which exist just to show off features. There is information elsewhere which is used by them, which you should also remove when clearing the example maps. This information includes:

This may seem like a lot of information to deal with. However, most of them can be quickly deleted, and/or you will end up editing them anyway during the course of making your game. Of the above, the only thing which will take more than a couple of seconds to clear are the Regional Dex numbers associated with each Pokémon species in the PBS file "pokemon.txt"; however, you can either ignore these if you won't be using any Regional Dexes in your game, or you can use a Debug mode feature to quickly delete the two example Regional Dexes.

This list may not be complete, and assumes that you are not changing anything else (such as trainer types).