SimonJWales / StarCitizen.Hal.Extractor

Star citizen p4k data extractor

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

HAL X Windows license Commits Last commit Buy Me a Coffee

Star Citizen Hal Extractor

APP FOR DECOMPRESSING, EXTRACTING AND CONVERTING STAR CITIZEN GAME DATA FOR USE IN EXTERNAL APPLICATIONS.

THIS IS AN UNOFFICIAL STAR CITIZEN FAN SITE, THAT IS NOT AFFILIATED WITH CLOUD IMPERIUM GAMES OR ROBERTS SPACE INDUSTRIES. ALL CONTENT IN THIS REPO NOT AUTHORED BY THE OWNER OF THE REPO IS THE PROPERTY OF THE RESPECTIVE OWNER.

This application is based on the efforts of Peter Dolkens (unp4k).
Full credit goes to him for creating the orignal code bases that this application utilises 
and re-implements. See below for full information about his inspiring Star Citizen project.

So what is it?

The Star Citizen HAL Extractor (HAL X for short) is a windows application that can extract game data from the .p4k game file of Star Citizen and output xml, graphic and any other data within the .p4k data file, for use in external programs.

Development Installation

  • Fork this repo if you want to play around with the code (and improve it)

General Installation (standalone version)

  • If you don't want to dig around in the code and simply want to get the app running and the data out, then you can use the stand-alone version of HAL X
  • Get the latest free version of HAL Extractor from the Microsoft Windows Store
  • Once installed, you can find the application in the apps list, as usual; Start > All > H > HAL Extractor

How to (standalone version)

  • Open the application in the same way you open any other app on your device.
  • Select the location of the .p4k data file (this will be remembered between sessions)
  • Select the output folder for the extracted data (this will be remembered between sessions)
  • Select the file types you want to extract
  • Hit the Extract button

Why do we need this?

While unp4k is terrific at getting the data out from the Data.p4k file and outputing user friendly objects, it does not seem to be updated or maintained.

I wanted to create an easy to use web app that could give me useful information about where I could buy a particular item or what items that I could put in a specific vehicle - which became sc-hal.com, which itself is still a work in progress.

Without the extraction and conversion tools the website would not be able to be updated, so I created the HAL Extractor to solve my problem. Maybe it can help you too. It is one of the applications I created for sc-hal.com and it is offered here free in the hope someone else can benefit from it and why I made this repo public.

A complete extraction (using default files) can take between 2 and 10 minutes (depending on your system). Around 1 minute to extract the files from the .p4k and the rest of the time converting the binary cryXML files to readable formats.

Known issues

App reports possible errors on extraction. - This is unfortunately due to the fact some of the cryXml files have incorrect attribute values when trying to read the binary data. Files affacted are generally environmental files such as rain textures (though of course something is important to someone), it does not impact vehicle and item data or any graphics related files.


Project links

HAL Extractor free version from the Microsoft Windows Store

unp4k


made-by-the-community-white-200 app_icon

About

Star citizen p4k data extractor

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:C# 100.0%