Create a Content JSON

Essential Information

A Content JSON is a JSON file used to configure an entire Content instance. The easiest way to create this JSON file is by using our dedicated Content JSON Editor available on our official website here.

Content JSON Properties

id

• Type: string
• Required: True
• Description: ID of the Content Instance, only lowercase letters, numbers or hyphens. Cannot be changed in the future.

name

• Type: string
• Required: True
• Description: Display name of the Content.

maintenance?

• Type: string
• Required: False
• Description: Maintenance mode will disable the ability to play the Content until you disable it.

bannerURL

• Type: string
• Required: True
• Description: URL of the image to be used as the Content banner on the main page.

bgURL

• Type: string
• Required: True
• Description: URL of the image or video to be used as background on the Content page.

titleURL?

• Type: string
• Required: False
• Description: URL of the image to be used as the Content title. If none is provided, the Content name will be used as the title.

mcVer

• Type: string
• Required: True
• Description: Minecraft version of the Content instance.

mcLoader

• Type: string
• Required: True
• Description: Mod Loader of the Content instance.

mcLoaderVer?

• Type: string
• Required: False
• Description: Specific version of the Mod Loader. If unspecified, the latest available version will be used.

mcServerIP?

• Type: string
• Required: False
• Description: The public IP address of the Minecraft server will be used to indicate its online status and player count.

updateVer

• Type: floating-point
• Required: True
• Description: Version number of the new update. Must be higher than the preceding version.

updateFileUrl

• Type: string
• Required: True
• Description: URL of the ZIP file containing all the necessary files (mods, settings, shaders) for your Content instace."

updateKeepedFiles

• Type: array
• Required: True
• Description: Array containing the names of files and folders to be kept.

Content JSON Example

If you'd like to see an example of a Content JSON, please refer to this specific point.

Publishing a Content JSON

For more information on how to publish your Content JSON, continue to the next page.