How to install mods and scripts on Mac (for technophobes)...

[Das Attorney]

Edit LV
Added to Tutorials
___________________

Hi all,

Even though the Mac X3 community is small, I thought I'd print a noobs guide to installing mods and scripts onto Mac. It was such a brainache at first that I thought It would be a shame not to share what I've learnt with the X3 community. All of the credit goes to Cycrow, who patiently walked me through it with a few PM's. Anyway, we shall begin...

To get the bonus pack, follow the really useful guide that Bubba posted on the VP forums board. (Reproduced here for your convenience)...

To get the bonus pack installed, I followed the hints here:

http://forum.egosoft.com/viewtopic.php?t=181641

basically, it goes:

1) download the bonus pack from egosoft (http://www.egosoft.com/download/x3/bonus_en.php)
2) download crossover (http://www.codeweavers.com/products/cxmac/) - a Mac app that runs small windows apps - pretty cool!
3) have crossover open the bonus pack exe and run the installer - when it asks for the location to extract files, use the following:

X3 The Reunion.app/Contents/Resources/X3 Reunion Online.app/Contents/Resources/transgaming/c_drive/x3/

4) all done!

BTW: Make sure you have your Mac installer disks handy as Crossover might ask you to run disk 1 to complete the Installation process. (Don't worry, you won't have to reinstall the OS on your Mac).

I've only investigated adding XML files into the game. It is possible to add mods that contain cat/dat files, but I haven't got into that as it's really messy. All of the mods I've added so far have been XML (fortunately)!

First off, download a script. Here, we'll focus on Improved Khaak

To add the script, download Cycrow's SPKutil_mac onto your desktop
http://cycrow.thexuniverse.us/mac/SPKUtil_mac.zip

Open up the folder and put SPK_tool onto the desktop (I haven't had to use SPK_convert yet so we'll ignore that one).

Open up SPK_tool - this will open the command list.

On the program taskbar (top of the screen), the program will be called 'Terminal' click on FILE > New Shell

Then drag the SPK_tool icon into the terminal window you opened. You should see this:

Last login: Tue Jun 10 23:48:18 on ttyp1
Welcome to Darwin!
ryan-lights-computer:~ Torch$ /Users/Torch/Desktop/SPKTool_mac

Now look in the command list on the other SPK_tool window. We need to view the spk file before we can convert it to mac friendly data. Therefore the command we need is -v (to view).

Go back to your other terminal window; insert a space, type -v and then insert another space. You should now see the following:

Last login: Tue Jun 10 23:48:18 on ttyp1
Welcome to Darwin!
ryan-lights-computer:~ Torch$ /Users/Torch/Desktop/SPKTool_mac -v

Now open up the script folder you (previously) downloaded. Drag the file 'Improved Khaak 1.0.spk' into the Terminal window. Now you should see this:

Last login: Tue Jun 10 23:48:18 on ttyp1
Welcome to Darwin!
ryan-lights-computer:~ Torch$ /Users/Torch/Desktop/SPKTool_mac -v /Users/Torch/Desktop/Improved\ Kha\'ak\ 1/Improved\ Kha\'ak\ 1.0.spk

Hit <enter> The following will be displayed:

Last login: Tue Jun 10 23:48:18 on ttyp1
Welcome to Darwin!
ryan-lights-computer:~ Torch$ /Users/Torch/Desktop/SPKTool_mac -v /Users/Torch/Desktop/Improved\ Kha\'ak\ 1/Improved\ Kha\'ak\ 1.0.spk

SPKTool V1.00 (SPK File Version 4.00) 12/06/2007 Created by Cycrow

* Opening SPK File, /Users/Torch/Desktop/Improved Kha'ak 1/Improved Kha'ak 1.0.spk...
File Format Version: 4.00
Script Name: Improved Kha'ak
Script Author: Fallen
Script Version: 1.0
Creation Date: 09/05/2008
Description: Makes the Kha'ak act as a swarm, use their gateless jumpdrives, and even take over sectors. For more details see the forum post at http://forum.egosoft.com/viewtopic.php?t=204448
Script Type: AL Plugin
Web Site Address: http://forum.egosoft.com/viewtopic.php?t=204448

Listing files in package:
Scripts/al.plugin.ik.xml (Script) Size: 549B
Scripts/plugin.ik.takeover.uninstall.xml (Script) Size: 1.21KB
Scripts/plugin.ik.takeover.xml (Script) Size: 2.39KB
Scripts/plugin.ik.victory.xml (Script) Size: 2.25KB
Scripts/plugin.ik.add.SOI.check.xml (Script) Size: 1.07KB
Scripts/plugin.ik.add.SOI.xml (Script) Size: 1.29KB
Scripts/plugin.ik.al.handler.core.xml (Script) Size: 2.49KB
Scripts/plugin.ik.al.handler.difficulty.xml (Script) Size: 747B
Scripts/plugin.ik.al.handler.invasion.xml (Script) Size: 3.97KB
Scripts/plugin.ik.al.handler.missiles.xml (Script) Size: 744B
Scripts/plugin.ik.al.handler.p2p.range.xml (Script) Size: 751B
Scripts/plugin.ik.al.handler.revenge.xml (Script) Size: 744B
Scripts/plugin.ik.al.handler.suicidal.xml (Script) Size: 752B
Scripts/plugin.ik.al.handler.takeover.xml (Script) Size: 2.49KB
Scripts/plugin.ik.al.handler.upgrades.xml (Script) Size: 747B
Scripts/plugin.ik.bbs.xml (Script) Size: 3.73KB
Scripts/plugin.ik.defeat.xml (Script) Size: 2.13KB
Scripts/plugin.ik.disable.xml (Script) Size: 1.24KB
Scripts/plugin.ik.job.fight.swarm.xml (Script) Size: 3.30KB
Scripts/plugin.ik.job.reset.xml (Script) Size: 707B
Scripts/plugin.ik.job.station.materials.xml (Script) Size: 2.04KB
Scripts/plugin.ik.job.suicide.xml (Script) Size: 3.40KB
Scripts/plugin.ik.jtp.if.allowed.xml (Script) Size: 1.94KB
Scripts/plugin.ik.jtp.spherical.xml (Script) Size: 1.75KB
Scripts/plugin.ik.proactive.xml (Script) Size: 2.33KB
Scripts/plugin.ik.signal.attacked.xml (Script) Size: 916B
Scripts/plugin.ik.signal.killed.xml (Script) Size: 1.01KB
Scripts/plugin.ik.swarm.gather.xml (Script) Size: 3.04KB
Scripts/plugin.ik.swarm.local.response.xml (Script) Size: 4.41KB
Scripts/plugin.ik.swarm.manager.xml (Script) Size: 2.90KB
Scripts/plugin.ik.swarm.remote.response.xml (Script) Size: 2.31KB
Scripts/plugin.ik.swarm.target.xml (Script) Size: 2.34KB
Scripts/plugin.ik.swarm.thinker.big.xml (Script) Size: 2.09KB
Scripts/plugin.ik.swarm.thinker.little.xml (Script) Size: 1.87KB
Scripts/plugin.ik.takeover.make.station.xml (Script) Size: 2.17KB
Scripts/plugin.ik.takeover.prevent.theft.xml (Script) Size: 1.17KB
Scripts/plugin.ik.takeover.summon.xml (Script) Size: 1.87KB
Scripts/setup.plugin.ik.xml (Script) Size: 473B
Uninstall/uninstall.plugin.ik.xml (Uninstall) Size: 545B
T/448972.xml (Text) Size: 2.82KB
Scripts/plugin.ap.lib.al.rotating.toggle.xml (Script) Size: 1.59KB
Scripts/plugin.ap.lib.sector.array.xml (Script) Size: 2.51KB
Scripts/plugin.ap.lib.timed.destruction.xml (Script) Size: 1.09KB
Scripts/plugin.ap.lib.al.complex.toggle.xml (Script) Size: 2.11KB
Scripts/plugin.ap.lib.al.globals.xml (Script) Size: 1.32KB
Scripts/plugin.ap.lib.al.handler.toggler.xml (Script) Size: 1.52KB
ryan-lights-computer:~ Torch$

The upshot of all this is that the file is good to use. If you see a different message to this then simply run the SPK_convert utility in a similar fashion (following the command list) to convert old style SPK (bad) files into new (good) SPK files.

Anyway, with Improved Khaak, it shouldn't need converting.

Now we have determined the file is good to use, repeat the process, but instead of inserting ' -v ' in the middle, insert ' -e '. You will see the following:

Last login: Wed Jun 11 00:05:17 on ttyp2
Welcome to Darwin!
ryan-lights-computer:~ Torch$ /Users/Torch/Desktop/SPKTool_mac -v /Users/Torch/Desktop/Improved\ Kha\'ak\ 1/Improved\ Kha\'ak\ 1.0.spk

SPKTool V1.00 (SPK File Version 4.00) 12/06/2007 Created by Cycrow

* Opening SPK File, /Users/Torch/Desktop/Improved Kha'ak 1/Improved Kha'ak 1.0.spk...
File Format Version: 4.00
Script Name: Improved Kha'ak
Script Author: Fallen
Script Version: 1.0
Creation Date: 09/05/2008
Description: Makes the Kha'ak act as a swarm, use their gateless jumpdrives, and even take over sectors. For more details see the forum post at http://forum.egosoft.com/viewtopic.php?t=204448
Script Type: AL Plugin
Web Site Address: http://forum.egosoft.com/viewtopic.php?t=204448

Listing files in package:
Scripts/al.plugin.ik.xml (Script) Size: 549B
Scripts/plugin.ik.takeover.uninstall.xml (Script) Size: 1.21KB
Scripts/plugin.ik.takeover.xml (Script) Size: 2.39KB
Scripts/plugin.ik.victory.xml (Script) Size: 2.25KB
Scripts/plugin.ik.add.SOI.check.xml (Script) Size: 1.07KB
Scripts/plugin.ik.add.SOI.xml (Script) Size: 1.29KB
Scripts/plugin.ik.al.handler.core.xml (Script) Size: 2.49KB
Scripts/plugin.ik.al.handler.difficulty.xml (Script) Size: 747B
Scripts/plugin.ik.al.handler.invasion.xml (Script) Size: 3.97KB
Scripts/plugin.ik.al.handler.missiles.xml (Script) Size: 744B
Scripts/plugin.ik.al.handler.p2p.range.xml (Script) Size: 751B
Scripts/plugin.ik.al.handler.revenge.xml (Script) Size: 744B
Scripts/plugin.ik.al.handler.suicidal.xml (Script) Size: 752B
Scripts/plugin.ik.al.handler.takeover.xml (Script) Size: 2.49KB
Scripts/plugin.ik.al.handler.upgrades.xml (Script) Size: 747B
Scripts/plugin.ik.bbs.xml (Script) Size: 3.73KB
Scripts/plugin.ik.defeat.xml (Script) Size: 2.13KB
Scripts/plugin.ik.disable.xml (Script) Size: 1.24KB
Scripts/plugin.ik.job.fight.swarm.xml (Script) Size: 3.30KB
Scripts/plugin.ik.job.reset.xml (Script) Size: 707B
Scripts/plugin.ik.job.station.materials.xml (Script) Size: 2.04KB
Scripts/plugin.ik.job.suicide.xml (Script) Size: 3.40KB
Scripts/plugin.ik.jtp.if.allowed.xml (Script) Size: 1.94KB
Scripts/plugin.ik.jtp.spherical.xml (Script) Size: 1.75KB
Scripts/plugin.ik.proactive.xml (Script) Size: 2.33KB
Scripts/plugin.ik.signal.attacked.xml (Script) Size: 916B
Scripts/plugin.ik.signal.killed.xml (Script) Size: 1.01KB
Scripts/plugin.ik.swarm.gather.xml (Script) Size: 3.04KB
Scripts/plugin.ik.swarm.local.response.xml (Script) Size: 4.41KB
Scripts/plugin.ik.swarm.manager.xml (Script) Size: 2.90KB
Scripts/plugin.ik.swarm.remote.response.xml (Script) Size: 2.31KB
Scripts/plugin.ik.swarm.target.xml (Script) Size: 2.34KB
Scripts/plugin.ik.swarm.thinker.big.xml (Script) Size: 2.09KB
Scripts/plugin.ik.swarm.thinker.little.xml (Script) Size: 1.87KB
Scripts/plugin.ik.takeover.make.station.xml (Script) Size: 2.17KB
Scripts/plugin.ik.takeover.prevent.theft.xml (Script) Size: 1.17KB
Scripts/plugin.ik.takeover.summon.xml (Script) Size: 1.87KB
Scripts/setup.plugin.ik.xml (Script) Size: 473B
Uninstall/uninstall.plugin.ik.xml (Uninstall) Size: 545B
T/448972.xml (Text) Size: 2.82KB
Scripts/plugin.ap.lib.al.rotating.toggle.xml (Script) Size: 1.59KB
Scripts/plugin.ap.lib.sector.array.xml (Script) Size: 2.51KB
Scripts/plugin.ap.lib.timed.destruction.xml (Script) Size: 1.09KB
Scripts/plugin.ap.lib.al.complex.toggle.xml (Script) Size: 2.11KB
Scripts/plugin.ap.lib.al.globals.xml (Script) Size: 1.32KB
Scripts/plugin.ap.lib.al.handler.toggler.xml (Script) Size: 1.52KB
ryan-lights-computer:~ Torch$

Now the files are in mac friendly code.

Where, I hear you ask, are these converted files?

As you can see from the last line of the code, the last word is "Torch". This is where they've all been sent. Pretty obvious to some of you, but it took me an hour and a couple of PM's to Cycrow to figure that one out!

There's two folders we're looking for. The first is called 'Scripts' and the second 'T'

Open up your X3 folder from the hard drive and single click the 'X3 The Reunion' folder. Now go to the gear icon at the top of the window and select 'show package contents'. The path to follow is as follows:

Contents>Resources>X3 Reunion(show package contents again)>Contents>Resources>Transgaming>c_drive

Now you will see lots of folders. Put the contents of the 'scripts' you converted into the 'scripts' folder. Note that with Improved Khaak, the files you're adding are XML files, and the default files in 'scripts' are .pck files. (This will make it easier to locate them should you want to uninstall).

Do the same with the 'T' folder and Bob's your uncle - you've successfully installed a PC mod onto your Mac!

I also downloaded a mod called MARS which was even easier as there was no SPK file, just the XML's to paste into the corresponding 'script' and 't' file.

I thought I'd share this with you all as the mods are really professional and I can't stress how much they add to the game. I was really bored before as there literally was nothing left to do in my game, but these have opened up a whole new challenge.

Personally, I'd recommend the Improved Khaak/Xenon, MARS mod, race response fleets, and sector takeover. To be honest, they're the only one's I've downloaded so far and they all work great.

A BIG Thanks goes to Cycrow, who not only wrote half of these wonderful mods available on the forums, and the SPK Tools Utility, but also very patiently took a bit of time out to help me learn what I'm doing (and not wipe my hard drive in the process) That's why I thought I'd type this up, some of you can do all this in your sleep but if it helps out a couple of people, then it's all worth it.

Right, after typing up that essay, I'm off to 'pacify' the universe...

[bubbalumpkis]

I've started using Darwine instead of crossover - it works well and it's free - worked on the latest bonus pack very well: http://darwine.sourceforge.net/download.php

Making an alias of the .../Transgaming/c_drive directory and placing that outside of the X3 application makes installing multiple mods easier.

And finally, there are some mods which are packaged as an SPK and which won't convert with SPKConvert_mac (you only have to convert them if running SPKTool_mac tells you they need to be converted). If this happens, you can try to find a version of the mod which doesn't use an SPK.

[7ate9tin11s]

Hey! I recognize that example script!

Nice guide.

[samalapan]

Wow! I've done my share of tweaking my game by going through the X3 file folders, but this is really helpful. Thanks

[04ihegba]

Incredible how simple things are if you know how to do them! You should have seen me install my first mod... total failure!

[zoolfoos]

Thank you very much for this helpful post. Your support for the Mac community is much appreciated.

By the way, the first time I ran this I got an error on extraction (but not on viewing contents). I was going nuts trying to figure out a command for "Verbose" mode so I could get some more info on the error, when I remembered that I hadn't used sudo!

sudo allows gives you temporary root permissions on the command line and requires a password. It will overcome any write-permissions issues, which is what I was having. You type "sudo" before the command. Extracting a file would look like this:

sudo ./SPKTool_mac -e <file> <location to extract to>

Anyway, I thought that might be useful to anyone else who might encounter that problem who may not be familiar with using the command line, and that they might appreciate finding the answer here.

Cheers!

[davegray99]

I get the following error with the EMP.psk

Opening SPK File, /Users/Dez/Documents/SPKUtil_mac/emp.spk... (Done)
Extracting all files from archive...(Error)
There was a problem extracting the files

First I did a -v :

SPKTool V1.00 (SPK File Version 4.00) 12/06/2007 Created by Cycrow

* Opening SPK File, /Users/Dez/Documents/SPKUtil_mac/emp.spk...
File Format Version: 4.00
Script Name: Community Extended Mod Pack
Script Author: AalaarDB / Cycrow
Script Version: 2.01
Creation Date: 11/11/2006
Description: Adds Extra wares into the game for use by scripters
Script Type: Extension Mod

Listing files in package:
Readme/Community Extended Mod Pack/twaretPlainTextForScripters.txt (Readme) Size: 3.57KB
09.cat (Mod) Size: 49B
09.dat (Mod) Size: 5.53KB

Then I do a -e:

sudo /Users/Dez/Documents/SPKUtil_mac/SPKTool_mac -e /Users/Dez/Documents/SPKUtil_mac/emp.spk

[Cycrow]

the error could be a number of things, from the looks of it, its reading the file ok, so at least the library is working as it should.

it could be a problem decompressing the file, or it could be a problem with writing the files.

you could specify where you are writing the files to.

sudo /Users/Dez/Documents/SPKUtil_mac/SPKTool_mac -e /Users/Dez/Documents/SPKUtil_mac/emp.spk /Users/Dez/Documents/SPKUtil_mac/Extracted

and see if you have any luck with that

[davegray99]

Cycrow,
Thanks for the quick response!

Path was /Users/Dez/Documents/X3\ Stuff

Same issue with 10 or so .spk's i tried.

Here another example with the Volker Invasion Mod:

$ /Users/Dez/Desktop/SPKTool_mac -v /Users/Dez/Documents/X3\ Stuff/VoelkerInvasionen-V1.0.10-07.06.2007.spk

SPKTool V1.00 (SPK File Version 4.00) 12/06/2007 Created by Cycrow

* Opening SPK File, /Users/Dez/Documents/X3 Stuff/VoelkerInvasionen-V1.0.10-07.06.2007.spk...
File Format Version: 4.00
Script Name: V?lker Invasionen
Script Author: StarTrekMarc
Script Version: 1.0.10
Creation Date: 07/06/2007
Script Type: AL Plugin
Web Site Address: http://forum.egosoft.com/viewtopic.php?t=105114
Update Address: http://files.sourceplugins.de/xs/

Listing files in package:
Scripts/al.invasion.stm.bad.xml (Script) Size: 2.32KB
Scripts/al.invasion.stm.calc.xml (Script) Size: 3.58KB
Scripts/al.invasion.stm.findraces.xml (Script) Size: 1.47KB
Scripts/al.invasion.stm.findsector.xml (Script) Size: 1.44KB
Scripts/al.invasion.stm.findships.xml (Script) Size: 4.77KB
Scripts/al.invasion.stm.good.xml (Script) Size: 2.32KB
Scripts/al.invasion.stm.killed.xml (Script) Size: 1.72KB
Scripts/al.invasion.stm.logrun.xml (Script) Size: 1.02KB
Scripts/al.invasion.stm.msgrun.xml (Script) Size: 904B
Scripts/al.invasion.stm.news.xml (Script) Size: 3.05KB
Scripts/al.invasion.stm.sendhome.xml (Script) Size: 1.58KB
Scripts/al.invasion.stm.shipcmd.xml (Script) Size: 2.20KB
Scripts/al.invasion.stm.shipwait.xml (Script) Size: 1.34KB
Scripts/al.invasion.stm.waiting.xml (Script) Size: 1.82KB
Scripts/al.plugin.invasion.stm.xml (Script) Size: 440B
Scripts/al.control.invasion.stm.bad.xml (Script) Size: 1.80KB
Scripts/al.control.invasion.stm.good.xml (Script) Size: 1.81KB
Scripts/al.invasion.stm.clearships.xml (Script) Size: 1.33KB
Scripts/al.invasion.stm.update.xml (Script) Size: 1.08KB
T/448502.xml (Text) Size: 3.76KB
T/498502.xml (Text) Size: 3.97KB

$ /Users/Dez/Desktop/SPKTool_mac -e /Users/Dez/Documents/X3\ Stuff/VoelkerInvasionen-V1.0.10-07.06.2007.spk /Users/davidgray/Documents/X3\ Stuff

SPKTool V1.00 (SPK File Version 4.00) 12/06/2007 Created by Cycrow

Opening SPK File, /Users/Dez/Documents/X3 Stuff/VoelkerInvasionen-V1.0.10-07.06.2007.spk... (Done)
Extracting all files from archive...(Error)
There was a problem extracting the files

[Biberkopf]

Since a few weeks X3TC is also available in the Mac Appstore. Unfortunetely i wasn´t able to install the bonus pack. There is a "t" and a "scripts" folder in the terranConflict.app, but the bonuspack installer (started with Wine) doesn´t recognize it as a valid target.

Are there any other Macians around who found a solution for this? Could one probably get the bonus packs scripts without the installer and put them by hand into the respecting folders?

Any help would be much appreciated!

[Steamo]

[X2-Illuminatus]

[webba84]

Since the bonuspack needs to recognize the X3 installation and CANNOT be installed in an empty folder it is a bit of a problem that the mac version translation code has been changed and the .app now has nowhere to point an installer to. We really just need the bonus pac in a convenient .zip or .rar or .7z format to dl or, better yet VP being convinced to get off their bums and include the bonus pack as an update for the mac version.
In the meantime I'm off to dl the files individually, sigh...

[jlehtone]

[icecoldrocker2]

Not X3TC! oh god!