Post news RSS ModAPI V3

The new ModAPI V3 changes the Mod-Descriptor-Files

Posted by on

From XML to JSON

Instead of the XML-Descriptor files we are now using JSON files because they allow us easier parsing in the engine and are generaly easier to read.
We have also developed the FileVersion System. This allows Unreal Transport to ignore missing variables if the FileVersion is not the same as the current
standard. Currently all variables shown in the example below are needed but with future FileVersion we want to add optional parameters such as Author, Website, etc.
While this new filetyp is a mandatory change you can still use the ModAPI V2 and just replace the XML with a JSON file.

Here is our current list of planned parameters:

  • Author
  • FriendlyName
  • FriendlyVersion
  • Moddb Page / Website
  • Folder Path (for shared data between mods)

If you have an idea for additions feel free to share them in the comments!

The current FileVersion is 1.1.

Example:

{
	"FileVersion": "1.1",
	"ModAPI": "3",
	"Id": "example_mod",
	"Version": "1"
}
Post a comment
Sign in or join with:

Only registered members can share their thoughts. So come on! Join the community today (totally free - or sign in with your social account on the right) and join in the conversation.