Expansion PlanetFall2 BlackMonks

Warnings

1. http://wiki.alioth.net/index.php/PlanetFall2%20BlackMonks -> 404 Not Found
2. Low hanging fuit: Information URL exists...
3. Required Expansions mismatch between OXP Manifest and Expansion Manager at character position 0170 (DIGIT ZERO vs LATIN SMALL LETTER N)
4. No version in dependency reference to oolite.oxp.littlebear.blackmonks:null

Manifest

Documentation

Planetfall Black Monks v2.0 ReadMe & License.txt

Planetfall 2.0 Black Monks Linking OXP by Thargoid.

This is an add-on OXP for PlanetFall v2.0 and above, which introduces the Black Monk Monastery as a possible planet-side location, including the offering of loans and repayment of debts.

Note that the full Bank of Black Monks OXP also needs to be installed for the loans/repayments mission screens to work. Also this OXP requires PlanetFall, and is not compatible with v1.0 or the 1.09 beta versions of the OXP.

--------------------------------------------------------------

License:

This OXP is released under the Creative Commons Attribution - Non-Commercial - Share Alike 3.0 license with the following clauses:

* Whilst you are free (and encouraged) to re-use any of the scripting, models or texturing in this OXP, the usage must be distinct from that within this OXP. Unique identifiers such as (but not limited to) unique shipdata.plist entity keys, mission variables, script names (this.name), equipment identity strings (EQ_), description list arrays and entity roles must not be re-used without prior agreement. Basically if it's unique or would identify or overwrite anything in the original OXP, then you may not re-use it (for obvious compatibility reasons).
* rebundling of this OXP within another distribution is permitted as long as it is unchanged. The following derivates however are permitted and except from the above:
	* the conversion of files between XML and openStep.
	* the merging of files with other files of the same type from other OXPs.
* The license information (either as this file or merged into a larger one) must be included in the OXP.
* Even though it is not compulsory, if you are re-using any sizable or recognisable piece of this OXP, please let me know :)

AI was used in the creation of the landing site images, https://www.freepik.com/pikaso/ai-image-generator

--------------------------------------------------------------
Instructions:

Unzip the file, and then move the folder "PlanetFall Link - Black Monks 1.0.oxp" to the AddOns directory of your Oolite installation. Then start the game up and the ships should be added. 

--------------------------------------------------------------

Version history:

04/01/2009 - Version 1.0, full release.
07/04/2026 - Version 2.0, updated work work with PlanetFall 2.0.
09/04/2026 - Version 2.1, added Library Config options to control where planetside locations can be spawned.

--------------------------------------------------------------

Acknowledgements:

With thanks to LittleBear for agreeing to allow his OXP to be linked into PlanetFall.

Equipment

Ships

Models

Scripts

"use strict";
this.name = "PlanetFall2_BlackMonks";
this.author = "phkb";
this.copyright = "Creative Commons Attribution - Non-Commercial - Share Alike 4.0 license.";
this.description = "Script for PF2 Black Monks";

this._spawn = {
    mainPlanet: true,
    extraPlanets: true,
    moons: true
};

this._bmConfig = {
    Name: this.name,
    Display: expandMissionText("pf_blackmonks_config"),
    Alias: expandMissionText("pf_blackmonks_title"),
    Alive: "_bmConfig",
	Bool: {
		B0: { Name: "_spawn.mainPlanet", Def: true, Desc: expandMissionText("pf_blackmonks_main") },
		B1: { Name: "_spawn.extraPlanets", Def: true, Desc: expandMissionText("pf_blackmonks_extra") },
		B2: { Name: "_spawn.moons", Def: true, Desc: expandMissionText("pf_blackmonks_moons") },
		Info: expandMissionText("pf_blackmonks_bool_info")
	},
};

this.startUp = function() {
	var pf = worldScripts.PlanetFall2;
    pf._landingImages["blackmonks"] = ["blackmonks_1.png", "blackmonks_2.png", "blackmonks_3.png", "blackmonks_4.png", "blackmonks_5.png", "blackmonks_6.png", "blackmonks_7.png", "blackmonks_8.png"];
    pf._landingImages["blackmonks_moon"] = ["blackmonks_moon_1.png", "blackmonks_moon_2.png", "blackmonks_moon_3.png", "blackmonks_moon_4.png"];

    var pfai = worldScripts.planetFall2_priorityAI;
    pfai._landingPriority["planetFall2_mainSurface_blackMonks"] = 2;
    pfai._landingPriority["planetFall2_subSurface_blackMonks"] = 2;
    pfai._landingPriority["planetFall2_moonSurface_blackMonks"] = 2;

    if (missionVariables.PF2BlackMonks) this._spawn = JSON.parse(missionVariables.PF2BlackMonks);
}

this.startUpComplete = function() {
    // register our settings, if Lib_Config is present
    if (worldScripts.Lib_Config) {
        worldScripts.Lib_Config._registerSet(this._bmConfig);
    }
}

this.playerWillSaveGame = function() {
    missionVariables.PF2BlackMonks = JSON.stringify(this._spawn);
}

"use strict";
this.name = "PlanetFall2_BlackMonks_Conditions";
this.author = "phkb";
this.copyright = "CC-BY-SA-NC 4.0";
this.description = "Condition script";

//-------------------------------------------------------------------------------------------------------------
// ship condition script
this.allowSpawnShip = function(shipKey) {
	switch (shipKey) {
		case "planetFall2_mainSurface_blackMonks":
			if (worldScripts.blackmonks.$monkSystemIDs.indexOf(system.ID) >= 0 && worldScripts.PlanetFall2_BlackMonks._spawn.mainPlanet) return true;
			break;
		case "planetFall2_subSurface_blackMonks":
			if (worldScripts.blackmonks.$monkSystemIDs.indexOf(system.ID) >= 0 && worldScripts.PlanetFall2_BlackMonks._spawn.extraPlanets) return true;
			break;
		case "planetFall2_moonSurface_blackMonks":
			if (worldScripts.blackmonks.$monkSystemIDs.indexOf(system.ID) >= 0 && worldScripts.PlanetFall2_BlackMonks._spawn.moons) return true;
			break;
	}
	return false;
}