Difference between revisions of "OXPConfig"
From Elite Wiki
m (updated categorization) |
(OXPConfig2.0) |
||
| Line 1: | Line 1: | ||
{{Infobox OXP| title = OXPConfig | {{Infobox OXP| title = OXPConfig | ||
| − | |image = [[Image: | + | |image = [[Image:OXPConfig_logo.png|150px]] |
|download = [[#Download|See Download]] | |download = [[#Download|See Download]] | ||
| − | |story = | + | |story = 2010-12-09 |
|ships = No | |ships = No | ||
|stations = No | |stations = No | ||
| Line 9: | Line 9: | ||
|alternativeHUD = No | |alternativeHUD = No | ||
|soundSet = No | |soundSet = No | ||
| − | |version = | + | |version = 2.0 |
|category = Misc OXPs | |category = Misc OXPs | ||
|author = Svengali | |author = Svengali | ||
}} | }} | ||
===Overview=== | ===Overview=== | ||
| − | + | This tool gives you the ability to configure several OXPs. It changes internal (local) settings to enable (or disable) logging or audio functions and special settings to reckognize errors or to avoid clashes. | |
| − | + | OXPConfig runs without the debug-console and is primarily meant for non-scripters (and lazy scripters), but if you really need debug-options it is highly recommended to install the Debug.oxp (written by Ahruman) and if necessary the console (written by Ahruman and ported to Windows by Kaks). | |
| − | + | ===Handling=== | |
| − | + | * Dock at a station, | |
| − | + | * open the Options-Menue (F2), | |
| + | * then step to the Gameoptions (where you can change Oolites options), | ||
| + | * wait till you get a message that OXPConfig is activated, | ||
| + | * and step directly to the SYSTEM_DATA_SCREEN (F7). | ||
===Features=== | ===Features=== | ||
| − | * | + | * Loading, storing and resetting to defaults of configurations. |
| − | * | + | * 4 booleans. |
| − | * | + | * 4 short unsigned integers (0xff). |
| − | * | + | * 1 unsigned 24Bit integer (0xffffff) that is used as bitmask e.g. to en/disable appearance of entities. |
| − | * | + | * Minimum version checks. |
| + | * Early calls of OXPs startUp function if flag is set. | ||
| + | * Early settings if OXPConfig has collected the data and flag is set. | ||
| + | * Notification for OXPs about changed settings if flag is set. Calls oxpcNotifyOnChange(). | ||
| − | === | + | ===Configuration=== |
| − | + | OXPConfig can be configured like the other oxps: | |
| − | + | * '''logging''': en/disables the extended logging in OXPConfig. This is quite verbose and slows down the whole processing and it's primary goal is to give developers insight in the internal ongoings and to locate problems. | |
| − | + | * '''logEarly''': en/disables the logging of OXPs which have set the EarlyCall flag. If OXPConfig calls the startUp it will log this event. Additionally this switch is for measuring the time OXPConfig needs for it's own startUp, including collecting data from all OXPs, calling the startUp's, building it's search trees and applying settings. The time is quantised in units of maybe 50/60ms or 16 ms or 10ms or ..., depending on system. | |
| + | * '''displayAll''': en/disables collecting data from all OXPs which are declaring oxpcSettings. If false OXPConfig will only check OXPs which are in it's internal database and removes entries which are not declaring the necessary settings. | ||
| + | * '''collectAll''': en/disables collecting of data from all worldScripts. This can be pretty slow if hundreds of OXPs are installed and in combination with logging enabled it can lead to aborting by Oolites timelimiter in trunk (though if I haven't seen it yet). | ||
| − | + | Changes to OXPConfigs displayAll and collectAll require a restart to take effect. All switches are false by default. The integer settings are only there as examples and have no real function for OXPConfig itself. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Requirements=== | ===Requirements=== | ||
| − | * Oolite v1. | + | * Oolite v1.74.2 |
| − | * | + | * [[Cabal_Common_Library|Cabal_Common_Library]] |
===Download=== | ===Download=== | ||
| − | {{OXPLevel|0}}[http://www.box.net/shared/ | + | {{OXPLevel|0}} |
| + | * [http://www.box.net/shared/h8dz74u39m OXPConfig2.0.zip] - (36.8 KB) | ||
| + | |||
| + | For OXP-Developers: | ||
| + | * [http://www.box.net/shared/6j9tef7y1r OXPConfig_QuickGuide.zip] - (754.9 KB) | ||
| + | |||
{{misc-OXP}} [[Category:Oolite utilities]][[Category:OXPConfig-compatible OXPs]] | {{misc-OXP}} [[Category:Oolite utilities]][[Category:OXPConfig-compatible OXPs]] | ||
Revision as of 12:47, 9 December 2010
| OXPConfig | |
|---|---|
| |
| Download Link | See Download |
| Version | 2.0 |
| History | 2010-12-09 |
| Stations | No |
| Ships | No |
| Missions | No |
| Equipment | No |
| Alternative HUD Available |
No |
| Sound Set Available |
No |
| Category | Misc OXPs |
| Author | Svengali |
Overview
This tool gives you the ability to configure several OXPs. It changes internal (local) settings to enable (or disable) logging or audio functions and special settings to reckognize errors or to avoid clashes.
OXPConfig runs without the debug-console and is primarily meant for non-scripters (and lazy scripters), but if you really need debug-options it is highly recommended to install the Debug.oxp (written by Ahruman) and if necessary the console (written by Ahruman and ported to Windows by Kaks).
Handling
- Dock at a station,
- open the Options-Menue (F2),
- then step to the Gameoptions (where you can change Oolites options),
- wait till you get a message that OXPConfig is activated,
- and step directly to the SYSTEM_DATA_SCREEN (F7).
Features
- Loading, storing and resetting to defaults of configurations.
- 4 booleans.
- 4 short unsigned integers (0xff).
- 1 unsigned 24Bit integer (0xffffff) that is used as bitmask e.g. to en/disable appearance of entities.
- Minimum version checks.
- Early calls of OXPs startUp function if flag is set.
- Early settings if OXPConfig has collected the data and flag is set.
- Notification for OXPs about changed settings if flag is set. Calls oxpcNotifyOnChange().
Configuration
OXPConfig can be configured like the other oxps:
- logging: en/disables the extended logging in OXPConfig. This is quite verbose and slows down the whole processing and it's primary goal is to give developers insight in the internal ongoings and to locate problems.
- logEarly: en/disables the logging of OXPs which have set the EarlyCall flag. If OXPConfig calls the startUp it will log this event. Additionally this switch is for measuring the time OXPConfig needs for it's own startUp, including collecting data from all OXPs, calling the startUp's, building it's search trees and applying settings. The time is quantised in units of maybe 50/60ms or 16 ms or 10ms or ..., depending on system.
- displayAll: en/disables collecting data from all OXPs which are declaring oxpcSettings. If false OXPConfig will only check OXPs which are in it's internal database and removes entries which are not declaring the necessary settings.
- collectAll: en/disables collecting of data from all worldScripts. This can be pretty slow if hundreds of OXPs are installed and in combination with logging enabled it can lead to aborting by Oolites timelimiter in trunk (though if I haven't seen it yet).
Changes to OXPConfigs displayAll and collectAll require a restart to take effect. All switches are false by default. The integer settings are only there as examples and have no real function for OXPConfig itself.
Requirements
- Oolite v1.74.2
- Cabal_Common_Library
Download
| 0 |
- OXPConfig2.0.zip - (36.8 KB)
For OXP-Developers:
- OXPConfig_QuickGuide.zip - (754.9 KB)
