Contents

• Variants
  • What variants cannot do
  • Issues
  • Criteria
  • Guns and drugs

Variants

Variants, added in #51613 and #46814 are CDDAs solution to allowing the same item have different names. It’s used in guns to have generic or specific names changeable with a setting, or in items such as clothing to have lots of different colors without having a bunch of essentially duplicate entries for an item. They can be weighted, meaning different variants have a different chance of showing up when the base item is spawned. They’re a great way to add extra variety to the game at a low cost to both effort, and file sizes. The information on how variants are defined shares the same doc as snippets, here. This doc aims to provide contributors with a good idea of what is, and isn’t acceptable as variants.

Do note that for some items, such as newspapers where the description changes and the name does not, snippets may be better. There’s also snippets in the form of conditional names, which can allow what are essentially variants in a more nuanced way, such as changing the name of an item depending on crafting materials, instead of a bunch of crafting recipes for different variants.

What variants cannot do

Variants cannot change any stat of an item, besides the name, description, color, sprite, and symbol. They’re nothing more than an aesthetic change and have no impact on gameplay.

Issues

As cool as variants are, sometimes issues can arise if there are too many variants of an item with nothing to reign them in. As an example, condoms had a few joke flavors that didn’t make sense. This then snowballed into other items having variants that were nothing more than jokes, such as chewing gum having fart, cat hairball, and zombie flavors. Another issue is that more variants complicate translating, making an already difficult job even more difficult.

Criteria

Variants should add meaningful variety to CDDA. They should be distinct from other variants and also be reasonably attainable in the real world, and not be overly specific or detailed. There isn’t any hard number on the amount of variants that are acceptable, as it can vary greatly from item to item.

Don’t be overzealous with joke variants, one joke variant alone is not likely to be accepted, and multiple joke variants are even less likely.

Guns and drugs

The way guns and drugs use variants is a bit different from other variants, as they use variants to have different names depending on options. This is to provide alternate titles for people who may be more or less familiar with common names of these items. For the way guns use please see the extensive guidelines at GUN_NAMING_AND_INCLUSION.md, and for drugs follow this example with Prozac/antidepressants.