Difference between revisions of "OXPConfig"

From Elite Wiki
m (temporary link)
m (Added deprecated flag)
 
(21 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
[[Image:OXPConfig_logo.png|150px|right]]
 
[[Image:OXPConfig_logo.png|150px|right]]
 
==Overview==
 
==Overview==
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 reckognize 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.
 
  +
{{OXPNote|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).
 
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).
Line 13: Line 14:
 
* 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.
  +
  +
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==
 
==Features==
Line 24: Line 30:
 
* 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.
 
* User Definable Colors - for supporting OXPs.
  +
* Dump declared sounds - logs them to Latest.log.
 
* Dump missionVariables - logs them to Latest.log.
 
* Dump missionVariables - logs them to Latest.log.
 
* Dump worldScript properties - logs them to Latest.log.
 
* Dump worldScript properties - logs them to Latest.log.
   
 
==Requirements==
 
==Requirements==
* Oolite v1.76.1.
+
* Latest version needs Oolite v1.77.
* [[Cabal_Common_Library|Cabal_Common_Library1.6]].
+
* [[Cabal_Common_Library|Cabal_Common_Library1.7]].
   
 
==Download==
 
==Download==
{{OXPNote|Due to exceeding the bandwidth limit a temporary link for [https://www.dropbox.com/s/56013m50s2u3tcp/OXPConfig2.0.14.zip OXPConfig2.0.14.zip] has been established (removed on 2012-12-02)}}
 
  +
* [https://app.box.com/s/gbhv3wgxrpjen31h5n13aovgur5b3ffi OXPConfig2.3.4.zip]
* [https://www.box.com/s/29b4164839186af9e07b OXPConfig2.0.14.zip] - (97.2 KB)
 
  +
* 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).
  +
  +
<!--* Mirror -> [https://www.dropbox.com/s/wlocyoab95bhlj6/OXPConfig2.2.4.zip OXPConfig2.2.4.zip] - (97.2 KB)-->
  +
  +
  +
For Oolite v1.76.1:
  +
* [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]].
 
More infos are available in the [[OXPConfig_Doc|OXPConfig Documentation]].
   
 
==Quick Facts==
 
==Quick Facts==
{{OXPLevel|0}}{{Infobox OXPb| title = OXPConfig
+
{{OXPLevel|0}}{{IconOXP
|version = 2.0.14
+
|ooVersion = "1.77"
|release = 2012-11-22
+
|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
 
|license = CC-by-nc-sa-3.0
 
|features = Config
 
|features = Config
 
|category = Misc OXPs
 
|category = Misc OXPs
|author = Svengali
+
|author = Svengali, Lone_Wolf
 
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=4908 BB-Link]
 
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=4908 BB-Link]
 
}}
 
}}
   
[[Category:Oolite utilities]] [[Category:OXPConfig-compatible OXPs]]
 
  +
{{Required OXP|Cabal Common Library}}
{{Required_OXP|Cabal_Common_Library}}
 
  +
  +
[[Category:Oolite utilities]]
  +
[[Category:OXPConfig-compatible OXPs]]
  +
[[Category:Deprecated OXPs]]

Latest revision as of 23:24, 24 February 2018

OXPConfig logo.png

Overview

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