Distribution Attribute

The distribution attribute of a mod information file allows you to notify players of every update to your mod.

Example Distribution Attribute Snippet

"Distribution": {
	"UpdatesController": "NeonOcean",
	"UpdatesFileURL": "http://alice.github.io/latest.json",
	"DownloadURL": "https://www.alicemods.com/example",
	"PreviewDownloadURL": "https://www.alicemods.com/example"
},

Attributes

• UpdatesController (Required attribute): The update controller that should be handling the checks and showing update notifications. The built-in update controller is named "NeonOcean".
• UpdatesFileURL (Required attribute): A URL link leading to a file that tells the update controller whether or not an update to your mod has been released. More information on this file will be listed further down this page.
• DownloadURL (Optional attribute): A URL may send the player to if they elect to update your mod when prompted. This URL should be used when a stable update has been released. If this attribute is not used, the player should simply be told an update is available, with no link provied.
• PreviewDownloadURL (Optional attribute): A URL may send the player to if they elect to update your mod when prompted. This URL should be used when a preview update has been released. If this attribute is not used, we will send them to the download URL instead.

Updates Files

Updates files are used by updates controllers to determine whether or not a mod is out of date.

Example Updates File

This is an example that works with the built-in update controller. If the release number or preview number is greater than the current version number, the player will be notified of the update.

{
	"Alice.Example": {
		"Release": "1.0.0"
		"Preview": "1.1.0"
	},
},