FIRST, I'm a total noob. Never programmed, nor taken any classes in java or anything. Also my english sucks. So this will be a very practical guide (for people already accustomed with modding). Here's what I did (
BE CAREFUL, it's quite complicated, and requires a few external program usage). I hope you use an IDE because otherwise it will be hard (impossible as far as i know).
Basically you need a folder structure like this:
1. Standard
scripts folder inside
data folder.
2. Inside
scripts you need both a ModPlugin.java file and a
plugins folder.
3. Inside
plugins you need a CoreCampaignPlugin.java file.
4. (The hard part) you need to create a JAR file containing the station interaction plugin itself.
ModPlugin is the new and cooler generator file (that is still working, for now, but is deprecated), mine looks like this, it basically makes your mod start:
package data.scripts;
import com.fs.starfarer.api.BaseModPlugin;
import com.fs.starfarer.api.Global;
import data.scripts.plugins.*;
public class UsSModPlugin extends BaseModPlugin
{
private static void initUsS()
{
}
@Override
public void onNewGame()
{
Global.getSector().registerPlugin(new UsSCoreCampaignPlugin()); ///THE JAVA THAT MANAGES THE CORE CAMPAIGN PLUGINS, LIKE STATIONS/BATTLES/PLANETS.
initUsS(); ///STANDARD GEN FILE, LIKE THE OLD ONES. IT DOES NOT APPEAR IN MY FOLDERS BECAUSE I DIDN'T WRITE IT YET.
}
}
CoreCampaignPlugin is what manages modded FleetInteractionDialogPlugin, JumpPointInteractionDialogPlugin, PlanetInteractionDialogPlugin, OrbitalStationInteractionDialogPlugin, BattleCreationPlugin. You see, we can do a s**t ton of stuff in this version!
Here is how it looks like for UsS.
package data.scripts.plugins;
import com.fs.starfarer.api.PluginPick;
import com.fs.starfarer.api.campaign.BaseCampaignPlugin;
import com.fs.starfarer.api.campaign.OrbitalStationAPI;
import com.fs.starfarer.api.campaign.PlanetAPI;
import com.fs.starfarer.api.campaign.SectorEntityToken;
import data.scripts.*;
public class UsSCoreCampaignPlugin extends BaseCampaignPlugin {
@Override
public String getId() {
return null;
}
@Override
public boolean isTransient() {
return false;
}
@Override
public PluginPick pickInteractionDialogPlugin(SectorEntityToken interactionTarget) {
if (interactionTarget instanceof OrbitalStationAPI) {
return new PluginPick(new UsSStationInteractionDialogPlugin(), PickPriority.MOD_GENERAL); ///HERE IT IS. UsSStationInteractionDialogPlugin is my implementation of OrbitalStationInteractionDialogPlugin
}
return null;
}
}
Easy huh? NOT!
Here comes the pain. The actual implementation of the plugin NEEDS to be in a Jar. I tried working around that, but Janino (the thing that takes human written code and translate to the game) cannot use stuff inside this particular script, so this needs to be written in something that bypasses Janino. Jar files are pre-compiled compressed java files, so they fit this situation perfectly. How to make a Jar? You need an IDE (like Netbeans, a program to make java stuff), create a folder structure data/scripts with it and add the implementation inside the scripts folder and make it compile it into a Jar file. Also, it needs to be compiled using JDK6, not 7. Questions? I guessed so! Well, ask anything you need here, or find some guides around. It's less hard than one can think when it comes to it.
Anyway Janino will see nothing BUT the game WILL recognize that java file as it was inside the scripts folder! So our CoreCampaignPlugin will activate our working OrbitalStationInteractionDialogPlugin (that is in the Jar instead of outside it)'
Here's my OrbitalStationInteractionDialogPlugin:
package data.scripts;
import com.fs.starfarer.api.Global;
import com.fs.starfarer.api.campaign.CampaignFleetAPI;
import com.fs.starfarer.api.campaign.CoreInteractionListener;
import com.fs.starfarer.api.campaign.CoreUITabId;
import com.fs.starfarer.api.campaign.InteractionDialogAPI;
import com.fs.starfarer.api.campaign.InteractionDialogPlugin;
import com.fs.starfarer.api.campaign.OptionPanelAPI;
import com.fs.starfarer.api.campaign.SectorEntityToken;
import com.fs.starfarer.api.campaign.TextPanelAPI;
import com.fs.starfarer.api.campaign.VisualPanelAPI;
import com.fs.starfarer.api.combat.EngagementResultAPI;
import com.fs.starfarer.api.fleet.FleetMemberAPI;
import java.awt.Color;
import org.lwjgl.input.Keyboard;
public class UsSStationInteractionDialogPlugin implements InteractionDialogPlugin, CoreInteractionListener {
private static enum OptionId {
INIT,
TRADE_CARGO,
TRADE_SHIPS,
REFIT,
REPAIR_ALL,
LEAVE,
}
private InteractionDialogAPI dialog;
private TextPanelAPI textPanel;
private OptionPanelAPI options;
private VisualPanelAPI visual;
private CampaignFleetAPI playerFleet;
private SectorEntityToken station;
private static final Color HIGHLIGHT_COLOR = Global.getSettings().getColor("buttonShortcut");
public void init(InteractionDialogAPI dialog) {
this.dialog = dialog;
textPanel = dialog.getTextPanel();
options = dialog.getOptionPanel();
visual = dialog.getVisualPanel();
playerFleet = Global.getSector().getPlayerFleet();
station = (SectorEntityToken) dialog.getInteractionTarget();
visual.setVisualFade(0.25f, 0.25f);
dialog.setOptionOnEscape("Leave", OptionId.LEAVE);
optionSelected(null, OptionId.INIT);
}
private EngagementResultAPI lastResult = null;
public void backFromEngagement(EngagementResultAPI result) {
// no combat here, so this won't get called
}
public void optionSelected(String text, Object optionData) {
if (optionData == null) return;
OptionId option = (OptionId) optionData;
if (text != null) {
textPanel.addParagraph(text, Global.getSettings().getColor("buttonText"));
}
if (option == OptionId.INIT) {
if (station.getFaction().getRelationship(playerFleet.getFaction().getId()) >= 0) {
addText(getString("approach"));
} else {
addText("The Station weapons activate, you are forced to flee.");
}
createInitialOptions();
if (station.getCustomInteractionDialogImageVisual() != null) {
visual.showImageVisual(station.getCustomInteractionDialogImageVisual());
} else {
visual.showImagePortion("illustrations", "hound_hangar", 800, 800, 0, 0, 400, 400);
}
} else if (option == OptionId.TRADE_CARGO) {
addText(getString("tradeCargo"));
options.clearOptions();
visual.showCore(CoreUITabId.CARGO, station, station.getFaction().isNeutralFaction(), this);
} else if (option == OptionId.TRADE_SHIPS) {
addText(getString("tradeShips"));
options.clearOptions();
visual.showCore(CoreUITabId.FLEET, station, station.getFaction().isNeutralFaction(), this);
} else if (option == OptionId.REFIT) {
addText(getString("refit"));
options.clearOptions();
visual.showCore(CoreUITabId.REFIT, station, station.getFaction().isNeutralFaction(), this);
} else if (option == OptionId.REPAIR_ALL) {
performRepairs();
} else if (option == OptionId.LEAVE) {
Global.getSector().setPaused(false);
dialog.dismiss();
}
}
private void performRepairs() {
addText(getString("repair"));
float supplies = playerFleet.getCargo().getSupplies();
float needed = playerFleet.getLogistics().getTotalRepairSupplyCost();
textPanel.highlightLastInLastPara("" + (int) needed, HIGHLIGHT_COLOR);
for (FleetMemberAPI member : playerFleet.getFleetData().getMembersListCopy()) {
member.getStatus().repairFully();
float max = member.getRepairTracker().getMaxCR();
float curr = member.getRepairTracker().getBaseCR();
if (max > curr) {
member.getRepairTracker().applyCREvent(max - curr, "Repaired at station");
}
}
if (needed > 0) {
playerFleet.getCargo().removeSupplies(needed);
}
}
private void createInitialOptions() {
options.clearOptions();
if (station.getFaction().isNeutralFaction()) {
options.addOption("Transfer cargo or personnel", OptionId.TRADE_CARGO);
options.setShortcut(OptionId.TRADE_CARGO, Keyboard.KEY_I, false, false, false, true);
options.addOption("Transfer ships to or from this station", OptionId.TRADE_SHIPS);
options.setShortcut(OptionId.TRADE_SHIPS, Keyboard.KEY_F, false, false, false, true);
options.addOption("Make use of the dockyard's refitting facilities", OptionId.REFIT);
options.setShortcut(OptionId.REFIT, Keyboard.KEY_R, false, false, false, true);
}
if (station.getFaction().getRelationship(playerFleet.getFaction().getId()) >= 0) {
options.addOption("Trade, or hire personnel", OptionId.TRADE_CARGO);
options.setShortcut(OptionId.TRADE_CARGO, Keyboard.KEY_I, false, false, false, true);
options.addOption("Buy or sell ships", OptionId.TRADE_SHIPS, null);
options.setShortcut(OptionId.TRADE_SHIPS, Keyboard.KEY_F, false, false, false, true);
options.addOption("Make use of the dockyard's refitting facilities", OptionId.REFIT);
options.setShortcut(OptionId.REFIT, Keyboard.KEY_R, false, false, false, true);
float needed = playerFleet.getLogistics().getTotalRepairSupplyCost();
float supplies = playerFleet.getCargo().getSupplies();
options.addOption("Repair your ships at the station's dockyard", OptionId.REPAIR_ALL);
if (needed <= 0) {
options.setEnabled(OptionId.REPAIR_ALL, false);
options.setTooltip(OptionId.REPAIR_ALL, getString("repairTooltipAlreadyRepaired"));
} else if (supplies < needed) {
options.setEnabled(OptionId.REPAIR_ALL, false);
options.setTooltip(OptionId.REPAIR_ALL, getString("repairTooltipNotEnough"));
options.setTooltipHighlightColors(OptionId.REPAIR_ALL, HIGHLIGHT_COLOR, HIGHLIGHT_COLOR);
options.setTooltipHighlights(OptionId.REPAIR_ALL, "" + (int) needed, "" + (int) supplies);
} else {
options.setTooltip(OptionId.REPAIR_ALL, getString("repairTooltip"));
options.setTooltipHighlightColors(OptionId.REPAIR_ALL, HIGHLIGHT_COLOR, HIGHLIGHT_COLOR);
options.setTooltipHighlights(OptionId.REPAIR_ALL, "" + (int) needed, "" + (int) supplies);
}
}
options.addOption("Leave", OptionId.LEAVE);
}
private OptionId lastOptionMousedOver = null;
public void optionMousedOver(String optionText, Object optionData) {
}
public void advance(float amount) {
}
private void addText(String text) {
textPanel.addParagraph(text);
}
private void appendText(String text) {
textPanel.appendToLastParagraph(" " + text);
}
private String getString(String id) {
String str = Global.getSettings().getString("stationInteractionDialog", id);
String fleetOrShip = "fleet";
if (playerFleet.getFleetData().getMembersListCopy().size() == 1) {
fleetOrShip = "ship";
if (playerFleet.getFleetData().getMembersListCopy().get(0).isFighterWing()) {
fleetOrShip = "fighter wing";
}
}
str = str.replaceAll("\\$fleetOrShip", fleetOrShip);
str = str.replaceAll("\\$stationName", station.getFullName());
float needed = playerFleet.getLogistics().getTotalRepairSupplyCost();
float supplies = playerFleet.getCargo().getSupplies();
str = str.replaceAll("\\$supplies", "" + (int) supplies);
str = str.replaceAll("\\$repairSupplyCost", "" + (int) needed);
return str;
}
public Object getContext() {
return null;
}
public void coreUIDismissed() {
optionSelected(null, OptionId.INIT);
}
}
The Jar file goes inside the jar folder, and this folder needs to be in the main folder of the mod (with data-graphics-sounds). You also need to add the jar to the mod_info.json, like: "jars":["jars/uscorbjar.jar"],
Both CoreCampaignPlugin and OrbitalStationInteractionDialogPlugin are a modified version of the official impl version of them. You can find them inside Starsector\starsector-core\starfarer.api.zip\com\fs\starfarer\api\impl\campaign. Edit those versions or mine to achieve whatever your twisted minds want.
I think this is pretty much it, I hope I didn't forget anything. It's 3 am here, CYA!
PS. Thanks to Verrius and Alex, without them I couldn't get it to work.
