From: Ingo Ruhnke <grumbel@gmx.de>
Date: Sun, 18 Feb 2007 22:54:14 +0000 (+0000)
Subject: - added some notes on using the file
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=044b44e6600488d853209d0131fa7df83aff5e91;p=supertux.git

- added some notes on using the file

SVN-Revision: 4864
---

diff --git a/data/images/tiles.strf b/data/images/tiles.strf
index d9f3b6843..635220923 100644
--- a/data/images/tiles.strf
+++ b/data/images/tiles.strf
@@ -1,3 +1,17 @@
+;; This file contains the mapping from tile-ids to image files as well
+;; as the tile properties (unisolid, solid, ice, water, etc.). Since
+;; it is important that the tile-ids don't change once created and
+;; used in a level some care has to be taken when editing this file,
+;; else the levels would be rendered unusable.
+;;
+;; Some notes on editing this file:
+;;  - tile-ids must be uniq
+;;  - the tile definition with the largest id should always be at the
+;;    bottom of the file
+;;  - when creating a new tile definition take the greatest current id
+;;    and increment it by one
+;;  - the meaning of the values in (attributes ...) can be seen in
+;;    src/tile.cpp, unisolid is 3 not 2
 (supertux-tiles
   (tilegroup
     (name "Snow")