id configuration doc - TsubakiBotPad/pad-cogs GitHub Wiki

The id configuration doc is maintained by Tsubaki admins to provide some useful manual overrides to the automatic process of configuring id. It has several tabs, each of which has a distinct purpose.

Treenames

Treenames apply the name to every single card in the tree. This is what will be used most of the time. Treenames cause the tree in question to have higher priority with the name in question than anything else in the game (except for other trees sharing the same manual treename, if applicable).

To add a treename, use the id number of the base monster in the tree.

Examples

  • A standard example: qilindra is a treename for Seven-Star Beast, Qilin Dragon; this name is way too far away for nearest-matching to do its thing, and we want to be able to run ^id qilindra and pull up Qilin Dragon.
  • Fallen Angel Lucifer and Archangel Lucifer share the treename Luci. Their unique treenames are aaluci and faluci.
  • xm, hel, and cloud are treenames for xiang mei, hel, and cloud from Final Fantasy collab, to override conflicts with the modifiers for Christmas, heart el, and cloud resist awakening, respectively.

Nicknames

Nicknames are added to individual cards. Like treenames, nicknames give a higher priority to cards with them when they are searched.

low_priority column

Name tokens can be added to a card JUST to inform what should be fluff tokens & what should be name tokens. As such, you can specify low_priority to say, "don't give this card higher priority than others with this name, I'm just informing about fluff tokens!"

Examples

  • Fixing Winged Dragon because he is in the same tree as Dark Magician Girl: We give a nickname of winged dragon both to Winged Dragon (5810) and Winged Dragon equip (5810). (The same nickname is used in both cases; the modifier will be used to look up the equip.)
  • alb and acc are given as nicknames for Awoken Liu Bei and Awoken Cao Cao, respectively, since these abbreviations refer to the specific evos in the trees. Note, however, that this comes at a price: queries like base alb cannot be resolved.
  • lampeid is added to 5984, mighty lancer, lampeid with low priority = yes. This way, lampeid becomes a name token, but the transformed version, 5985, is still the higher-priority version of the card.

Counterexamples

  • BGoemon should NOT be added as a nickname for Beach Goemon. This should be a treename, even though his tree contains only one member. This is because if he ever got an evo, we would want to do things like base bgoemon, equip bgoemon, etc.
  • In the above example, we would NOT add equip winged dragon as a nickname, because equip is a modifier. We just add winged dragon as the nickname, and allow equip to function normally as a modifier in the search.

NameTokenAliases

This tab is like "autocomplete." It should be used for name tokens that we want to be consistently aliased whenever the name shows up. For example, kami is always short for kamimusubi, and ama is always short for amaterasu, both in the GFE/pantheon forms of these cards, and the seasonal versions, etc. This sheet basically allows us to avoid making lots of individual treenames for cards.

SeriesNames

This tab lets us give names of series. Note that the full official name of a series is always automatically added, so we do not need to put that into column 2.

  • Column 1: The internal numerical id of the series
  • Column 2: The nickname we are adding
  • Column 3: Not used by the software, but the name of the series/pantheon, for our reference
  • Column 4: Optional comment

Remember series names can be used as modifiers, and also a query does not require any non-modifier token, so for example ^id b samurai iii is a valid query, as is ^id dbdc ideal, so we want to support a wide range of queries here, but try not to go too overboard.