Gobligine/doc/datadir.html

286 lines
11 KiB
HTML
Raw Normal View History

2003-05-03 06:56:38 -06:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
2001-03-10 16:25:40 -07:00
<!--
---- $Id$
2001-05-30 07:09:14 -06:00
---- (c) Copyright 2001-2004 by Lutz Sammer
2001-05-30 07:09:14 -06:00
2003-07-03 10:08:07 -06:00
---- This program is free software; you can redistribute it and/or modify
2001-05-30 07:09:14 -06:00
---- it under the terms of the GNU General Public License as published by
---- the Free Software Foundation; only version 2 of the License.
2003-07-03 10:08:07 -06:00
----
---- This program is distributed in the hope that it will be useful,
2001-05-30 07:09:14 -06:00
---- but WITHOUT ANY WARRANTY; without even the implied warranty of
---- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
---- GNU General Public License for more details.
2003-07-03 10:08:07 -06:00
----
---- You should have received a copy of the GNU General Public License
---- along with this program; if not, write to the Free Software
---- Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
---- 02111-1307, USA.
2001-03-10 16:25:40 -07:00
-->
<title>Stratagus Version 2.1 - Data directory structure</title>
2003-05-03 06:56:38 -06:00
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
2003-04-22 18:44:03 -06:00
</head>
2003-05-03 06:56:38 -06:00
2003-04-22 18:44:03 -06:00
<body>
2003-05-03 06:56:38 -06:00
<h1>Stratagus Version 2.1 - Data directory structure</h1>
2003-04-22 18:44:03 -06:00
<hr>
2003-05-03 06:56:38 -06:00
2003-07-03 09:35:45 -06:00
Proposal for the new Stratagus data directory structure:
2001-03-10 16:25:40 -07:00
2003-05-03 06:56:38 -06:00
<pre>
2003-04-22 18:44:03 -06:00
<i>{race}</i> : Replace with a race name: human, orc, alliance or mythical..
<i>{tileset}</i> : Replace with a tileset name: winter, summer, ...
<i>{unit}</i> : Replace with an unit name: footman, bowman, ...
<i>{building}</i> : Replace with a building name: goldmine, farm, ...
<i>{race-campaign}</i> : Replace with a name of a campaign of a race: human-exp, ...
2001-03-10 16:25:40 -07:00
2003-07-03 09:34:53 -06:00
<b>$STRATAGUS_LIBRARY_PATH/data</b>
2003-07-03 09:35:45 -06:00
| Contains all data files for the Stratagus game engine.
2001-03-10 16:25:40 -07:00
|
2003-04-22 18:44:03 -06:00
}-- <b>data/campaigns</b>
2001-03-10 16:25:40 -07:00
| | Contains all available campaigns.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/campaigns/<i>{race-campaign}</i></b>
2001-03-10 16:25:40 -07:00
| | Contains all data for a campaign: scripts, maps, texts, intros.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/campaigns/<i>{race-campaign}</i>/interface</b>
2001-03-10 16:25:40 -07:00
| Contains special backgrounds images for the campaign.
|
}-- <b>data/scripts</b>
| Contains all global Configuration Language files.
2001-03-10 16:25:40 -07:00
|
2003-04-22 18:44:03 -06:00
}-- <b>data/graphics</b>
2001-03-10 16:25:40 -07:00
| | Contains all available graphics.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/graphics/<i>{race}</i></b>
2001-03-10 16:25:40 -07:00
| | | Contains all graphics of a race, which could be used in any
| | | tileset.
| | |
2003-04-22 18:44:03 -06:00
| | }-- <b>data/graphics/<i>{race}</i>/buildings</b>
2001-03-10 16:25:40 -07:00
| | | Contains the building of the race, which could be used in
| | | any tileset.
| | |
2003-04-22 18:44:03 -06:00
| | `-- <b>data/graphics/<i>{race}</i>/units</b>
2001-03-10 16:25:40 -07:00
| | Contains all units of the race, which could be used in any
| | any tileset.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/graphics/neutral</b>
2001-03-10 16:25:40 -07:00
| | | Contains all graphics that didn't belong to a special race and
| | | which could be used in any tileset.
| | |
2003-04-22 18:44:03 -06:00
| | }-- <b>data/graphics/neutral/buildings</b>
2001-03-10 16:25:40 -07:00
| | | Contains all buildings that didn't belong to a special race
| | | and which could be used in any tileset.
| | |
2003-04-22 18:44:03 -06:00
| | `-- <b>data/graphics/neutral/units</b>
2001-03-10 16:25:40 -07:00
| | Contains all units that didn't belong to a special race and
| | which could be used in any tileset.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/graphics/missiles</b>
2001-03-10 16:25:40 -07:00
| | Contains all graphics of missiles.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/graphics/tilesets</b>
2001-03-10 16:25:40 -07:00
| | | Contains the graphics special to a single tileset.
| | | Icons, buildings, units, tileset, decorations.
| | |
2003-04-22 18:44:03 -06:00
| | `-- <b>data/graphics/tilesets/<i>{tileset}</i></b>
2001-03-10 16:25:40 -07:00
| | | Contains the special graphics of this tileset of all races.
| | |
2003-04-22 18:44:03 -06:00
| | }-- <b>data/graphics/tilesets/<i>{tileset}</i>/<i>{race}</i></b>
2001-03-10 16:25:40 -07:00
| | | | Contains all graphics of a race special to this tileset.
| | | |
2003-04-22 18:44:03 -06:00
| | | }-- <b>data/graphics/tilesets/<i>{tileset}</i>/<i>{race}</i>/buildings</b>
2001-03-10 16:25:40 -07:00
| | | | Contains all buildings graphics of a race and a tileset.
| | | |
2003-04-22 18:44:03 -06:00
| | | `-- <b>data/graphics/tilesets/<i>{tileset}</i>/<i>{race}</i>/units</b>
2001-03-10 16:25:40 -07:00
| | | Contains all units graphics of a race and a tileset.
| | |
2003-04-22 18:44:03 -06:00
| | }-- <b>data/graphics/tilesets/<i>{tileset}</i>/neutral</b>
2001-03-10 16:25:40 -07:00
| | | | Contains the graphics not belonging to any race.
| | | |
2003-04-22 18:44:03 -06:00
| | | }-- <b>data/graphics/tilesets/<i>{tileset}</i>/neutral/buildings</b>
2001-03-10 16:25:40 -07:00
| | | | Contains the buildings graphics of the neutral race.
| | | |
2003-04-22 18:44:03 -06:00
| | | `-- <b>data/graphics/tilesets/<i>{tileset}</i>/neutral/units</b>
2001-03-10 16:25:40 -07:00
| | | Contains the units graphics of the neutral race.
| | |
2003-04-22 18:44:03 -06:00
| | `-- <b>data/graphics/tilesets/<i>{tileset}</i>/terrain</b>
2001-03-10 16:25:40 -07:00
| | Contains the graphics for the tileset self.
| |
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/graphics/ui</b>
2001-03-10 16:25:40 -07:00
| | Contains all user interface graphics.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/graphics/ui/cursors</b>
2001-03-10 16:25:40 -07:00
| | Contains all cursors not special to any race.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/graphics/ui/fonts</b>
2001-03-10 16:25:40 -07:00
| | Contains all fonts not special to any race.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/graphics/ui/<i>{race}</i></b>
2001-03-10 16:25:40 -07:00
| | Contains all user interface graphics special to a race.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/graphics/ui/<i>{race}</i>/640x480</b>
2001-03-10 16:25:40 -07:00
| | Contains the user interface graphics for this resolution.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/graphics/ui/<i>{race}</i>/cursors</b>
2001-03-10 16:25:40 -07:00
| Contains the cursors special to this race.
|
|
}-- <b>data/maps</b>
| | Contains all maps 'pud' format is used currently.
| | Structure here is not required, you can use your own.
2001-03-10 16:25:40 -07:00
| |
| }-- <b>data/maps/demo</b>
2001-03-10 16:25:40 -07:00
| | Contains the demo levels.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/puds/multi</b>
2001-03-10 16:25:40 -07:00
| | Contains multi-player levels.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/puds/single</b>
2001-03-10 16:25:40 -07:00
| | Contains single player levels.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/puds/strange</b>
2001-03-10 16:25:40 -07:00
| Contains strange levels.
|
2003-04-22 18:44:03 -06:00
`-- <b>data/sounds</b>
2001-03-10 16:25:40 -07:00
| Contains all available sounds.
|
2003-04-22 18:44:03 -06:00
}-- <b>data/sounds/buildings</b>
2001-03-10 16:25:40 -07:00
| Contains all general buildings sounds.
|
2003-04-22 18:44:03 -06:00
}-- <b>data/sounds/<i>{race}</i></b>
2001-03-10 16:25:40 -07:00
| | Contains all sounds special to a race.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/sounds/<i>{race}</i>/basic_voices</b>
2001-03-10 16:25:40 -07:00
| | | Contains the general sounds of this race.
| | |
2003-04-22 18:44:03 -06:00
| | }-- <b>data/sounds/<i>{race}</i>/basic_voices/acknowledgement</b>
2001-03-10 16:25:40 -07:00
| | | Contains the general acknowledgement sounds of this race.
| | |
2003-04-22 18:44:03 -06:00
| | }-- <b>data/sounds/<i>{race}</i>/basic_voices/annoyed</b>
2001-03-10 16:25:40 -07:00
| | | Contains the general annoyed sounds of this race.
| | |
2003-04-22 18:44:03 -06:00
| | }-- <b>data/sounds/<i>{race}</i>/basic_voices/help</b>
2001-03-10 16:25:40 -07:00
| | | Contains the general help sounds of this race.
| | |
2003-04-22 18:44:03 -06:00
| | `-- <b>data/sounds/<i>{race}</i>/basic_voices/selected</b>
2001-03-10 16:25:40 -07:00
| | Contains the general selected sounds of this race.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/sounds/<i>{race}</i>/buildings</b>
2001-03-10 16:25:40 -07:00
| | Contains the buildings sounds of this race.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/sounds/<i>{race}</i>/ships</b>
2001-03-10 16:25:40 -07:00
| | | Contains all general ship sounds of this race.
| | |
2003-04-22 18:44:03 -06:00
| | }-- <b>data/sounds/<i>{race}</i>/ships/acknowledgement</b>
2001-03-10 16:25:40 -07:00
| | | Contains the ship acknowledgement sound of this race.
| | |
2003-04-22 18:44:03 -06:00
| | }-- <b>data/sounds/<i>{race}</i>/ships/annoyed</b>
2001-03-10 16:25:40 -07:00
| | | Contains the ship annoyed sound of this race.
| | |
2003-04-22 18:44:03 -06:00
| | `-- <b>data/sounds/<i>{race}</i>/ships/selected</b>
2001-03-10 16:25:40 -07:00
| | Contains the ship selected sound of this race.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/sounds/<i>{race}</i>/units</b>
2001-03-10 16:25:40 -07:00
| | Contains the special sounds of a race and unit.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/sounds/<i>{race}</i>/units/<i>{unit}</i></b>
2001-03-10 16:25:40 -07:00
| | Contains the special sounds of this units of the race.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/sounds/<i>{race}</i>/units/<i>{unit}</i>/acknowledgement</b>
2001-03-10 16:25:40 -07:00
| | Contains the acknowledge sound of this unit.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/sounds/<i>{race}</i>/units/<i>{unit}</i>/annoyed</b>
2001-03-10 16:25:40 -07:00
| | Contains the annoyed sound of this unit.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/sounds/<i>{race}</i>/units/<i>{unit}</i>/selected</b>
2001-03-10 16:25:40 -07:00
| Contains the selected sound of this unit.
|
2003-04-22 18:44:03 -06:00
}-- <b>data/sounds/misc</b>
2001-03-10 16:25:40 -07:00
| | Contains the sounds that didn't fit in any section.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/sounds/misc/building explosion</b>
2001-03-10 16:25:40 -07:00
| | Contains the building explosion sounds.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/sounds/misc/tree chopping</b>
2001-03-10 16:25:40 -07:00
| Contains the tree chopping sounds.
|
2003-04-22 18:44:03 -06:00
}-- <b>data/sounds/missiles</b>
2001-03-10 16:25:40 -07:00
| | Contains the fire and hit sounds of missiles.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/sounds/missiles/sword attack</b>
2001-03-10 16:25:40 -07:00
| Contains different sounds of the same kind.
|
2003-04-22 18:44:03 -06:00
}-- <b>data/sounds/neutral</b>
2001-03-10 16:25:40 -07:00
| | Contains the sounds of buildings or units not belonging to any race.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/sounds/neutral/buildings</b>
2001-03-10 16:25:40 -07:00
| | Contains the building sounds of the neutral race.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/sounds/neutral/units</b>
2001-03-10 16:25:40 -07:00
| | Contains the units sounds of the neutral race.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/sounds/neutral/units/<i>{unit}</i></b>
2001-03-10 16:25:40 -07:00
| | Contains the special sounds of the unit of the neutral race.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/sounds/neutral/units/<i>{unit}</i>/acknowledgement</b>
2001-03-10 16:25:40 -07:00
| | Contains the acknowledgement sound of the unit of
| | the neutral race.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/sounds/neutral/units/<i>{unit}</i>/annoyed</b>
2001-03-10 16:25:40 -07:00
| | Contains the annoyed sound of the unit of the neutral
| | race.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/sounds/neutral/units/<i>{unit}</i>/selected</b>
2001-03-10 16:25:40 -07:00
| Contains the selected sound of the unit of the neutral
| race.
|
2003-04-22 18:44:03 -06:00
}-- <b>data/sounds/spells</b>
2001-03-10 16:25:40 -07:00
| Contains the sounds of the different spells.
|
2003-04-22 18:44:03 -06:00
}-- <b>data/sounds/ui</b>
2001-03-10 16:25:40 -07:00
| Contains the sounds for the user interface.
|
2003-04-22 18:44:03 -06:00
}-- <b>data/sounds/ships</b>
2001-06-07 17:17:02 -06:00
| | Contains the sounds of ships common for all races.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/sounds/ships/<i>{unit}</i></b>
2001-06-07 17:17:02 -06:00
| | Contains the sounds of this unit.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/sounds/ships/<i>{unit}</i>/acknowledgement</b>
2001-06-07 17:17:02 -06:00
| | Contains the acknowledgement sound of this unit.
| |
2003-04-22 18:44:03 -06:00
| }-- <b>data/sounds/ships/<i>{unit}</i>/annoyed</b>
2001-06-07 17:17:02 -06:00
| | Contains the annoyed sound of this unit.
| |
2003-04-22 18:44:03 -06:00
| `-- <b>data/sounds/ships/<i>{unit}</i>/selected</b>
2001-06-07 17:17:02 -06:00
| Contains the selected sound of this unit.
|
2003-04-22 18:44:03 -06:00
`-- <b>data/sounds/units</b>
2001-03-10 16:25:40 -07:00
| Contains the sounds of units common for all races.
|
2003-04-22 18:44:03 -06:00
`-- <b>data/sounds/units/<i>{unit}</i></b>
2001-03-10 16:25:40 -07:00
| Contains the sounds of this unit.
|
2003-04-22 18:44:03 -06:00
}-- <b>data/sounds/units/<i>{unit}</i>/acknowledgement</b>
2001-03-10 16:25:40 -07:00
| Contains the acknowledgement sound of this unit.
|
2003-04-22 18:44:03 -06:00
}-- <b>data/sounds/units/<i>{unit}</i>/annoyed</b>
2001-03-10 16:25:40 -07:00
| Contains the annoyed sound of this unit.
|
2003-04-22 18:44:03 -06:00
`-- <b>data/sounds/units/<i>{unit}</i>/selected</b>
2001-03-10 16:25:40 -07:00
Contains the selected sound of this unit.
2003-05-03 06:56:38 -06:00
</pre>
2003-05-19 12:32:54 -06:00
<hr>
(C) Copyright 1998-2004 by The <a href="http://stratagus.sf.net">Stratagus</a> Project
2003-05-19 12:32:54 -06:00
under the <a href="gpl.html">GNU General Public License</a>.<br>
All trademarks and copyrights on this page are owned by their respective owners.<br>
</body>
</html>