dymerz/starcitizen-gamedata

Convert StarCitizen XML files to JSON/SQL

StarCitizen-GameData

This tool allow users to convert raw XML from the unp4k tool in JSON format or SQL format.

You can also directly download binaries here.

This tool is user by the StarCitizen-API to allow user to easily retrieve Star Citizen data, if you want to contribute, follow the contributing guideline.

Supported versions

• 3.6.1 → 3.10.2

Usage

Extract Data.p4k

	unp4k.exe "C:\Program Files\Roberts Space Industries\StarCitizen\LIVE\Data.p4k" "*.xml"
	unp4k.exe "C:\Program Files\Roberts Space Industries\StarCitizen\LIVE\Data.p4k" "*.json"
	unp4k.exe "C:\Program Files\Roberts Space Industries\StarCitizen\LIVE\Data.p4k" "*.ini"
	
	unforge.exe ./Data/

Arguments

StarCitizen_XML_to_JSON.exe source [destination] [config...] [filter...]

• source: The path of the Data provided by unp4k.
• destination: Where to store files (default: Working directory).
• configs:
  • --debug: Enable Debug logs.
  • --cache: Use cache (speed up the process but may not be compatible between SC versions).
  • --rebuild: Remove the cache and rebuild a new one.
  • --english: Use the English localization (default).
  • --french: Use the French localization (not implemented).
  • --german: Use the German localization (not implemented).
  • --version: Print the current version of the application.
  • --help: Print help.
• filters:
  • --all, -a
  • --ships, -s
  • --weapons, -w
  • --weapons-magazine, -wm
  • --commodities, -c
  • --tags, -t
  • --shops, -S
  • --manufacturers, -m
  • --starmap, -sm (not implemented).

StarCitizen_JSON_to_SQL.exe source destination database_name sc_version [config...] [filter...]

• source
• destination
• database_name
• sc-version
• configs:
  • --debug: Enable Debug logs.
  • --minify: Generate minified JSON
  • --help: Print help.
• filters:
  • --all, -a
  • --ships, -s
  • --weapons, -w
  • --weapons-magazine, -wm
  • --commodities, -c
  • --tags, -t
  • --shops, -S
  • --manufacturers, -m
  • --starmap, -sm (not implemented).

Manually build

Requirements

• nuget (Powershell →Install-Package NuGet.CommandLine).
• .Net Core 3.1+.

Setting up

• Clone this repo.
• Install all dependencies using nuget install.

Building

• Execute the build.bat to generate JSON and SQL Converter.
• Get the output in {sub project}\bin\Release\{netcoreapp2.2}\{platform}.

Contributes

To contribute to this project, see contributing file.

starcitizen-gamedata's Issues

Host the json somewhere, or put it in a repo?

It would be great if you could make the JSON available somewhere online :)

stuck at Starting

Hi I tested your program but it stucks at Starting. Here a snip from the cmd.exe `C:\Users\strob\Desktop\xml2jason>StarCitizen_XML_to_JSON.exe C:\Users\strob\Desktop\Data\ --cache --ships
Process has started.

Parameters:
Source: C:\Users\strob\Desktop\Data
Destination: C:\Users\strob\Desktop\xml2jason\

[+] Loading directory (this can take some time).. |
[!] Failed to convert to XML 'C:\Users\strob\Desktop\Data\Scripts\Entities\Vehicles\Implementations\Xml\AEGS_Gladius.xml'
Done
[+] Preparing resources.. Done
[+] Loading localization.. Done
[*] Files to be converted: 55

[*] Starting..`
It runs for about 10 hours.

-a flag isn't recognised

StarCitizen_XML_to_JSON.exe .\Data\ .\json\ -a

[!] Unknown parameter: -a