Difference between revisions of "OXPConfig"

From Elite Wiki
(OXPConfig2.0)
m (Added deprecated flag)
 
(46 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
{{Infobox OXP| title = OXPConfig
  
  +
[[Image:OXPConfig_logo.png|150px|right]]
−
|image = [[Image:OXPConfig_logo.png|150px]]
  
  +
==Overview==
−
|download = [[#Download|See Download]]
  
  +
{{OXPNote|This AddOn is deprecated. Please use [[Library]] for new AddOns}}
−
|story = 2010-12-09
  
  +
This tool gives you the ability to configure several OXPs. It changes settings to enable (or disable) logging or audio functions and special settings to recognize errors or to avoid clashes or to adjust numbers of planets/moons, etc. OXPs can use it in a lot of ways and in most cases it only needs a few additional lines of code.
−
|ships = No
  
−
|stations = No
  
−
|mission = No
  
−
|equipment = No
  
−
|alternativeHUD = No
  
−
|soundSet = No
  
−
|version = 2.0
  
−
|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).
 +
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 Basic-debug.oxp (written by Ahruman) and if necessary the console (written by Ahruman and ported to Windows by Kaks).
   
−
===Handling===
  
  +
* List of supported [[:Category:OXPConfig-compatible OXPs|OXPConfig-compatible OXPs]] - currently {{PAGESINCATEGORY:OXPConfig-compatible OXPs}}.
  +
  +
==Handling==
 
* Dock at a station,
  
* Dock at a station,
−
* open the Options-Menue (F2),
 +
* open the Options Menu (F2),
−
* then step to the Gameoptions (where you can change Oolites options),
 +
* then step to the Game Options (where you can change Oolites options),
 
* wait till you get a message that OXPConfig is activated,
  
* wait till you get a message that OXPConfig is activated,
−
* and step directly to the SYSTEM_DATA_SCREEN (F7).
 +
* and step directly to the SYSTEM DATA SCREEN (F7).
  +
* Modify settings and step to the main menue.
   
−
===Features===
  
  +
The changes have been applied to the OXPs, but nothing is stored yet. To do it:
  +
* Choose 'Store configuration'.
  +
* Then exit OXPConfig and save the game as usual. If these two steps are skipped the changes are temporary.
  +
  +
==Features==
 
* Loading, storing and resetting to defaults of configurations.
  
* Loading, storing and resetting to defaults of configurations.
 
* 4 booleans.
  
* 4 booleans.
Line 34: Line 28:
 
* Early settings if OXPConfig has collected the data and 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().
  
* Notification for OXPs about changed settings if flag is set. Calls oxpcNotifyOnChange().
  +
* User Definable Colors - for supporting OXPs.
  +
* Dump declared sounds - logs them to Latest.log.
  +
* Dump missionVariables - logs them to Latest.log.
  +
* Dump worldScript properties - logs them to Latest.log.
   
−
===Configuration===
  
  +
==Requirements==
−
OXPConfig can be configured like the other oxps:
  
  +
* Latest version needs Oolite v1.77.
−
* '''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.
  
  +
* [[Cabal_Common_Library|Cabal_Common_Library1.7]].
−
* '''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.
  
  +
==Download==
  +
* [https://app.box.com/s/gbhv3wgxrpjen31h5n13aovgur5b3ffi OXPConfig2.3.4.zip]
  +
* Download in OXZ format [[Media:OxpConfig_2.3.4.oxz‎ |here]] for Oolite 1.79 or later (downloaded {{#downloads:OXPConfig_2.3.4.oxz}} times).
   
−
===Requirements===
  
  +
<!--* Mirror -> [https://www.dropbox.com/s/wlocyoab95bhlj6/OXPConfig2.2.4.zip OXPConfig2.2.4.zip] - (97.2 KB)-->
−
* Oolite v1.74.2
  
−
* [[Cabal_Common_Library|Cabal_Common_Library]]
  
   
−
===Download===
  
−
{{OXPLevel|0}}
  
−
* [http://www.box.net/shared/h8dz74u39m OXPConfig2.0.zip] - (36.8 KB)
  
   
−
For OXP-Developers:
 +
For Oolite v1.76.1:
−
* [http://www.box.net/shared/6j9tef7y1r OXPConfig_QuickGuide.zip] - (754.9 KB)
 +
* [http://deephorizonindustries.com/Downloads/OXPConfig2.0.14.zip OXPConfig2.0.14.zip] - (97.2 KB)
  +
  +
  +
More infos are available in the [[OXPConfig_Doc|OXPConfig Documentation]].
  +
  +
==Quick Facts==
  +
{{OXPLevel|0}}{{IconOXP
  +
|ooVersion = "1.77"
  +
|oxpCPU = "Medium"
  +
|oxpMEM = "Average"
  +
|oxpGPU = "Low"
  +
|oxpIsParent = true
  +
|oxpIsChild = true
  +
|oxpIsAPI = true
  +
|oxpIsDocumented = true
  +
|oxpIsConfigurable = true
  +
}}
  +
{{Infobox OXPb| title = OXPConfig
  +
|version = 2.3.3
  +
|release = 2015-06-03
  +
|license = CC-by-nc-sa-3.0
  +
|features = Config
  +
|category = Misc OXPs
  +
|author = Svengali, Lone_Wolf
  +
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=4908 BB-Link]
  +
}}
   
  +
{{Required OXP|Cabal Common Library}}
   
−
{{misc-OXP}} [[Category:Oolite utilities]][[Category:OXPConfig-compatible OXPs]]
 +
[[Category:Oolite utilities]]
  +
[[Category:OXPConfig-compatible OXPs]]
  +
[[Category:Deprecated OXPs]]

Latest revision as of 23:24, 24 February 2018

OXPConfig logo.png

Overview

Mr Gimlet.png

Please note:   This AddOn is deprecated. Please use Library for new AddOns.

This tool gives you the ability to configure several OXPs. It changes settings to enable (or disable) logging or audio functions and special settings to recognize errors or to avoid clashes or to adjust numbers of planets/moons, etc. OXPs can use it in a lot of ways and in most cases it only needs a few additional lines of code.

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 Basic-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 Menu (F2),
  • then step to the Game Options (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).
  • Modify settings and step to the main menue.

The changes have been applied to the OXPs, but nothing is stored yet. To do it:

  • Choose 'Store configuration'.
  • Then exit OXPConfig and save the game as usual. If these two steps are skipped the changes are temporary.

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().
  • User Definable Colors - for supporting OXPs.
  • Dump declared sounds - logs them to Latest.log.
  • Dump missionVariables - logs them to Latest.log.
  • Dump worldScript properties - logs them to Latest.log.

Requirements

Download


For Oolite v1.76.1:


More infos are available in the OXPConfig Documentation.

Quick Facts

Levelindicator0.png
0-{{{2}}}

Minimum Oolite versionCPU usage mediumMemory usage averageGPU usage lowisParentisChildisAPIisDocumentedisConfigurable

Version Released License Features Category Author(s) Feedback
2.3.3 2015-06-03 CC-by-nc-sa-3.0 Config Misc OXPs Svengali, Lone_Wolf BB-Link
Retrieved from "http://backup.witchspacewiki.org/index.php?title=OXPConfig&oldid=57023"