packs.json - AlexisL61/JackboxUtility-Server-fr GitHub Wiki

Description

The packs.json file is where all of your data for packs and tags are. It also contains data about categories in the "all packs" tab.

Doc

Variable Type Description
tags Array<Tag> Tags used by games
patchsCategories Array<PatchCategory> Categories availables in the all tab for this server
packs Array<Pack> Packs available

PatchCategory

A category grouping patchs together for the "all" tab of the Patching page.

Variable Type Description
id String Id of the category (it should be unique)
name String Name of the category (shown in the category list)
smallDescription String Small description for this category
patchs Array<String> Array containing patchs id. It can be an id from a GamePatch or from a PackPatch

Tag

Variable Type Description
id String Id of the tag (it should be unique)
name String Name of the tag
icon String FluentUI Icon's name (icons can be find in https://bdlukaa.github.io/fluent_ui/ in the icons part)
description String Description of the tag

Pack

Variable Type Description
id String Id of the pack (it should be unique)
name String Name of the pack
description String Description of the pack
icon String Icon of the pack in the app (it should be a ico, png, jpg... file)
background String Background of the pack in the app (it should be a png, jpg... file)
loader Loader Loader for this pack
patchs Array<PackPatch> Patchs available for this pack
executables Object:{windows:String, mac: String, linux:String} Executables name for this pack
games Array<Game> Games available in this pack
patchs Array<PackPatch Patchs available for this pack

Game

Variable Type Description
id String Id of the game (it should be unique)
name String Name of the game
background String Background of the pack in the app (it should be a png, jpg... file)
path String Location of the game in the pack
loader Loader Loader for this game
patchs Array<GamePatch> Patchs available for this game
game_info GameInfo Informations about this game

GameInfo

Variable Type Description
players Object : {min:number, max:number} Number of participants in this game
length String Length of the game
type String : "VERSUS" | "COOP" | "TEAM" Type of the game
translation String : "ENGLISH" | "NATIVELY_TRANSLATED" | "COMMUNITY_TRANSLATED" Translation of the game
tagline String Tagline of the game
small_description String Small description of the game
description String Description of the game
images Array Images for this game
tags Array A list of tags (id of the tags)

GamePatch

Variable Type Description
id String Id of the patch (it should be unique)
name String Name of the patch
small_description String Small description for this patch
description String Description for the patch
authors String Authors of this patch
version String Version number for this patch
patch_path String Path of the patch on the server (in zip format)
patch_type Object : {game_text:boolean, game_assets:boolean, game_subtitles:boolean, website:boolean, audios:boolean} Patch's type

PackPatch

A patch for a whole pack

Variable Type Description
id String Id of the patch (it should be unique)
name String Name of the patch (for example Party Pack 7 French)
smallDescription String A small description for this patch
version String The latest version for this patch (the version should be the same than the version in the config.jet file in your pack)
components Array<PackPatchComponent> Components in this patch (usually it is the games in the patch)

PackPatchComponent

A component in a pack patch (Usually it is a game in a patch)

Variable Type Description
id String Id of the component (it should be unique)
linkedGame String Optional. If your component is linked with a game, you should put the game id here
name String Name of this component
small_description String Small description for this patch
description String Description for this patch
authors String Authors of this patch
patch_type Object : {game_text:boolean, game_assets:boolean, game_subtitles:boolean, website:boolean, audios:boolean} Patch's type

Loader

The loader is a zip containing files for the FastLauncher feature on the app

Variable Type Description
path String Path of the zip on the server
version String Version of the zip on the server
⚠️ **GitHub.com Fallback** ⚠️