Difference between revisions of "About.xml"

From RimWorld Wiki
Jump to navigation Jump to search
m (→‎Tags: Fixed the stupid comment error. Now proper comments)
(Redirecting this old page to the new About.xml page in the actual Modding_Tutorials folder)
Tag: New redirect
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
{{stub}}
+
#REDIRECT [[Modding_Tutorials/About.xml]]
−
This article is supposed to explain what tags are available in the About.xml file & what the tags do & how you should use them. The exact format of the article is still under development, please help.
 
−
 
 
−
(Yes, I'm aware that I'm not writing this as objectively as an article should be (sorry), but I feel I need to explain what this article should aim towards, please DON'T just delete it! )
 
−
 
 
−
== Tags ==
 
−
 
 
−
These are the tags I have found in various mods I have downloaded, but I don't understand all of them, i'm not sure if all of them even CAN be combined with each other & therefore I need help from more experienced developers.
 
−
 
 
−
<pre>
 
−
<?xml version="1.0" encoding="utf-8"?>
 
−
 
 
−
<ModMetaData>
 
−
<name>Example Mod</name>
 
−
<!-- The name of the mod -->
 
−
<author>Mod Author</author>
 
−
<!-- The mod author name, usually set to your Steam/Forum name -->
 
−
<url>www.anything.com</url>
 
−
<!-- A URL to be displayed on your mod info page(if available). Can be set to link to anything. Most link it to their Github/Workshop page/forum post. -->
 
−
<packageId>AuthorName.ModName/ModSeries.ModName/AuthorName.ModSeries.ModName</packageId>
 
−
<!-- Added in 1.0. Please make it human readable. Avoid acronyms where possible. -->
 
−
<supportedVersions>
 
−
<li>0.0</li>
 
−
<li>0.1</li>
 
−
</supportedVersions>
 
−
<!-- Supported version lists which versions of Rimworld your mod is compatible with. If your mod doesn't break across versions, lists them all here. -->
 
−
<modDependencies>
 
−
    <li>
 
−
      <packageId>Unknown (help extend this)</packageId>
 
−
      <displayName>Unknown (help extend this)</displayName>
 
−
      <downloadUrl>Unknown (help extend this)</downloadUrl>
 
−
      <steamWorkshopUrl>Unknown (help extend this)</steamWorkshopUrl>
 
−
    </li>
 
−
</modDependencies>
 
−
<modDependenciesByVersion>
 
−
    <v1.1>
 
−
      <li>
 
−
        <packageId>Unknown (help extend this)</packageId>
 
−
        <displayName>Unknown (help extend this)</displayName>
 
−
        <steamWorkshopUrl>Unknown (help extend this)</steamWorkshopUrl>
 
−
        <downloadUrl>Unknown (help extend this)</downloadUrl>
 
−
      </li>
 
−
    </v1.1>
 
−
</modDependenciesByVersion>
 
−
<description>
 
−
Sample description
 
−
</description>
 
−
<!-- Describes your mod, can be multiple lines long. -->
 
−
<loadAfter>
 
−
<li>Ludeon.RimWorld</li>
 
−
<li>Ludeon.RimWorld.Royalty</li>
 
−
</loadAfter>
 
−
<!-- Lists the mods which should be loaded before your mod. Helps ensure your dependencies are loaded in first. -->
 
−
</ModMetaData>
 
−
 
 
−
</pre>
 
−
 
 
−
== Deprecated Parts ==
 
−
<targetVersion> has been replaced by <supportedVersions>. Use is as follows :
 
−
<pre>
 
−
<supportedVersions>
 
−
<li>1.0</li>
 
−
</supportedVersions>
 
−
</pre>
 
−
== Another tag format? ==
 
−
 
 
−
Another way to explain this data might be more similar to a filesystem, like this:
 
−
* ModMetaData/name = The name of the mod (probably better)
 
−
or:
 
−
* <ModMetaData>/<author> = Name of who created this mod (bad, because eg: <nowiki><li></nowiki> interfere with the Wiki-code)
 
−
 
 
−
or: (I really like this format)
 
−
* '''<?xml version="1.0" encoding="utf-8"?>''' - MUST be included exactly like this, explains to the program how the data should be interpreted.
 
−
* '''ModMetaData''' - A container for all the data that is related to this mod.
 
−
** '''name''' - The name of the mod.
 
−
** '''author''' - The name of the author.
 
−
*** '''supportedVersions''' - A container for suported versions.
 
−
**** '''li''' - A list item containing a version number, like 1.0 or 2.5.3
 
−
*** '''modDependencies''' - A container for mods that is needed for this nod to function properly.
 
−
* ....
 
−
 
 
−
== Questions ==
 
−
* <ModMetaData>/<packageId> How is this determined?
 
−
* Are <ModMetaData>/ <modDependencies> & <modDependenciesByVersion> mutually exclusive? or can both be present in the same file?
 
−
* I think there exist some kind of: <ModMetaData>/ '''<incompatibleWith>''' / <nowiki><li></nowiki> /<packageId> tag, but I haven't seen it in any of my downloaded mods, please add it if you know more about it.
 

Latest revision as of 02:14, 13 June 2023

Redirect to:

Retrieved from "https://rimworldwiki.com/index.php?title=About.xml&oldid=135261"