Mod Database

Base

Structure

Key	Type(s)	Required	Information
"mods"	Object	Yes	Contains all Mods

Example

{ "mods": {} }

Mods Object

Structure

Key	Type(s)	Required	Information
(modId)	Object	--	Contains all Mod data

Example

"mods": { "mod1" : { }, ... }

Mod Data

Structure

Key	Type(s)	Required	Information
"name"	String	Yes	Mod name
"description"	String	Yes	Mod description (if empty: "")
"archive_link"	String	Yes	zip file; Containing the mod data
"hash"	Object	Yes	Hash for the zip file
"version"	String (1.2.3)	Yes	Version String
"license"	String or null	No	Mod license
"page"	Array or null	No	Additional links/pages
"dir"	Object or null	No	Install directory

Example

"ExampleMod" : { "name" : "example mod", "description" : "only an example", "license" : "MIT", "page" : [{ "name" : "GitHub", "url" : "https://github.com/CCDirectLink/CCModDB" }], "archive_link" : "https:://example.com/mod.zip", "hash" : { "sha256" : "exampleHash" }, "version" : "1.5.8" }

Hash Object

Key	Type(s)	Required	Information
"sha256"	String	Yes	Sha256-Hash

Other Hash-types are currently not supported

Page Array

Containing Objects:

Key	Type(s)	Required	Information
"name"	String	Yes	Page name/type
"url"	String	Yes	Page url

Install-dir Object

Use the key any to definie an install dir for all Systems. Use the system String (based on process.platform). A matching system will always override any.

Key	Type(s)	Required	Information
(system)	String	Yes	Install dir

Defined Environment variables:

Path	Information
root	CrossCode main install dir