| Revision as of 22:24, 22 October 2007 Bobirov (Talk | contribs) ← Previous diff |
Revision as of 15:16, 29 October 2007 Gcamp (Talk | contribs) <font color=orange>Description</font> Next diff → |
||
| Line 2: | Line 2: | ||
| ==<font color=orange>Description</font>== | ==<font color=orange>Description</font>== | ||
| - | Rather than being stored in a single file like the accessories, Scorched 3D's landscapes are spread out over a series of different files. Each file contains the different aspects that come together to define the overall result that you see in the game. These aspects include the size/shape of the landscape, the texturing/skin of the landscape, as well as events that occur on that landscape and the objects and sounds that are placed on that landscape. | ||
| - | A brief description and links to more information about these files and what they contain follows: | + | Scorched3D allows each mod to define a set of landscapes (or to modify the existing landscapes). |
| - | * [[landscapes.xml]] - This is the main landscapes file which brings the rest together. It contains some basic info about the landscape and determines which definition files and which texture files can be used by this landscape. | + | Rather than being stored in a single file like the accessories, Scorched 3D's landscapes are spread out over a series of different files. Each file contains the different aspects that come together to define the overall result that you see in the game. |
| - | * [[Ambient Sound Files]] - Used to define ambient sound timing and placements. | + | Landscapes are defined in two parts:- |
| + | # The physical structure of the landscape. This includes details like how large the landscape and how hilly it is. These are defined in landscape definition files. | ||
| + | # The visuals/skin of the landscape. This includes details like what color the landscape is and how many tress it has. These are defined in landscape texture files. | ||
| - | * [[Boid Files]] - Define properties of boids (birds and other things in the air). | + | Each of these aspects (visual and physcial) have a set of different properties that can be defined. |
| - | * [[Definition Files]] - Used to determine the landscapes size, shape and also the tank placements. Can also reference placements, sounds, boids, ships or events as well. | + | Splitting these two concepts into seperate files allows each different visual to be applied to all physical landscapes increasing the variety and combinations of landscapes. |
| - | * [[Event Files]] - Definitions for events which fire off certain xml contained in the accessories file. | + | ==<font color=orange>Structure</font>== |
| - | * [[Object Placement Files]] - Used to place objects of various types about the landscape. | + | All landscapes are defined in the [[landscapes.xml]] file. This is the main file for all the landscapes. It contains some basic info about the landscape and determines which [[Definition Files]] and which [[Texture Files]] can be used by this landscape. |
| - | * [[Ship Files]] - Stores groupings for ships that can be placed around the landscape. | + | The [[Definition Files]] and [[Texture Files]] then in turn also reference/include other [[Include Files]] to build up a definition of the landscape. These include files can be used by any number of texture/definition files and help to keep the landscapes definitions modular. |
| + | |||
| + | [[landscapes.xml]] | ||
| + | | | ||
| + | +--> [[Definition Files]] | ||
| + | | | | ||
| + | | +--> [[Include Files]] | ||
| + | | | ||
| + | +--> [[Texture Files]] | ||
| + | | | ||
| + | +--> [[Include Files]] | ||
| + | |||
| + | |||
| + | ==<font color=orange>Reference</font>== | ||
| + | |||
| + | * [[landscapes.xml]] - This is the main landscapes file which brings the rest together. It contains some basic info about the landscape and determines which definition files and which texture files can be used by this landscape. | ||
| + | |||
| + | * [[Definition Files]] - Used to determine the landscapes size, shape and also the tank placements. Can also reference placements, sounds, boids, ships or events as well. | ||
| * [[Texture Files]] - Defines the texturing of the landscape and surrounding area and precipitation. Can also reference boids, events, placements, ships and ambient sounds. | * [[Texture Files]] - Defines the texturing of the landscape and surrounding area and precipitation. Can also reference boids, events, placements, ships and ambient sounds. | ||
| - | * [[Include Files]] - New to v41, include files can be referenced in a texture or definition file and can contain any number of placement, movement, sound, options, events, etc. | + | * [[Include Files]] - New to v41, include files can be referenced in a texture or definition file and can define any of the other concepts including object placement and movement, sound, per level options, events, etc. |
| ==<font color=orange>Locations</font>== | ==<font color=orange>Locations</font>== | ||
Contents |
Scorched3D allows each mod to define a set of landscapes (or to modify the existing landscapes).
Rather than being stored in a single file like the accessories, Scorched 3D's landscapes are spread out over a series of different files. Each file contains the different aspects that come together to define the overall result that you see in the game.
Landscapes are defined in two parts:-
Each of these aspects (visual and physcial) have a set of different properties that can be defined.
Splitting these two concepts into seperate files allows each different visual to be applied to all physical landscapes increasing the variety and combinations of landscapes.
All landscapes are defined in the landscapes.xml file. This is the main file for all the landscapes. It contains some basic info about the landscape and determines which Definition Files and which Texture Files can be used by this landscape.
The Definition Files and Texture Files then in turn also reference/include other Include Files to build up a definition of the landscape. These include files can be used by any number of texture/definition files and help to keep the landscapes definitions modular.
|
+--> Definition Files
| |
| +--> Include Files
|
+--> Texture Files
|
+--> Include Files
The landscapes.xml file is contained in the game's (or your mod's) /data/ directory. The rest of the landscape files should be stored in the /data/landscapes/ directory.
In addition to this documentation, a good way to learn to manipulate the landscapes is to have a look at what has already been done. In addition to looking at the standard files that come with the game, there are plenty of mods available to look through as well. Looking at as much of the xml as you can is a great way to get acquainted with the workings of Scorched 3D.
