Recent changes to Maps

WikiPage Maps modified by Jakob Battelino Prelog

Jakob Battelino Prelog — Sat, 27 Oct 2012 21:17:20 -0000

--- v10
+++ v11
@@ -171,5 +171,5 @@
 ----------
 #Map Maker
 
-From version v0.3b forwards, game distributions include an experimental map maker application, that automates the XML code generation and file placement.
+Since version v0.3b, game distributions include an experimental map maker application, that automates the XML code generation and file placement.
 Instructions on it's use can be found on [MapMaker's home page](https://sourceforge.net/p/wossname/wiki/MapMaker).

WikiPage Maps modified by Jakob Battelino Prelog

Jakob Battelino Prelog — Sat, 27 Oct 2012 19:33:54 -0000

--- v9
+++ v10
@@ -11,7 +11,7 @@
 -----
 [TOC]
 
--------------------
+--------------------
 #Map Definition File
 
 Map definition file *definition.xml* is the crucial file for any map. It holds declarations of map's name, difficulty, map image reference and coordinates of all locations.
@@ -117,7 +117,7 @@
 
 In the above example, the location named *Colosseum* will be displayed on over the pixel on coordinates 4380, 1093 and had the flag of Italy associated with it.
 
---------------
+---------------
 #Map Image File
 
 Map image file is the image that will be displayed in the game as the background on which one clicks when guessing locations.
@@ -125,7 +125,7 @@
 Supported image formats are *jpg*, *png* or *gif*.
 There are no image size restrictions, but images with higher resolution are preferred, to accommodate players with higher screen resolutions.
 
------------------------
+------------------------
 #Country Definition File
 
 In addition to map definition file, it is also possible to declare new countries. This is done with the map's country definition file *countries.xml*. This file is placed int he same directory as map definition file, but is not a required file. In case the game does not discover the *countries.xml* file in the custom map's directory, it uses default country definition file, located in *res/maps/* directory.
@@ -164,6 +164,12 @@
 * **image** country's flag image.
 
 Content of attribute **name** is displayed in the game as the location's country. In order for the location to be associated with a country, it's **country** attribute has to be exactly the same as the **name** attribute of the country.
-Attribute **image** is the short name of the country's flag image file. All flag image files must be located in the *res/maps/flags/* directory. Missing flags will not be displayed.
+Attribute **image** is the short name of the country's flag image file. All flag image files must be located in the *res/maps/flags/* directory. Missing flags will not be displayed. Flag files are restricted to *jpg*, *png* and *gif* formats.
 
 In the above example, country's name will be displayed as *Aland Islands* and image *res/maps/flags/ax.png* will be displayed as it's flag.
+
+----------
+#Map Maker
+
+From version v0.3b forwards, game distributions include an experimental map maker application, that automates the XML code generation and file placement.
+Instructions on it's use can be found on [MapMaker's home page](https://sourceforge.net/p/wossname/wiki/MapMaker).

WikiPage Maps modified by Jakob Battelino Prelog

Jakob Battelino Prelog — Sat, 27 Oct 2012 19:27:10 -0000

--- v8
+++ v9
@@ -13,6 +13,7 @@
 
 -------------------
 #Map Definition File
+
 Map definition file *definition.xml* is the crucial file for any map. It holds declarations of map's name, difficulty, map image reference and coordinates of all locations.
 It has to be placed in a subdirectory of *res/maps/* directory. The name of this subdirectory is the name displayed in the selection box in game's *Host* menu.
 
@@ -103,7 +104,7 @@
 In the above example, the map would be named *Wonders of the World*, displayed it's difficulty as *HARD* and use image *res/maps/maps/relief8k.jpg* as the map image.
 
 
-##Location declarations
+##Location Declarations
 
     
 
@@ -118,6 +119,7 @@
 
 --------------
 #Map Image File
+
 Map image file is the image that will be displayed in the game as the background on which one clicks when guessing locations.
 Map image file has to be placed into the *res/maps/maps/* directory, otherwise the game will not found it.
 Supported image formats are *jpg*, *png* or *gif*.
@@ -125,3 +127,43 @@
 
 -----------------------
 #Country Definition File
+
+In addition to map definition file, it is also possible to declare new countries. This is done with the map's country definition file *countries.xml*. This file is placed int he same directory as map definition file, but is not a required file. In case the game does not discover the *countries.xml* file in the custom map's directory, it uses default country definition file, located in *res/maps/* directory.
+
+Country definition file serves as a mapping reference between country names and their flags. Custom country definition files serve as a tool, to remove any map location restrictions, that would have been set by the limited set of country declarations in the default *countries.xml* file.
+
+An example of a valid country definition file:
+
+    
+    
+    	
+    		
+    		
+    ]>
+    
+    
+    	
+    	
+    
+
+As with the map definition file, the XML file is divided into different sections:
+
+* DTD declaration of XML elements and attributes.
+* Country declarations.
+
+The DTD part is there solely for XML validation purposes. It is the same for all country definition files and must be in every country definition file.
+
+## Country Declarations
+
+    
+
+Each country has two attributes:
+
+* **name** - name of the country and
+* **image** country's flag image.
+
+Content of attribute **name** is displayed in the game as the location's country. In order for the location to be associated with a country, it's **country** attribute has to be exactly the same as the **name** attribute of the country.
+Attribute **image** is the short name of the country's flag image file. All flag image files must be located in the *res/maps/flags/* directory. Missing flags will not be displayed.
+
+In the above example, country's name will be displayed as *Aland Islands* and image *res/maps/flags/ax.png* will be displayed as it's flag.

WikiPage Maps modified by Jakob Battelino Prelog

Jakob Battelino Prelog — Sat, 27 Oct 2012 19:03:01 -0000

--- v7
+++ v8
@@ -12,8 +12,7 @@
 [TOC]
 
 -------------------
-Map Definition File
--------------------
+#Map Definition File
 Map definition file *definition.xml* is the crucial file for any map. It holds declarations of map's name, difficulty, map image reference and coordinates of all locations.
 It has to be placed in a subdirectory of *res/maps/* directory. The name of this subdirectory is the name displayed in the selection box in game's *Host* menu.
 
@@ -91,7 +90,7 @@
 
 The DTD part is there solely for XML validation purposes. It is the same for all map definition files and must be in every map definition file. It has also been covered at the beginning of this section.
 
-**General Map Attributes:**
+##General Map Attributes
 
     
 
@@ -104,7 +103,7 @@
 In the above example, the map would be named *Wonders of the World*, displayed it's difficulty as *HARD* and use image *res/maps/maps/relief8k.jpg* as the map image.
 
 
-**Location declarations:**
+##Location declarations
 
     
 
@@ -118,13 +117,11 @@
 In the above example, the location named *Colosseum* will be displayed on over the pixel on coordinates 4380, 1093 and had the flag of Italy associated with it.
 
 --------------
-Map Image File
---------------
+#Map Image File
 Map image file is the image that will be displayed in the game as the background on which one clicks when guessing locations.
 Map image file has to be placed into the *res/maps/maps/* directory, otherwise the game will not found it.
 Supported image formats are *jpg*, *png* or *gif*.
 There are no image size restrictions, but images with higher resolution are preferred, to accommodate players with higher screen resolutions.
 
 -----------------------
-Country Definition File
------------------------
+#Country Definition File

WikiPage Maps modified by Jakob Battelino Prelog

Jakob Battelino Prelog — Sat, 27 Oct 2012 18:57:56 -0000

--- v6
+++ v7
@@ -120,7 +120,10 @@
 --------------
 Map Image File
 --------------
-Map image file is the image that will be displayed in the game as the background
+Map image file is the image that will be displayed in the game as the background on which one clicks when guessing locations.
+Map image file has to be placed into the *res/maps/maps/* directory, otherwise the game will not found it.
+Supported image formats are *jpg*, *png* or *gif*.
+There are no image size restrictions, but images with higher resolution are preferred, to accommodate players with higher screen resolutions.
 
 -----------------------
 Country Definition File

WikiPage Maps modified by Jakob Battelino Prelog

Jakob Battelino Prelog — Sat, 27 Oct 2012 18:52:17 -0000

--- v5
+++ v6
@@ -91,7 +91,7 @@
 
 The DTD part is there solely for XML validation purposes. It is the same for all map definition files and must be in every map definition file. It has also been covered at the beginning of this section.
 
-**General Map Attributes**
+**General Map Attributes:**
 
     
 
@@ -101,9 +101,10 @@
 * **image** - name of the map image file.
 
 Attribute **difficulty** can also be declared, but is not required.
+In the above example, the map would be named *Wonders of the World*, displayed it's difficulty as *HARD* and use image *res/maps/maps/relief8k.jpg* as the map image.
 
 
-**Location declarations**
+**Location declarations:**
 
     
 
@@ -114,6 +115,8 @@
 * **y** - vertical coordinate of the location on the map's image.
 * **country** - name of the country the location belongs to.
 
+In the above example, the location named *Colosseum* will be displayed on over the pixel on coordinates 4380, 1093 and had the flag of Italy associated with it.
+
 --------------
 Map Image File
 --------------

WikiPage Maps modified by Jakob Battelino Prelog

Jakob Battelino Prelog — Sat, 27 Oct 2012 18:47:50 -0000

--- v4
+++ v5
@@ -13,7 +13,7 @@
 
 -------------------
 Map Definition File
-===================
+-------------------
 Map definition file *definition.xml* is the crucial file for any map. It holds declarations of map's name, difficulty, map image reference and coordinates of all locations.
 It has to be placed in a subdirectory of *res/maps/* directory. The name of this subdirectory is the name displayed in the selection box in game's *Host* menu.
 
@@ -91,12 +91,34 @@
 
 The DTD part is there solely for XML validation purposes. It is the same for all map definition files and must be in every map definition file. It has also been covered at the beginning of this section.
 
-General Map Attributes
-----------------------
+**General Map Attributes**
 
+    
+
+The two required attributes for the map element are:
+
+* **name** - a descriptive name for the map and
+* **image** - name of the map image file.
+
+Attribute **difficulty** can also be declared, but is not required.
+
+
+**Location declarations**
+
+    
+
+Each location has four required attributes:
+
+* **name** - name of the location.
+* **x** - horizontal coordinate of the location on the map's image.
+* **y** - vertical coordinate of the location on the map's image.
+* **country** - name of the country the location belongs to.
+
+--------------
 Map Image File
-==============
+--------------
 Map image file is the image that will be displayed in the game as the background
 
+-----------------------
 Country Definition File
-=======================
+-----------------------

WikiPage Maps modified by Jakob Battelino Prelog

Jakob Battelino Prelog — Sat, 27 Oct 2012 18:37:55 -0000

--- v3
+++ v4
@@ -13,7 +13,7 @@
 
 -------------------
 Map Definition File
--------------------
+===================
 Map definition file *definition.xml* is the crucial file for any map. It holds declarations of map's name, difficulty, map image reference and coordinates of all locations.
 It has to be placed in a subdirectory of *res/maps/* directory. The name of this subdirectory is the name displayed in the selection box in game's *Host* menu.
 
@@ -82,3 +82,21 @@
     	
     	
     
+
+The XML is divided into three parts:
+
+* DTD declaration of XML elements and attributes.
+* General map attributes.
+* Location declarations.
+
+The DTD part is there solely for XML validation purposes. It is the same for all map definition files and must be in every map definition file. It has also been covered at the beginning of this section.
+
+General Map Attributes
+----------------------
+
+Map Image File
+==============
+Map image file is the image that will be displayed in the game as the background
+
+Country Definition File
+=======================

WikiPage Maps modified by Jakob Battelino Prelog

Jakob Battelino Prelog — Sat, 27 Oct 2012 18:24:39 -0000

--- v2
+++ v3
@@ -30,3 +30,55 @@
     		
     		
     ]>
+
+An example of a valid definition file is *definition.xml* taken from the *res/maps/wonders/* directory.
+It defines the *Wonders of the World* playable map, corresponding to *wonders* entry in the map selection box in the game menu.
+
+    
+    
+    	
+    	
+    	
+    	
+    		
+    		
+    		
+    		
+    ]>
+    
+    
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+    	
+

WikiPage Maps modified by Jakob Battelino Prelog

Jakob Battelino Prelog — Sat, 27 Oct 2012 18:18:47 -0000

--- v1
+++ v2
@@ -8,7 +8,25 @@
 
 The last condition is, strictly speaking, not necessary, but if the referred map image is not found, players will be playing on a blank background.
 
+-----
+[TOC]
 
-**Map Definition File**
+-------------------
+Map Definition File
+-------------------
 Map definition file *definition.xml* is the crucial file for any map. It holds declarations of map's name, difficulty, map image reference and coordinates of all locations.
 It has to be placed in a subdirectory of *res/maps/* directory. The name of this subdirectory is the name displayed in the selection box in game's *Host* menu.
+
+Valid map definition file is defined by the following DTD code:
+
+    
+    	
+    	
+    	
+    	
+    		
+    		
+    		
+    		
+    ]>