[SCR][TC+AP] Hephaistos Corp. Station building service (beta 0.73) [Update: 06.01.17]

[X2-Illuminatus]

This is the unsigned version (i.e. it will mark your game as *modified*) of the Hephaistos Corp. The topic of the signed version can be found here.
Das deutsche Thema findet sich hier.
[ external image ]


Hephaistos Corp. - Station building service


The Hephaistos Corporation welcomes you and appreciates your call for its services.
The Hephaistos Corp. is a Terran universe-wide working corporation, which specialises in building stations. To clear entrepreneurs of their exhausting everyday work, the Hephaistos Corp. takes care of the purchase, delivery and construction of ordered Stations, without the need for the customer to permanently observe the building process or even to be present in the building sector. This service is not cheap, but the labour saving is surely worth each credit.


[ external image ][ external image ][ external image ]



>> The installation

For X3: Terran Conflict:
Download the script archive and extract it to your X3:TC directory.

For X3: Albion Prelude:
Download the script archive and extract it to "addon"-folder in your X3:TC directory.

Afterwards all files of the archive, they are listed below, should be in their respective folders in the X3:TC directory or its addon-folder. Start the game and assign a key to the "Hephaistos Corp. Station building"-hotkey in the Controls-Menu (under Options -> Controls -> Interface -> Extensions).
Just to be on the safe side you should also make a backup of your savegames before installing the script. The standard directory for the saves is "C:\Documents and Settings\[USERNAME]\My Documents\Egosoft\X3TC\save" or "C:\Users\[USERNAME]\Documents\Egosoft\X3TC\save". For X3AP the paths are the same, you just have to replace X3TC with X3AP.

Changing from the Bonus Package to the unsigned version of the Hephaistos Corp.

The Hephaistos Corp. is also part of the X3AP Bonus Package. The Bonus Package (BP) is intended for those people, who want to play an unmodified game. If you don't be interested in playing an unmodified game, you can also change to the unsigned version provided here in the topic. Usually the unsigned version has the same (or even more/newer) functions than the BP version. (Don't be confused by the different version number system used for both script versions, they're different on purpose.)
To install the unsigned version over the one of the Bonus Package, do as follows:

1. The BP version 1.0 of the Hephaistos Corp. script has the problem that it freezes, if you select a sector as building location that has neither a jump beacon nor a jump gate in it. If your order doesn't hang, you can start with step 2. To reset a hanging script, do as follows:
   • I.) Download the archive 'HephCorp_BP_reset.zip' here and extract its content ('plugin.X2I.HephCorp.reset.xml') to your 'X3 Terran Conflict/addon/scripts'-folder.
     II.) Start the game and load your savegame.
     III.) Open the Script Editor (instructions can be found here).
     • In the first window of the Script Editor select the 'Global Script Tasks'-entry, mark the script named "plugin.X2I.HephCorp.main3", press "Del" and confirm with "yes". That will abort the hanging script.
       Afterwards go back to the initial Script Editor screen, but select the 'Script Editor'-entry now. This will bring up a list of available scripts. Look for the the script 'plugin.X2I.HephCorp.reset.xml' (the script list is sorted alphabetically) and mark it, press 'r' and two times 'Enter'. This will delete all Hephaistos Corp objects and reset all used variables. Note that you won't get any already paid money back this way.
     IV.) Delete the file 'plugin.X2I.HephCorp.reset.xml' from your 'X3 Terran Conflict/addon/scripts'-folder.
2. Download an archive containing the 'uninstall.X2I.HephCorp.bp.bat' here and extract it to your 'X3 Terran Conflict/addon'-directory. Run the 'uninstall.X2I.HephCorp.bp.bat' from the 'scripts.uninstall'-folder. This will delete all the BP Hephaistos Corp scripts from the 'scripts'-folder. Afterwards you can delete the 'uninstall.X2I.HephCorp.bp.bat' as well.
3. Download the unsigned version from this topic and install it as described above.
4. Start the game and load a savegame.
5. Assign a key to the "Hephaistos Corp."-Hotkey in the Controls menu.

>> The brief instruction

1. Assign a key to the "Hephaistos Corp. building service"-hotkey in the Controls menu.
2. Press the hotkey and follow the given instructions.


>> The function

The complete interaction with the Hephaistos Corp. is managed with the set hotkey. After pressing it and depending on the current order and fortune situation of the player different menus or messages will be activated, which let the player order stations (including paying them) or inform him about the current status of his order.

• 1. The order:
  After pressing the hotkey for the first time the script will check, if the player has at least 1,000,000 Credits on his player, station and additional* accounts and if he can buy any stations from the different races. If this is the case, the player gets a welcome message. Confirming it, will open the actual "Select station"-menu, which is divided into three sections:
  • Under "Current order data" the already selected stations, the current price (including the building fee), the money on player, station and additional* accounts as well as a button to end the current order will be displayed.
    (*Additional accounts are those that are added by other scripts. A list of supported scripts can be found in the (In)Compatibilities section below.)
    If stations were already added to the order list, a click on the "already selected stations"-entry will show a list of these stations. A click on one station will let the player remove that station. Another click on the "already selected stations"-entry will close the station list again.
  • Under "Filter stations by races" you're able to select a certain or 'all' races. The buyable station list will then only contain stations of that race.
  • Under "Buyable stations" the stations that can be bought by player are displayed together with their price.
  
  After selecting a station the desired amount of that station has to be entered. Afterwards the stations will be added to the order list and the "Current order data" will be updated. The stations won't be added to the order list, if:
  • an amount less or equal zero ('0') was entered,
  • the maximum amount of stations would be higher than 512 with this input,
  • the total price would exceed the player's total fortune with this input.
  After that you will be able to add more stations or to end the order. If you want to abort your order, simply press "Esc", while you are in the "Select station"-menu.
  
  2. The payment:
  While all accounts will be recognized, when checking the player's fortune, money to pay the costs will always just be debited from the player account. When the order is finished and enough money is on the player account to pay the costs, the money will automatically be debited and the delivery will be started.
  If there is not enough money, the order will be saved and the player has to transfer money from his other accounts to his account. When he has done this, pressing the hotkey again will result in debiting the money from the player account and starting the delivery.
  If the costs exceed either the maximum possible amount of Credits on the player account or the player's currently available fortune, it's also possible to pay in installments. Each time after pressing the "Hephaistos Corp"-Hotkeys the maximum available money will be taken from the player account to pay the remaining debts.
  
  3. The delivery:
  After the payment was made, the stations will be transported to the selected sector by station transporters (TL class ships) and built at the selected coordinates. To accelerate the whole delivery process and to keep the distances the TL class ships have to fly as short as possible, the ships will jump to the jump gate or beacon that is in building range (20 km) of the selected coordinates. If there is neither a jump gate nor a beacon in range, a jump beacon will be built by a jump beacon deliverer (M4 class ship). This jump beacon is then the jump target for the station transporters. When the build process is finished, the jump beacon will be destroyed. Note that the stations won't be connected with each other using Complex Construction Kits! (There is simply no command for that in the Script Editor.)During the build process the player can get status updates of the build process by pressing the "Hephaistos Corp"-Hotkey. After all stations are built, the player will get a message informing him about the successful building process.
  
  Additional information:
  Barred from the order are stations that can't be connected with each other (Equipment Docks, Trading stations, Headquarters), stations that can not be bought by the player and Mines. It's only possible to have one order at once. First after getting the information that all stations were successfully built, a new order can be made. Also note that the station building service will not work with Station building missions.
  
  Since version 0.71 it's possible to specify an amount of money that should always remain on the player account, when paying the ordered stations. This option can be used to prevent that so much money is taken from the player account that the function of other scripts, which also access the player account, is negatively influenced. For example the Commercial Agent or the Universe Trader.
  By default the amount of money used by the script is 0. That means that unless otherwise limited always the maximum amount of money is debited from the player account.
  You can change that value, as follows:
  • 1) Open the text file of the Hephaistos Corp. for that language, which you play the game in, with a text or XML Editor. The available text files for the different languages are listed below.
    2) The value for the money amount can be found under text id="350": <t id="350">0</t>.
    3) Change the value to a natural number between 0 and 999999999.
    4) Save the text file and start a game / load a savegame.
  
  If the entered value is smaller than 0 or greater than 999.999.999 or if it is any other value (i.e. not a natural number), the default value will be used. Currently the specified amount of money is only considered in the initial order / payment process, but not (!) when paying in installments. also note that this money limit is displayed nowhere.

>> Known problems

Version - beta 0.73:
- The script doesn't check, if there is enough space for the stations at the selected coordinates
- Only the German and English text files are fully localised. The other files use the English version of the with version 0.71 newly introduced texts.


>> (In)Compatibilities


The station building service is compatible to all X3:TC versions equal or higher than 2.5 as well as to all X3: Albion Prelude versions equal or higher than 1.0. In addition to that the station building service should be compatible with all scripts and mods as long as they don't use the same text/page id (7337). Since version 0.71 Jump Beacons are used for a faster delivery. If those are not available (e.g. in a mod that changes the Tships.xml) or if they are used in another way, this might cause problems with the Hephaistos Corp.
As you can see in the Credits section below, the script uses the station sizes from Saetans Object size database. This database only covers stations from the unmodified game. If a mod adds additional stations the script won't recognize them properly, which will lead either to collisions, when building these stations, or to the script not building these stations at all. Though, support for additional mod stations is planned for a future version.
In addition to player and station accounts also additional accounts added by scripts will be checked, if a script adding such accounts is installed and if the player opened at least one account. Currently supported is only one script.

Supported scripts:
Universal Banking by mark_a_condren


>>The uninstallation

Make sure that no order or build process is currently running. Open the Script Editor (instructions can be found here), select the script 'plugin.X2I.HephCorp.uninstall', press 'r' and two times 'Enter'. Afterwards execute the 'uninstall.X2I.HephCorp.bat' in the "scripts.uninstall"-folder in the X3:TC directory (or its addon-folder). After that simply delete the "scripts.uninstall"-folder, if there is no other file in it.


>> Credits

• EGOSOFT for the X-Series and the Script Editor
  -Dusty- for the original idea of A.R.E.S for X3:Reunion
  Gazz for his Get object size script library
  Ketraar for creating the Hephaistos Corp. introduction image here in the topic
  Saetan for the station sizes from his Object size database
  SS_T for providing a reliable ad free hosting place (xdownloads.co.uk)
  -DNA-, DannyD and Lucateo for the Italian translation
  bugsman and NalinElfleg for the French translation
  V2200 for the Russian translation
  Yacek for the Polish translation
  Groshnak and korio for the Spanish translation

>> Download links

[ external image ]


mediafire.com:
[ external image ]


>> Files in the archive:

• Documents
  • - LiesMich_HephCorp.txt
    - Readme_HephCorp.txt
  scripts
  • - !init.X2I.HephCorp.modified.pck
    - lib.gz.get.object.size.xml
    - lib.X2I.HephCorp.findgate.xml
    - lib.X2I.HephCorp.getbuildconstant.xml
    - lib.X2I.HephCorp.getstatmoney.xml
    - lib.X2I.HephCorp.getuniversalmoney.xml
    - lib.X2I.HephCorp.installequip.xml
    - lib.X2I.HephCorp.moneystring.xml
    - lib.X2I.HephCorp.remainmoney.xml
    - lib.X2I.HephCorp.valid.xml
    - plugin.X2I.HephCorp.bringbeacon.xml
    - plugin.X2I.HephCorp.build.xml
    - plugin.X2I.HephCorp.createship.xml
    - plugin.X2I.HephCorp.createterranjb.xml
    - plugin.X2I.HephCorp.getpositions.xml
    - plugin.X2I.HephCorp.getSPPposition.xml
    - plugin.X2I.HephCorp.getstations.xml
    - plugin.X2I.HephCorp.main1.xml
    - plugin.X2I.HephCorp.main2.xml
    - plugin.X2I.HephCorp.main3.xml
    - plugin.X2I.HephCorp.storno.xml
    - plugin.X2I.HephCorp.uninstall.xml
    - setup.X2I.HephCorp.xml
  scripts.uninstall
  • - uninstall.X2I.HephCorp.bat
  t
  • - 7337-L007.xml (Russian)
    - 7337-L033.xml (French)
    - 7337-L034.xml (Spanish)
    - 7337-L039.xml (Italian)
    - 7337-L044.xml (English)
    - 7337-L048.xml (Polish)
    - 7337-L049.xml (German)

>>Version history

• 06th January 2017 - Update (beta 0.73)
  • - Fixed small errors in text file
    - Added missing station sizes of stations added with X3AP Update 3.0
    - Added check for text file version to setup script, so that station sizes can be added(changed) more easily
  15th June 2012 - Update (beta 0.72)
  • - Fixed problem with the creation of jump beacons in Terran sectors (X3TC)
    - Added script code to remove the redundant jump beacons built in beta 0.71 (X3TC)
  21st April 2012 - Update (beta 0.71)
  • - Fixed problems with player money check
    - Fixed problem with station delivery status reports
    - Fixed small problems with the check, whether the delivery runs or not
    - Optimised sector selection, so UFJD-sector can't be selected as building place and script warns, if building place lies within war territory (X3AP)
    - Added additional checks to prevent a hanging script
    - Added option to specify amount of money that should always remain on player account
    - Added script that builds jump beacons in Terran sectors (X3TC)
    - Added Spanish text file
    - Changed station delivery method (now jump gates and beacons will be used)
    - Increased orderable station amount up to 512
  
  23rd January 2012 - Update (beta 0.70)
  • - Fixed problem with the selectable amount of stations
    - Fixed problem that build script was stuck in a loop after TL was destroyed.
    - Fixed problem that no stations were built after the hotkey was pressed several times.
    - Fixed problem that money wasn't debited from the player account, when the 2 billion limit was exceeded.
    - Fixed problem that build service got stuck sometimes.
    - Optimised: positioning of Solar Power Plants
    - Optimised: setup-script, so the script won't start, if t-file is missing.
    - Removed: 'add station'-query (since last version there is a button to end the order process)
    - Added list of already selected stations.
    - Added function to remove already selected stations.
    - Added numeration of built stations for better overview.
    - Added Terran stations to the order list.
    - Added info messages, when pressing the hotkey during the delivery and building process
    - Added French, Italian, Polish and Russian text files
    - Added Support for X3AP:
    • - Support for improved player account (displays values > 2 billions)
      - Payment of values over 2 billion Credits from the player account is possible now
    
    - Script and t files were cleaned-up a little bit.
  09th October 2011 - Update (beta 0.60)
  • - Fixed problem that stations were built over each other like solar power plants.
    - Fixed problem that after paying in installments not all stations were built.
    - Fixed problem that the pilots of the TLs were "Unknown Objects". The pilots are now Terrans. The TLs still have no id in the ship list of the sector map, though.
    - Optimised the positioning script to use the station sizes from Saetan's object size database.
    - Added button to end the current order.
    - Added additional TL defence in the form of a random amount of Terran fighters in the TL's hangar
    - Added support for the Universal Banking script by mark_a_condren
  05th September 2011 - Update (beta 0.51)
  • - fixed problem with not correctly set global variable, which resulted in no station building in the first build process.
    - fixed problem with 'not-paid'-message not displayed
    - fixed problem with paid-variable not correctly set, when paying in installments
  03rd September 2011 - Script Release (beta 0.50)

[X2-Illuminatus]

*reserved*

[joelR]

Wow this is fantastic. This will come in really handy for big projects. Thanks for putting this together.

[Lord Dakier]

Sounds very usefull. How does the organising of the stations work exactly?

[X2-Illuminatus]

Wow this is fantastic. This will come in really handy for big projects.

Thanks for the kind words. I'll hopefully find the time in the next days/weeks to improve the positioning algorithm, so stations are built as space-saving as possible.

How does the organising of the stations work exactly?

You mean the positioning algorithm? After selecting the stations by the player the stations are sorted by their types. Stations are then built in a cube with a certain length, which depends on the total station amount. First comes the "floor area" (a square = length * length), then the other floors. Solar power plants are currently excluded from the main cube and are simpley build behind it and over each other.

[Gazz]

Trying to build stations denser than their bounding sphere (get size) dictates is a veritable can of worms.
I spent a lot of time tinkering with that for the CC v1 but eventually gave up.

Iteration by trial and error is just about the only thing that works... and then only IS.
It still creates a suboptimal density because the script cannot "see" in 3 dimensions like a player and stagger stations properly. SPP are a classical example for stations you can zig zag while stacking them vertically.
Very difficult for a script to figure out unless you check a ginormous number of possible constellations.

[X2-Illuminatus]

Update - beta 0.51

• - fixed problem with not correctly set global variable, which resulted in no station building in the first build process.
  - fixed problem with 'not-paid'-message not displayed
  - fixed problem with paid-variable not correctly set, when paying in installments

___________________________

Trying to build stations denser than their bounding sphere (get size) dictates is a veritable can of worms.
I spent a lot of time tinkering with that for the CC v1 but eventually gave up.

Yeah, I already encountered several problems using the get object size-command. Starting from the different IS and OOS return values (thanks for your lib-script, btw.) to the general perception that one value is just not enough to position stations properly. It actually works pretty good, if just one station type should be built. So, if none of my other ideas work, I will probably make a similar attempt like -Dusty- did. Guessing from the screenshots in its topic ARES builds small "complexes" for each station type and builds these then as place-saving as possible next to each other.

[seldum]

Epic script. I look forward to trying it out

Repetative operations like building 15 bliss place and 15 dream farms gets a bit tedious.

I'm happy if I can get some company to just transfer the stations to the sector. I can always move them around manually using the complex contructor script.

[Calgor Grim]

I do really love this. Just ask it to do something and off it goes. I notice all kinds of Mines are unavailable though, Silicon, Ore, Ice etc. Also intentional to do with positioning I presume?

[X2-Illuminatus]

The mines are not available due to way they're built. If you build a mine with the SE, you can't place the mine on a chosen asteroid, as you would do it with the normal build command, but rather get a mine including an asteroid. That way you cannot decide, what yield the asteroid should have. (IIRC the standard yield for such a directly with the SE built mine / asteroid is 25.)

[Akamir]

This is an amazing mod, I've only tried it twice so far but both times it worked flawlessly. Thank you for creating it

[Krane]

Thanks for making a great mod!

[StormRazor52]

I have run into a problem that I think has to do with a conflict with the Universal Banking script. Even though I have more than enough money in my account, your program keeps telling me I don't have the required funds?
I uninstalled the program and reinstalled it and it did the same thing. Is there anyway to address this so it will work with the banking script? I am starting over and will try again without the banking to check it and let you know

[X2-Illuminatus]

The problem is probably that the universal banking script is taking all money from the player and player station accounts and manages it with one (or more) global variable(s) to circumvent such nasty things like the 2 billion credit limit. (At least I assume it's working that way.) And when the Hephaistos Corp checks player and station accounts it finds no money.

Is there anyway to address this so it will work with the banking script?

I will ask mark_a_condren for a way to access the global account.

In the meantime: Is it possible to deactivate the universal banking script somehow? For example: let it only manage station, but not the player account?

Edit: Do you use any other scripts and/or mods?

[mark_a_condren]

Hi X2,

Nice service you have here.

As for the issues raised, I think there shouldn't be any problems getting around them.

In the meantime: Is it possible to deactivate the universal banking script somehow? For example: let it only manage station, but not the player account?

The player account is the only one that is not normally auto ajusted (but it can be set to be the stn cr managers 'working account'), credits are transfered from or to it manually by the player so they keep control of the player account balance, so if they transfer enough credits to the player account before using your service then all should be good.

But as described in the PM to you, you can do an in script check also.

When i get back to playing i'll have to give this a try for sure.


MarCon

[StormRazor52]

Thanks for the feed back and I did go out of game and disable the script in the Mod manager and started over, when I used the station building script it worked fine, Then I saved and exited the game then re-activated the banking script and everything worked fine from then on. now I am using both scripts with no problem. But I have a very complex game setup with a lot of different scripts and mods. So It is hard to be sure if this is the only problem, but for the moment everything is working fine.

[X2-Illuminatus]

Nice service you have here.

Thanks.

But as described in the PM to you, you can do an in script check also.

Yeah, will do that. Probably already in the next version.

now I am using both scripts with no problem.

That's good to know. After all this script is still just a beta version. So, I appreciate every feedback that helps me to improve it.

[Calgor Grim]

Odd behaviour.

Attempted to purchase an Argon Crystal Fab L, I know I have less than it needs, I have 3.8m and it costs 6.4m, or whatever. Basically it warns me I don't have enough and doesn't add the order. I thought it was supposed to save it until enough credits have been accumulated to add the order? All I was getting was the warning saying "This will cost more than you have, order not added" and took be back round to "Do you want to add more stations?" without saving any of it. No mods are installed which would affect stations, and there's a load of others, Universal Banking being the only possibly relevant one.

Otherwise, I should really say thanks. When I have used this on a file with more money I love not having to watch them at work. Thank you

[X2-Illuminatus]

I thought it was supposed to save it until enough credits have been accumulated to add the order?

No, the way you described it is the way it should work. You are only able to add stations as long as the total price is less or equal to your current total amount of money. To find out the total player money the script checks the player account and all player station accounts before / after a station was added.
What you probably mean is the payment. To pay the total price only the player account will be debited. That can lead to the situation that after the order process you find yourself with all your money being on your station accounts. In that case the order is saved and you have to transfer money manually to your account and press the HephCorp hotkey again. In addition to that it's possible that you either don't have enough money anymore (e.g. one of your traders took some money to buy something) or the total price is higher than the maximum amount of credits that can be stored on your account (2 billion credits). In both cases you can pay in installments, which means that when you press the hotkey the maxmimum amount of money available on your play account will be taken to pay a part (or when possible the whole) price.

[Calgor Grim]

So basically if this is read correctly:

If (Combined wealth of all accounts < cost)
Reject

If ((Player account < cost) & (cost =< combined wealth))
Take max player account and save order.

Apologies you are probably banging your head on a wall with me.