User Tools

Site Tools


mods:create_source

How to create a source

To do this, you need either your own server or file hosting like github.com.

The URL must return JSON in the format

{
  "name": "Source name",
  "mods": [
    {
      "id": "mod-id",
      "name": "Mod name",
      "version": "1.0",
      "description": "Description of the mod",
      "game_version": "0.16",
      "file_name": "mod_archive.zip"
    },
    {
      "id": "mod-id-2",
      "name": "Name of another mod",
      "version": "2.0",
      "description": "Description of another mod",
      "game_version": "0.16",
      "file_name": "another_mod_archive.zip"
    }
  ]
}

The files mod_archive.zip and another_mod_archive.zip must be available at source_url/file_name.

Or, if the source URL ends in .json, then the mod files should be next to the json file.

Examples

Source URL: https://example.com/mods
file_name: example_mod.zip
Mods URL: https://example.com/mods/example_mod.zip

Source URL: https://example.com/mods/manifest.json
file_name: example_mod.zip
Mods URL: https://example.com/mods/example_mod.zip

Format

  • name - String - Source name
  • mods - Array - Array with mods
  • mods.N.id - String - ID of the mod. Must be unique for each mod
  • mods.N.name - String - Mod name
  • mods.N.version - String - Mod version
  • mods.N.description - String - Description of the mod
  • mods.N.game_version - String - The minimum version of the game that the mod can run on
  • mods.N.file_name - String - The name of the archive with the mod. Only zip archive!
mods/create_source.txt · Last modified: 2022/12/30 19:35 by superuser