Difference between revisions of "Randomshipnames OXP"

From Elite Wiki
Jump to: navigation, search
(setting up the page)
 
(v1.6)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
  
This OXP adds randomly generated names to almost all normal ship classes (except police, military, and Thargoids) in Oolite.
+
This [[OXP]] adds randomly generated names to almost all normal ship classes (except Thargoids) in Oolite.
  
 
== Overview ==
 
== Overview ==
  
 
Randomshipnames.oxp does exactly what it says on the tin: assigning randomly generated names to the ships you meet in your Ooniverse. A big thank you goes to "Disembodied" for not only coming up with useful naming schemes, but also providing huge word lists as fodder for the random generator.
 
Randomshipnames.oxp does exactly what it says on the tin: assigning randomly generated names to the ships you meet in your Ooniverse. A big thank you goes to "Disembodied" for not only coming up with useful naming schemes, but also providing huge word lists as fodder for the random generator.
 +
 +
=== Disabling/enabling random naming (note to ship designers) ===
 +
 +
You can exclude any ship of yours from getting a random name through this OXP. You can do this by using the script_info-key in shipdata.plist. Insert a value named randomshipnames and set it to no. Now your ship won't get a name through this OXP.
 +
 +
If you want to copy and paste, this is what it looks like in OpenStep:
 +
"script_info" =        {
 +
    "randomshipnames" = "no";
 +
};
 +
 +
And this is what it looks like in XML:
 +
<key>script_info</key>
 +
<dict>
 +
<key>randomshipnames</key>
 +
<string>no</string>
 +
</dict>
 +
 +
In the same way you can include a ship with a custom role in one of the categories used by this OXP by setting the same script_info-key to one of the following values:
 +
"script_info" =        {
 +
    "randomshipnames" = "trader";
 +
};
 +
"script_info" =        {
 +
    "randomshipnames" = "hunter";
 +
};
 +
"script_info" =        {
 +
    "randomshipnames" = "pirate";
 +
};
 +
"script_info" =        {
 +
    "randomshipnames" = "rockhermit";
 +
};
 +
"script_info" =        {
 +
    "randomshipnames" = "police";
 +
};
 +
"script_info" =        {
 +
    "randomshipnames" = "military";
 +
};
 +
Then it will get a random name just like the other ships in the same category.
 +
 +
=== Using the naming engine for your own ships ===
 +
 +
Sometimes you may want to use randomshipnames' naming engine in your own script. This is also possible. You can call the naming functions from any script like this:
 +
worldScripts.randomshipnames.$randomTraderName(ship) // returns a random name for a trader or other civilian ship
 +
worldScripts.randomshipnames.$randomHunterName(ship) // returns a random name for a hunter, escort, or any aggressive, but not malevolent ship
 +
worldScripts.randomshipnames.$randomPirateName(ship) // returns a random name for a pirate, or any aggressive and malevolent ship
 +
worldScripts.randomshipnames.$randomRockhermitName(ship) // returns a random name for a rockhermit, or another stationary object
 +
worldScripts.randomshipnames.$randomPoliceName(ship) // returns a random numbers-and-letter designation for a police or military ship
 +
All naming functions take a ship object as parameter.
 +
 +
=== Attaching external name engines ===
 +
 +
Following a [http://aegidian.org/bb/viewtopic.php?f=4&t=11737&start=120#p224942 request] you can define your own ship names based on [http://wiki.alioth.net/index.php/Oolite_JavaScript_Reference:_Ship#primaryRole primaryRole]. An example:
 +
 +
this.name="numberedcoriolis";
 +
this.startUp = function() {
 +
        var w = worldScripts.randomshipnames;
 +
        if( w ) w.$externalNameEngine(this.name, "coriolis", 1);
 +
}
 +
this.$randomName = function(ship) {
 +
        return(ship.displayName+": "+ship.entityPersonality);
 +
}
 +
The first parameter of $externalNameEngine is the name of your worldScript, second is the primary role of the ships you rename in your $randomName function. Third is the probability of the callback between 0 and 1 where 1 mean always, 0.1 mean only the 10% of ships with the given primaryRole will be named by your function, others will get names from randomshipnames.
 +
  
 
== Minimum Requirements ==
 
== Minimum Requirements ==
  
Randomshipnames.oxp requires at least Oolite 1.75.
+
Randomshipnames.oxp requires at least Oolite 1.77.
  
 
== Download Location ==
 
== Download Location ==
  
Randomshipnames.oxp is available for download via [http://www.box.com/s/1k8k34v34vqtb094u24f box.com].
+
[[Media:Randomshipnames.1.6.oxz|Randomshipnames.1.6.oxz‎]] (downloaded {{#downloads:Randomshipnames.1.6.oxz‎}} times).
 +
 
 +
Randomshipnames.oxp v 1.4 is available for download via [https://app.box.com/s/l3xemuvjlii619yy038k box.com].
  
 
== Installation ==
 
== Installation ==
  
Move or copy the file randomshipnames.oxp from its download folder into your AddOns folder. Where that resides depends on your installation. Restart Oolite.
+
Move or copy the file randomshipnames1.4.oxp from its download folder into your AddOns folder. Where that resides depends on your installation. Make sure to remove any previous versions. Restart Oolite.
  
 
== Examples ==
 
== Examples ==
Line 27: Line 91:
 
Image:Randomname04.png|A big trade ship making a statement.
 
Image:Randomname04.png|A big trade ship making a statement.
 
Image:Randomname05.png|A pirate doing the same.
 
Image:Randomname05.png|A pirate doing the same.
 +
Image:Randomname06.png|One of GalCop's finest.
 +
Image:Randomname07.png|It's clear who is the boss in here.
 
</gallery>
 
</gallery>
  
 +
[http://aegidian.org/bb/viewtopic.php?f=4&t=11737 Forum]
  
 
{{ambience-OXP}}
 
{{ambience-OXP}}

Latest revision as of 23:08, 12 October 2014

Introduction

This OXP adds randomly generated names to almost all normal ship classes (except Thargoids) in Oolite.

Overview

Randomshipnames.oxp does exactly what it says on the tin: assigning randomly generated names to the ships you meet in your Ooniverse. A big thank you goes to "Disembodied" for not only coming up with useful naming schemes, but also providing huge word lists as fodder for the random generator.

Disabling/enabling random naming (note to ship designers)

You can exclude any ship of yours from getting a random name through this OXP. You can do this by using the script_info-key in shipdata.plist. Insert a value named randomshipnames and set it to no. Now your ship won't get a name through this OXP.

If you want to copy and paste, this is what it looks like in OpenStep:

"script_info" =         {
    "randomshipnames" = "no";
};

And this is what it looks like in XML:

<key>script_info</key>
<dict>
	<key>randomshipnames</key>
	<string>no</string>
</dict>

In the same way you can include a ship with a custom role in one of the categories used by this OXP by setting the same script_info-key to one of the following values:

"script_info" =         {
    "randomshipnames" = "trader";
};
"script_info" =         {
    "randomshipnames" = "hunter";
};
"script_info" =         {
    "randomshipnames" = "pirate";
};
"script_info" =         {
    "randomshipnames" = "rockhermit";
};
"script_info" =         {
    "randomshipnames" = "police";
};
"script_info" =         {
    "randomshipnames" = "military";
};

Then it will get a random name just like the other ships in the same category.

Using the naming engine for your own ships

Sometimes you may want to use randomshipnames' naming engine in your own script. This is also possible. You can call the naming functions from any script like this:

worldScripts.randomshipnames.$randomTraderName(ship) // returns a random name for a trader or other civilian ship
worldScripts.randomshipnames.$randomHunterName(ship) // returns a random name for a hunter, escort, or any aggressive, but not malevolent ship
worldScripts.randomshipnames.$randomPirateName(ship) // returns a random name for a pirate, or any aggressive and malevolent ship
worldScripts.randomshipnames.$randomRockhermitName(ship) // returns a random name for a rockhermit, or another stationary object
worldScripts.randomshipnames.$randomPoliceName(ship) // returns a random numbers-and-letter designation for a police or military ship

All naming functions take a ship object as parameter.

Attaching external name engines

Following a request you can define your own ship names based on primaryRole. An example:

this.name="numberedcoriolis";
this.startUp = function() {
       var w = worldScripts.randomshipnames;
       if( w ) w.$externalNameEngine(this.name, "coriolis", 1);
}
this.$randomName = function(ship) {
       return(ship.displayName+": "+ship.entityPersonality);
}

The first parameter of $externalNameEngine is the name of your worldScript, second is the primary role of the ships you rename in your $randomName function. Third is the probability of the callback between 0 and 1 where 1 mean always, 0.1 mean only the 10% of ships with the given primaryRole will be named by your function, others will get names from randomshipnames.


Minimum Requirements

Randomshipnames.oxp requires at least Oolite 1.77.

Download Location

Randomshipnames.1.6.oxz‎ (downloaded 10560 times).

Randomshipnames.oxp v 1.4 is available for download via box.com.

Installation

Move or copy the file randomshipnames1.4.oxp from its download folder into your AddOns folder. Where that resides depends on your installation. Make sure to remove any previous versions. Restart Oolite.

Examples

Forum