Difference between revisions of "OXP howto"
From Elite Wiki
m (→Config) |
(more structure) |
||
| Line 1: | Line 1: | ||
[[Image:oolite-oxp-icon.png|100px|right|OXP icon]] |
[[Image:oolite-oxp-icon.png|100px|right|OXP icon]] |
||
== OXP Overview== |
== OXP Overview== |
||
| + | |||
| + | |||
An Oolite Expansion Pack can cause many big changes or additions to Oolite's gameplay, or it may represent just a small, subtle alteration. By appearances, there is no way to tell what is inside, as it's merely a folder with the added extention '''.oxp'''. Inside, it will at least contain a folder named ''Config'', and possibly other folders such as ''AIs'', ''Models'', ''Textures'', ''Sounds'', etc. It is down to the goal of the OXP, which ways to combine elements to the OXP's contents. |
An Oolite Expansion Pack can cause many big changes or additions to Oolite's gameplay, or it may represent just a small, subtle alteration. By appearances, there is no way to tell what is inside, as it's merely a folder with the added extention '''.oxp'''. Inside, it will at least contain a folder named ''Config'', and possibly other folders such as ''AIs'', ''Models'', ''Textures'', ''Sounds'', etc. It is down to the goal of the OXP, which ways to combine elements to the OXP's contents. |
||
| − | == Config== |
||
| − | This folder would contain Property Lists such as: |
||
| + | === AI === |
||
| − | *''[[shipdata.plist]]'' that introduces any new entity (ships, stations, objects etc.) to Oolite |
||
| + | |||
| − | *''[[shipyard.plist]]'' that introduces new ships available for player purchase |
||
| + | The folder named AI would contain any AI.plist additions the OXP might use. |
||
| − | *''[[script.plist]]'' that plots conditional ''script actions'' |
||
| + | |||
| − | *''[[planetinfo.plist]]'' that plots system specific changes from the default. may also contain ''script actions'' |
||
| + | * [[OXP howto AI|Making Oolite AI]] |
||
| − | *''[[commodities.plist]]'' that contains information for each commodity in a market |
||
| + | |||
| + | |||
| + | === Config=== |
||
| + | |||
| + | This folder contains Property Lists such as: |
||
| + | |||
| + | * ''[[shipdata.plist]]'' that introduces any new entity (ships, stations, objects etc.) to Oolite |
||
| + | * ''[[misc plists|shipyard.plist]]'' that introduces new ships available for player purchase |
||
| + | * ''[[OXP howto script|script.plist]]'' that plots conditional ''script actions'' |
||
| + | * ''[[planetinfo.plist]]'' that plots system specific changes from the default. may also contain ''script actions'' |
||
| + | * ''[[commodities.plist]]'' that contains information for each commodity in a market. |
||
| + | * ''[[misc plists|descriptions.plist]]'' that adds vocabulary to Oolite texts. |
||
| + | * ''[[hud.plist]]'' that allows for changes or a radically new ''Head-Up Display''. |
||
| + | * ''[[misc plists|missiontext.plist]]'', ''[[misc plists|demoships.plist]]'', ''[[speech_pronunciation_guide.plist]]'' are some of the other custom methods. |
||
| + | |||
| + | All plist files except for those introducing new AI, belong in Config. |
||
| − | Many other types of plists can also be included in Config when needed. For instance, ''missiontext.plist'', ''demoships.plist'', ''descriptions.plist'', ''speech_pronunciation_guide.plist'' could appear, as well as custom HUDs. Config is where all plist files belong, except for those introducing new AI. |
||
In its simplest form, an OXP could contain only a Config with an altering ''script.plist'' or ''planetinfo.plist''. An OXP that adds a new ship needs a ''shipdata.plist'' entry, and unless it is based entirely on existing Oolite data, would include a model and texture. |
In its simplest form, an OXP could contain only a Config with an altering ''script.plist'' or ''planetinfo.plist''. An OXP that adds a new ship needs a ''shipdata.plist'' entry, and unless it is based entirely on existing Oolite data, would include a model and texture. |
||
* [[OXP howto plist|Making Oolite plists]] |
* [[OXP howto plist|Making Oolite plists]] |
||
| + | * [[OXP howto script|Making Oolite scripts]] |
||
| − | == Models== |
||
| − | Oolite models need to be in the '''.dat''' format. There are utilities available that convert models made in Wings 3D (.obj) and Meshwork (.mesh) into this. A .dat file can be opened in a plain text editor to view the object's assigned texture names and see that they correspond with the actual file names in the Textures folder. The .dat file must be named exactly as it is referenced in the shipdata entry. |
||
| + | === Models=== |
||
| + | |||
| + | Oolite models need to be in the '''.dat''' format. There are utilities available that convert models made in Wings 3D (.obj) and Meshwork (.mesh) into this. A .dat file can be opened in a plain text editor to view the object's assigned texture names and see that they correspond with the actual file names in the Textures folder. The .dat file must be named exactly as it is referenced in the shipdata ''model'' entry. |
||
* [[OXP howto model|Making Oolite models]] |
* [[OXP howto model|Making Oolite models]] |
||
| − | == Textures== |
||
| − | Oolite's textures are in the '''.png''' format, usually at a standard 512x512 size, and must be named exactly as they appear in the .dat file. Pictures that have other purpose than to skin objects, such as background images for missiontext, would be placed in another folder to be named ''Images''. |
||
| + | === Textures=== |
||
| + | |||
| + | Oolite's textures are in the '''.png''' format, usually at a standard 512x512 size, and must be named exactly as they are named in the .dat file. |
||
* [[OXP howto texture|Making Oolite textures]] |
* [[OXP howto texture|Making Oolite textures]] |
||
| Line 34: | Line 52: | ||
== External links == |
== External links == |
||
| − | *[http://oolite.aegidian.org/cyoship/ Oolite Tutorial |
+ | *[http://oolite.aegidian.org/cyoship/ Oolite Tutorial-Meshwork Shipbuilding] |
| − | *[http://oolite.aegidian.org/cyoship2/ Oolite Tutorial |
+ | *[http://oolite.aegidian.org/cyoship2/ Oolite Tutorial-Wings 3D Shipbuilding] |
[[Category:Oolite]] |
[[Category:Oolite]] |
||
Revision as of 22:05, 19 January 2006
OXP Overview
An Oolite Expansion Pack can cause many big changes or additions to Oolite's gameplay, or it may represent just a small, subtle alteration. By appearances, there is no way to tell what is inside, as it's merely a folder with the added extention .oxp. Inside, it will at least contain a folder named Config, and possibly other folders such as AIs, Models, Textures, Sounds, etc. It is down to the goal of the OXP, which ways to combine elements to the OXP's contents.
AI
The folder named AI would contain any AI.plist additions the OXP might use.
Config
This folder contains Property Lists such as:
- shipdata.plist that introduces any new entity (ships, stations, objects etc.) to Oolite
- shipyard.plist that introduces new ships available for player purchase
- script.plist that plots conditional script actions
- planetinfo.plist that plots system specific changes from the default. may also contain script actions
- commodities.plist that contains information for each commodity in a market.
- descriptions.plist that adds vocabulary to Oolite texts.
- hud.plist that allows for changes or a radically new Head-Up Display.
- missiontext.plist, demoships.plist, speech_pronunciation_guide.plist are some of the other custom methods.
All plist files except for those introducing new AI, belong in Config.
In its simplest form, an OXP could contain only a Config with an altering script.plist or planetinfo.plist. An OXP that adds a new ship needs a shipdata.plist entry, and unless it is based entirely on existing Oolite data, would include a model and texture.
Models
Oolite models need to be in the .dat format. There are utilities available that convert models made in Wings 3D (.obj) and Meshwork (.mesh) into this. A .dat file can be opened in a plain text editor to view the object's assigned texture names and see that they correspond with the actual file names in the Textures folder. The .dat file must be named exactly as it is referenced in the shipdata model entry.
Textures
Oolite's textures are in the .png format, usually at a standard 512x512 size, and must be named exactly as they are named in the .dat file.
