Difference between revisions of "Playing Maps"

From Armagetron
(New page)
 
(→‎Choosing a Map Download URI: change RESOURCE_REPOSITORY to RESOURCE_REPOSITORY_SERVER, update upload URL)
(18 intermediate revisions by 8 users not shown)
Line 5: Line 5:
 
First you need to place your map.  Each platform has a different place for you to put it, so you need to make a decision about it right away.  The first decision to make is "Should this map be playable for all users on the system?"  If the answer is "yes", then you need to install it in the game's system resources directory.  If the answer is "no", then you need to install it in your user's resource directory for the game.  The actual locations of these files is system-dependent and on some platforms depends on where you installed the game.
 
First you need to place your map.  Each platform has a different place for you to put it, so you need to make a decision about it right away.  The first decision to make is "Should this map be playable for all users on the system?"  If the answer is "yes", then you need to install it in the game's system resources directory.  If the answer is "no", then you need to install it in your user's resource directory for the game.  The actual locations of these files is system-dependent and on some platforms depends on where you installed the game.
  
You generally want to create a new directory underneath your resource directory to hold you own special maps, such as <code>mymaps</code> or <code>custom_maps</code>.  When you browse the directory you'll notice there's a special directory called <code>automatic</code>.  You shouldn't fool with it.  If you've played a server with a map you particularly liked, and you'd like to use that map for your own local game, then you should copy the map from it's location in the <code>automatic</code> directory and put it in your own directory underneath <code>resource</code>.  Examples (Linux given, others requested):
+
You generally want to create a new directory underneath your resource directory to hold you own special maps. This directory should be named according to the author of the maps in it. Please be careful to avoid an ambiguous nickname by checking if someone is already using that name on the [[resource repository]].  When you browse your local resource directory you may notice that there's a special directory called <code>automatic</code>.  You shouldn't fool with it.  If you've played a server with a map you particularly liked, and you'd like to use that map for your own local game, then you should move the map from it's location in the <code>automatic</code> directory and put it immediately beneath the <code>resource</code> directory.  Examples (Linux given, others requested):
  
* /home/Lucifer/.armagetronad/resource/lucifers_maps/crack_pipe-0.1.xml
+
* /home/Lucifer/.armagetronad/resource/Lucifer/crack_pipe-0.1.xml
  
 
=== System Resource Directory (default) ===
 
=== System Resource Directory (default) ===
  
 
* '''Linux''' - /usr/share/games/armagetronad/resource
 
* '''Linux''' - /usr/share/games/armagetronad/resource
* '''Windows''' -
+
* '''Windows''' - C:\Program Files\Armagetron Advanced\resource
* '''Mac OS X''' -  
+
* '''Mac OS X''' - Armagetron Advanced.app/Contents/Resources/resource
  
 
=== User's Resource Directory (default) ===
 
=== User's Resource Directory (default) ===
  
* '''Linux''' - ~/.armagetronad/resource (ex: /home/Lucifer/.armagetronad/resource)
+
* '''Linux''' - <home>/.armagetronad/resource
* '''Windows''' -
+
** ''Example'': /home/Joe/.armagetronad/resource
* '''Mac OS X''' -
+
* '''Windows''' - <appdata>\Armagetron\resource
 +
** ''Example'': C:\Documents and Settings\Joe\Application Data\Armagetron\resource
 +
* '''Mac OS X''' - <home>/Library/Application Support/Armagetron Advanced/resource
 +
** ''Example'': /Users/Joe/Library/Application Support/Armagetron Advanced/resource
  
 
== Setting the Config ==
 
== Setting the Config ==
  
The file you need to modify depends on whether or not you want the map to be available for all users of the system.  If you want the map available for all users of the system, then you need to modify the file <code>settings.cfg</code> in the appropriate directory (paths given below).  If you only want you to be able to play the map on your system, or if you don't have administrative privileges on your machine, then you'll need to modify <code>user.cfg</code> in your home directory.
+
The file you need to modify depends on whether or not you want the map to be available for all users of the system.  If you want the map available for all users of the system, then you need to modify the file <code>settings.cfg</code> in the appropriate directory (paths given below).  If you only want you to be able to play the map on your system, or if you don't have administrative privileges on your machine, then you'll need to modify <code>autoexec.cfg</code> in your home directory. You'll have to create that file, it does not exist on a fresh installation.
  
 
The modification you need to make is to add a line that looks like this, based on the example given above:
 
The modification you need to make is to add a line that looks like this, based on the example given above:
  
* MAP_FILE lucifers_maps/crack_pipe-0.1.xml
+
* MAP_FILE Lucifer/crack_pipe-0.1.xml
  
That's it.  Note that the path is relative to the <code>resource<code> directory.  The game will scan the system resource directory, then your user's resource directory.  If it doesn't find the map after scanning those places it will try to fetch the map from a web serverIf you happen to have a URL for the map, you can put it in like so:
+
That's it.  Note that the path is relative to the <code>resource</code> directory.  The game will scan your user's resource directory, and then the system resource directory.  If it doesn't find the map after scanning those places it will try to fetch the map from the resource repository.   
 
+
Since you're most likely working locally, this shouldn't be necessary.
* MAP_URI http://www.davefancella.com/maps/crack_pipe-0.1.xml
 
 
 
Since you're most likely working locally, this shouldn't be necessary.  It is, however, possible to leave off the MAP_FILE directive and only provide the MAP_URI.  This will be particularly useful once the central resource repository is up and running.  More information will be provided here when that happens.
 
  
 
=== System Configuration File Paths (default) ===
 
=== System Configuration File Paths (default) ===
  
 
* '''Linux''' - /usr/etc/games/armagetronad/settings.cfg
 
* '''Linux''' - /usr/etc/games/armagetronad/settings.cfg
* '''Windows''' -
+
* '''Windows''' - C:\Program Files\Armagetron Advanced\config\settings.cfg
* '''Mac OS X''' -
+
* '''Mac OS X''' - Armagetron Advanced.app/Contents/Resources/settings.cfg
  
 
=== User Configuration File Paths (default) ===
 
=== User Configuration File Paths (default) ===
  
* '''Linux''' - ~/.armagetronad/var/user.cfg
+
* '''Linux''' - <home>/.armagetronad/var/autoexec.cfg
* '''Windows''' -
+
* '''Windows''' - <appdata>\Armagetron\var\autoexec.cfg
* '''Mac OS X''' -
+
* '''Mac OS X''' - <home>/Library/Application Support/Armagetron Advanced/autoexec.cfg
 +
 
 +
=== Choosing a Map Download URI ===
 +
If using a location other than the official resource repository is desired (for example, for a LAN game where not all players have internet access), you can specify it using 2 different methods:
 +
 
 +
* MAP_FILE Lucifer/crack_pipe-0.1.xml(http://www.davefancella.com/maps/crack_pipe-0.1.xml) this may not work unless you have the apropriat things
 +
* RESOURCE_REPOSITORY_SERVER http://aabeta.dashjr.org/resource/
 +
 
 +
Note that to use the RESOURCE_REPOSITORY variable, the website must provide the files under the regular file path. In this case, the file http://aabeta.dashjr.org/resource/Lucifer/crack_pipe-0.1.xml would need to exist.
 +
 
 +
If you don't have an own webserver to host your map or you want to make your map "official", whatever that means, submit it to our resource repository here:
 +
<!--http://beta.armagetronad.net/addmaps.php-->
 +
http://resource.armagetronad.net/upload/
 +
 
 +
Note that while specifying a URI for the map is optional when it has been submitted to the official resource repository, you must '''always''' specify the map filepath in MAP_FILE.
 +
 
 +
[[Category:Client Features]]
 +
[[Category:0.2.8]]

Revision as of 15:35, 23 February 2019

So you've made your map and now you'd like to play it? Unfortunately, at this time the game doesn't have a nice graphical interface for choosing maps from what's installed. So you'll have to get your elbows a little dirty and hack into config files to do it. Luckily it's not that hard.

Place Your Map

First you need to place your map. Each platform has a different place for you to put it, so you need to make a decision about it right away. The first decision to make is "Should this map be playable for all users on the system?" If the answer is "yes", then you need to install it in the game's system resources directory. If the answer is "no", then you need to install it in your user's resource directory for the game. The actual locations of these files is system-dependent and on some platforms depends on where you installed the game.

You generally want to create a new directory underneath your resource directory to hold you own special maps. This directory should be named according to the author of the maps in it. Please be careful to avoid an ambiguous nickname by checking if someone is already using that name on the resource repository. When you browse your local resource directory you may notice that there's a special directory called automatic. You shouldn't fool with it. If you've played a server with a map you particularly liked, and you'd like to use that map for your own local game, then you should move the map from it's location in the automatic directory and put it immediately beneath the resource directory. Examples (Linux given, others requested):

  • /home/Lucifer/.armagetronad/resource/Lucifer/crack_pipe-0.1.xml

System Resource Directory (default)

  • Linux - /usr/share/games/armagetronad/resource
  • Windows - C:\Program Files\Armagetron Advanced\resource
  • Mac OS X - Armagetron Advanced.app/Contents/Resources/resource

User's Resource Directory (default)

  • Linux - <home>/.armagetronad/resource
    • Example: /home/Joe/.armagetronad/resource
  • Windows - <appdata>\Armagetron\resource
    • Example: C:\Documents and Settings\Joe\Application Data\Armagetron\resource
  • Mac OS X - <home>/Library/Application Support/Armagetron Advanced/resource
    • Example: /Users/Joe/Library/Application Support/Armagetron Advanced/resource

Setting the Config

The file you need to modify depends on whether or not you want the map to be available for all users of the system. If you want the map available for all users of the system, then you need to modify the file settings.cfg in the appropriate directory (paths given below). If you only want you to be able to play the map on your system, or if you don't have administrative privileges on your machine, then you'll need to modify autoexec.cfg in your home directory. You'll have to create that file, it does not exist on a fresh installation.

The modification you need to make is to add a line that looks like this, based on the example given above:

  • MAP_FILE Lucifer/crack_pipe-0.1.xml

That's it. Note that the path is relative to the resource directory. The game will scan your user's resource directory, and then the system resource directory. If it doesn't find the map after scanning those places it will try to fetch the map from the resource repository. Since you're most likely working locally, this shouldn't be necessary.

System Configuration File Paths (default)

  • Linux - /usr/etc/games/armagetronad/settings.cfg
  • Windows - C:\Program Files\Armagetron Advanced\config\settings.cfg
  • Mac OS X - Armagetron Advanced.app/Contents/Resources/settings.cfg

User Configuration File Paths (default)

  • Linux - <home>/.armagetronad/var/autoexec.cfg
  • Windows - <appdata>\Armagetron\var\autoexec.cfg
  • Mac OS X - <home>/Library/Application Support/Armagetron Advanced/autoexec.cfg

Choosing a Map Download URI

If using a location other than the official resource repository is desired (for example, for a LAN game where not all players have internet access), you can specify it using 2 different methods:

Note that to use the RESOURCE_REPOSITORY variable, the website must provide the files under the regular file path. In this case, the file http://aabeta.dashjr.org/resource/Lucifer/crack_pipe-0.1.xml would need to exist.

If you don't have an own webserver to host your map or you want to make your map "official", whatever that means, submit it to our resource repository here: http://resource.armagetronad.net/upload/

Note that while specifying a URI for the map is optional when it has been submitted to the official resource repository, you must always specify the map filepath in MAP_FILE.