Difference between revisions of "OXPConfig"

From Elite Wiki
m
m (Added deprecated flag)
 
(59 intermediate revisions by 8 users not shown)
Line 1: Line 1:
−
[[Image: OXPConfig_compatible.png|140px|thumb|This sign shows that a oxp is configurable by OXPConfig]]
  
  +
[[Image:OXPConfig_logo.png|150px|right]]
−
===STORY===
 +
==Overview==
−
'''''Ouch, that is weird! Why doesn't it work? What the heck...!?!'''''
 +
{{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.
   
−
Have you ever seen such comments about oxps? But not always it is an error in this particular oxp. Very often it happens that several oxps are trying to do their business at the same time (e.g. displaying a missionscreen or playing a music- or soundfile). Usually the last oxp overrides the other commands and everything is fine. But not always and then very strange things can happen.
  
  +
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).
   
−
For a user the only chance to avoid it is to remove oxps from the AddOns folder, but this is not a very elegant way to handle this. And with nearly 200 oxps out there it is a timeintensive task, sorting them, moving them in and out - every day. Again and again. And before Eric Walchs solution for the missionscreen-handling the potential for clashes was immense, but there are still a few oxps that need some tweaks to avoid this problem. And there are more possible clashes. Music- and soundfiles can collide, even complete missions can get broken and the user will never be able to finish them. That's why I wrote OXPConfig. A small tool to help scripters and users, because it gives everybody the ability to enable/disable special features of oxps (like the enhanced logging) that are supporting this.
  
  +
* List of supported [[:Category:OXPConfig-compatible OXPs|OXPConfig-compatible OXPs]] - currently {{PAGESINCATEGORY:OXPConfig-compatible OXPs}}.
   
−
And with a detailed logfile it will be a lot easier to see what happened... ...and to fix it. The BulletinBoard is always the best place to report problems with oxps and there are a lot of helpful and experienced oxp'er (not to mention the development team) ready to stick their nose into your problem. So every bit of information can help to recognize the weak points and before you'll post it there, collect all necessary data (OS, OS-version, Oolite version, Latest.log, stderr.txt). A few oxps are already supporting enhanced logging features [[BuoyRepair|BuoyRepair]], [[Famous_Planets_OXP|Famous_Planets]], [[Hyperradio_js_OXP|Hyperradio]], [[Localhero_OXP|Localhero]], [[OXPConfig|OXPConfig]], [[ScriptTimer]], [[Vector_OXP|Vector]] and [[Welcome_Mat_OXP|Welcome Mat]] and I hope that more oxps will use this way in future releases to be included into the database.
  
  +
==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.
   
−
===FEATURES===
  
  +
The changes have been applied to the OXPs, but nothing is stored yet. To do it:
−
* Storing and loading of configurations
  
  +
* Choose 'Store configuration'.
−
* Automatic loading when Oolite is started (configurable)
  
  +
* Then exit OXPConfig and save the game as usual. If these two steps are skipped the changes are temporary.
−
* Selective loading of changed oxps (configurable)
  
−
* Default configuration is stored and can be reloaded
  
−
* Internal logging (configurable)
  
   
−
===OVERVIEW===
 +
==Features==
−
This tool gives you the ability to configure several oxps. It changes internal (local) settings of the oxps to enable (or disable) logging or audio functions and special settings to recognize errors or to avoid clashes, but it is for sure no cheat-tool. The oxps have to support these functions too - to be implemented in the database - so not every oxp can be included.
 +
* 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.
   
−
This oxp 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). Compatible oxps can use this sign to show that they support OXPConfig.
  
  +
==Requirements==
  +
* Latest version needs Oolite v1.77.
  +
* [[Cabal_Common_Library|Cabal_Common_Library1.7]].
   
−
The handling is simple. Dock at a main station, open the Options-Menue (F2), then step to the Gameoptions (where you can change Oolites options). Wait till you get a message that the OXPConfig is activated and step directly to the SYSTEM_DATA_SCREEN (F7).
  
  +
==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).
   
−
To deactivate it step to any other screen (you'll get a message).
 
  +
<!--* Mirror -> [https://www.dropbox.com/s/wlocyoab95bhlj6/OXPConfig2.2.4.zip OXPConfig2.2.4.zip] - (97.2 KB)-->
   
−
===REQUIREMENTS===
  
−
Oolite v1.72 - No other [[OXP]] necessary - put in what you like.
 
   
−
===DOWNLOAD===
  
  +
For Oolite v1.76.1:
−
[[Media:OXPConfig1.06.zip|OXPConfig1.06.zip]] - (12KB) Updated 03/11/2008.
  
  +
* [http://deephorizonindustries.com/Downloads/OXPConfig2.0.14.zip OXPConfig2.0.14.zip] - (97.2 KB)
   
−
{{unclassified-OXP}} [[Category:Oolite utilities]][[Category:OXPConfig-compatible OXPs]]
  
  +
  +
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"