Modding:General Best Practices: Difference between revisions

From Caves of Qud Wiki
Jump to navigation Jump to search
imported>CaptainTechnicality54384
mNo edit summary
m (formatting, punctuation)
Line 1: Line 1:
[[Category:Modding]]
[[Category:Modding]]
= Prefix your object and table names with some unique ID =
= Prefix your object and table names with some unique ID =
For instance, alphabeardmods_{id}, this will prevent namespace conflicts with official content and other mods in the future.
For instance, <code>alphabeardmods_{id}</code>. This will prevent namespace conflicts with official content and other mods in the future.


<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
Line 12: Line 12:
</syntaxhighlight>
</syntaxhighlight>


= Only include your content and the minimum changeset via Load="Merge" in tables and object definitions =
= Only include your content and the minimum changeset via <code>Load="Merge"</code> in tables and object definitions =
Don't copy the whole contents of the game xml. You only need to include new content.
Don't copy the whole contents of the game xml. You only need to include new content.


For objects and encountertables, if you're editing an existing item you can use Load="Merge" in it's tag and only specify new items. For example, if I wanted my mod to give chain mail a 2DV:
For objects and encounter tables, if you're editing an existing item you can use <code>Load="Merge"</code> in it's tag and only specify new items. For example, if I wanted my mod to give chain mail a 2DV:


<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">

Revision as of 02:47, 27 May 2019

Prefix your object and table names with some unique ID

For instance, alphabeardmods_{id}. This will prevent namespace conflicts with official content and other mods in the future.

<?xml version="1.0" encoding="utf-8"?>
<objects>
  <object Name="ALPHABEARDMODS_CoolNewSword" Load="Merge">
...
  </object> 
</objects>

Only include your content and the minimum changeset via Load="Merge" in tables and object definitions

Don't copy the whole contents of the game xml. You only need to include new content.

For objects and encounter tables, if you're editing an existing item you can use Load="Merge" in it's tag and only specify new items. For example, if I wanted my mod to give chain mail a 2DV:

<?xml version="1.0" encoding="utf-8"?>
<objects>
  <object Name="Chain Mail" Load="Merge">
    <part Name="Armor" DV="2" />
  </object> 
</objects>