Ludeon Forums

RimWorld => Mods => Topic started by: Sion on March 04, 2020, 02:34:09 PM

Title: [Solved] About.xml how to choose: <packageId> ?
Post by: Sion on March 04, 2020, 02:34:09 PM
I see almost all mods have a <packageId> tag in their About.xml file, but I can't find any documentation about how to get/choose the ID.

Is it just chosen "randomly" like "I think I will call my ID this ...", or is it supposed to have some structure & logic behind it?

Thanks!
Title: Re: About.xml how to choose: <packageId> ?
Post by: BlackSmokeDMax on March 05, 2020, 11:38:05 AM
The info is in the readme file in the main folder of the game install.


OOPS!, sorry I meant it is in the "ModUpdating.txt" file in the main folder of the game isntall!
Title: Re: About.xml how to choose: <packageId> ?
Post by: Sion on March 06, 2020, 06:35:52 AM
Thank you!
I didn't know about that file.



If anyone is wondering, the rules for <packageId> are:

- <packageId> (string, required)
  A unique identifier by which other mods and the game will refer to a mod.
  <packageId> must follow a specific format:
     * Alphanumeric characters and dot only.
     * No spaces.
     * At least one dot.
     * No repeated dots in a row, or starting or ending with a dot.
     * 60 characters or less.
     * Cannot contain word "Ludeon".
   
  Examples:
  <packageId>AuthorName.ModName</packageId>
  <packageId>AuthorName.ModSeriesName.ModName</packageId>.

  For backwards compatibility, if no packageId is defined, it will be auto-generated from "Author" and "Name" fields.
  Game won't load two mods with the same packageId. The only exception is if one of them is a workshop mod and the other one is local, then you can have both of them installed and one of them active.


There are also about 24 other mentions of "packageId" in the file, I suggest you read it yourself, use your text editors search function ( usually: Ctrl + F ) to find the texts.