Installation & Updating
Windows
- Download and run the latest installer from the download page.
- If you are updating, the installer will handle replacing old files for you.
- You may recieve antivirus warning messages. You can ignore these, PAKit is virus free.
If you are super concerned about security, you can clone the repository and build from source (see below).
MacOS
- Download the latest .dmg package from the download page.
- Double click the .dmg to open it.
- Drag the
PAKit
app to you applications folder. - If you are upgrading, simply replace the old app file.
- When you run PAKit, you may get a warning saying that it is from an unidentified developer. If this is the case, go into your
System Preferences
, clickSecurity
and pressOpen Anyway
near the bottom.
Linux (Ubuntu/Debian)
- Download the latest .deb package from the download page.
- Double click the .deb to open it in your package manager.
- Press
Install
. You may have to type in your password. - If you are upgrading, the new files should overwrite the old ones.
Building from source
Requires familiarity with git
- Ensure you have git and npm/node.js installed
- Clone the repository (use the 'master' branch)
- Inside the downloaded folder run the command
npm run package-<platform>
to build from source, where<platform>
is eitherwin
,mac
orlinux
. - Your build will be output to the
release-builds/
folder. - If you want to create an installer, additionally run
npm run installer-<platform>
to build from source, where platform is eitherwin
,mac
orlinux
. - To upgrade, run
git pull
and redo the above steps.
Unpacking
- In the
Unpack
tab, select your source .pak file. This should open to your Starbound directory by default. The base game assets (packed.pak
) can be found in theassets
folder. - Select the destiation folder next. A subfolder will be created, so if you select
.../Desktop
your file will be extracted to.../Desktop/packed/
- Now press
Unpack
. Leave PAKit open until the process is done.
If you wish to terminate the process at any point, simply close PAKit.
Packing
- In the
Pack
tab, select your source assets folder. - Select the destiation .pak file next. Navigate to you want to save it to and enter a file name.
- Now press
Pack
. Leave PAKit open until the process is done.
If you wish to terminate the process at any point, simply close PAKit.
Locating executables
If PAKit fails to locate the asset_packer
and asset_unpacker
executables in your source files, you will have to locate them manually in order to use PAKit.
- Make sure Starbound is installed on your system.
- Open Steam, and go to your library. Right click on Starbound and open
PROPERTIES
. - Go the the
LOCAL FILES
tab, and pressBROWSE LOCAL FILES ...
. - Then open the executables folder (Windows:
win32
, MacOS:osx
, Linux:linux
). - Copy your current path, open PAKit and go to the
Settings
tab. - Press either of the
Select
buttons, and paste in the path. Select the relevant executable in this folder. - Repeat step 5 for the other executable, and then press
Save