Difference between revisions of "OXPConfig"

From Elite Wiki
m (→‎OVERVIEW)
m (Added deprecated flag)
 
(71 intermediate revisions by 11 users not shown)
Line 1: Line 1:
−
[[Image: OXPConfig_compatible.png|frame|This sign shows that a oxp is configurable by OXPConfig]].
  
  +
[[Image:OXPConfig_logo.png|150px|right]]
−
===OVERVIEW===
 +
==Overview==
−
This tool gives you the ability to configure several oxps. It changes internal (local) settings of the oxps to enable (or disable)
 +
{{OXPNote|This AddOn is deprecated. Please use [[Library]] for new AddOns}}
−
logging or audio functions and special settings to recognize errors or to avoid clashes, but it is for sure no cheat-tool.
 +
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.
−
The oxps have to support these functions too - to be implemented in the data-base - so not every oxp can be included.
  
   
−
This oxp runs without the debug-console and is primarily meant for non-scripters, but if you really need debug-options
 +
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).
−
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).
  
   
−
Currently there are seven oxps included (released or coming):
  
  +
* List of supported [[:Category:OXPConfig-compatible OXPs|OXPConfig-compatible OXPs]] - currently {{PAGESINCATEGORY:OXPConfig-compatible OXPs}}.
−
BuoyRepair, Famous_PlanetsA, Hyperradio, Localhero, OXPConfig, ScriptTimer and Welcome Mat.
  
   
−
===FEATURES===
 +
==Handling==
−
* Storing and loading of configurations
 +
* Dock at a station,
−
* Automatic loading when Oolite is started (configurable)
 +
* open the Options Menu (F2),
−
* Selective loading of changed oxps (configurable)
 +
* then step to the Game Options (where you can change Oolites options),
−
* Default configuration is stored and can be reloaded
 +
* wait till you get a message that OXPConfig is activated,
−
* Internal logging (configurable)
 +
* and step directly to the SYSTEM DATA SCREEN (F7).
  +
* Modify settings and step to the main menue.
   
−
===HANDLING===
  
  +
The changes have been applied to the OXPs, but nothing is stored yet. To do it:
−
Dock at a station, open the Options-Menue (F2), then step to the Gameoptions (where you can change Oolites options).
  
  +
* Choose 'Store configuration'.
−
Wait till you get a message that the OXPConfig is activated and step directly to the SYSTEM_DATA_SCREEN (F7).
  
  +
* Then exit OXPConfig and save the game as usual. If these two steps are skipped the changes are temporary.
   
−
To deactivate it step to an other screen.
  
  +
==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.
   
−
===DOWNLOAD===
  
  +
==Requirements==
−
[[Media:OxpConfig1.01.zip|OXPConfig1.02.zip]] - (11KB) Updated 25/09/2008. This [[OXP]] requires Oolite v1.71.2 or higher.
  
  +
* Latest version needs Oolite v1.77.
  +
* [[Cabal_Common_Library|Cabal_Common_Library1.7]].
   
−
[[Category:Oolite_expansion_packs]] [[Category:Oolite_Utility]]
  
  +
==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).
  +
  +
<!--* 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]].
  +
  +
==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}}
  +
  +
[[Category:Oolite utilities]]
  +
[[Category:OXPConfig-compatible OXPs]]
  +
[[Category:Deprecated OXPs]]

Latest revision as of 22: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"