custom.JSON

You can include custom cards in your Campaigns. This requires the use of a "custom.json" file in your /data/ directory.
You also need to set "custom": true in your settings.json file.

JSON Structure

This JSON is a single [Array] of {Objects}. For example:

        [
          {
            "name": "Card_1", ...
          },
          {
            "name": "Card_2", ...
          }
        ]
      

Custom Card Formatting

Custom cards use the standard Ygoprodeck API formatting.

Example Card

Here is an example card.
The campaign will return an Error if any of the required fields are omitted, including the artist credits.

        {
          "name": "Tornado Dragon",
          "type": "XYZ Monster",
          "desc": "2 Level 4 monsters\nOnce per turn (Quick Effect): You can detach 1 material from this card, then target 1 Spell/Trap on the field; destroy it.",
          "atk":  2100,
          "def":  2000,
          "level": 4,
          "race": "Wyrm",
          "attribute": "WIND",
          "credits": "ArtistName"
        }
      

Special Case Attributes

These Attributes have some extra constrains/features:

• The card's artwork must be a .webp image of the same name in your /custom/ folder. Recommended image size is around 500x500px.
• "name" cannot exceed 70 characters.
• if "atk" or "def" is set to -1, it will appear as "?" while in-game.
• Cards that share names, like Harpie Lady, have an extra "nameShares":"Harpie Lady" attribute. This is what causes them to be treated as the same card.
• "desc" cannot exceed 1000 characters.
  Also, if all of your custom card descs combined contain more than 10,000 characters, a warning will be displayed to the user before starting the campaign.
  Remember that your players are going to need to read many of these cards!
  Very short description text is strongly recommended.

Language Translations (optional)

You can add language transtions, if you like:

        "de" (German Card Text)
        "fr" (French Card Text)
        "pt" (Portuguese Card Text)
        "it" (Italian Card Text)
        "es" (Spanish Card Text)
        "ko" (Korean Card Text)
        "ja" (Japanese Card Text)
      

Pendulum Monsters

Pendulum cards can be added by making the desc an [Array] of length 2.
You also need to specify the Pendulum Scale.
If your Pendulum Monster has no monster effect or Spell/Trap effect, make those "Strings" eqeual to "".

          "name": "Archfiend Eccentrick",
          "type": "Pendulum Effect Monster",
          "desc": [
            "● You can target 1 other Spell/Trap on the field; destroy both it and this card.\nYou can only use this effect of \"Archfiend Eccentrick\" once per turn.",
            "● You can Tribute this card, then target 1 monster on the field; destroy it.\nYou can only use this effect of \"Archfiend Eccentrick\" once per turn."
          ]
          "atk": 800,
          "def": 1000,
          "level": 3,
          "race": "Fiend",
          "attribute": "LIGHT",
          "scale": 7,
          "credits": "ArtistName"
        

Link Monsters

Link Markers are required and are stored in their own Array. Unlike in the API, you do not need to specify the linkval - this is calculated for you.

        "name": "Decode Talker",
        "type": "Link Monster",
        "desc": "● 2+ Effect Monsters\n● Gains 500 ATK for each monster it points to.\n● When your opponent activates a card or effect that targets a card(s) you control (Quick): You can Tribute 1 monster this card points to; negate the activation, and if you do, destroy that card.",
        "atk": 2300,
        "race": "Cyberse",
        "attribute": "DARK",
        "linkmarkers": [ "Top", "Bottom-Left", "Bottom-Right" ],
        "credits": "ArtistName"
      

Tuner / Union / Spirit / Toon / Gemini Monsters

Add these abilities to the "type" String. The order does not matter.

        "name": "Y-Dragon Head",
        "type": "Union Effect Monster",
        "desc": "● Once per turn, you can either: Target 1 \"X-Head Cannon\" you control; equip this card to that target, OR: Unequip this card and Special Summon it.\n● A monster equipped with this card gains 400 ATK/DEF, also if the equipped monster would be destroyed by battle or card effect, destroy this card instead.",
        "atk": 1500,
        "def": 1600,
        "level": 4,
        "race": "Machine",
        "attribute": "LIGHT",
        "credits": "ArtistName"
      

Duelingbook integration

If you'd prefer to play on duelingbook instead of the in-built DDM simulator, you can set "duelingbookIntegration": true in settings.json.

You then need to:

• Remake every custom card on Duelingbook.com, and set them as "Available To: Everyone" on duelingbook.
• Add a "dbID" Attribute to every card in custom.json, with the appropriate duelingbookID. This is at the end of your custom card's URL, eg "https://www.duelingbook.com/card?id=1234567"

Currently, this is the only way to allow the exporting of decks with custom cards to any other simulator.

Rush Duel Cards

You can add rush duel cards to your campaign as you would any other custom card. If you set "defaultFrame": "rush-duel" in settings.json, cards will have the rush frame by default.

A copy of all data for rush duel cards as of 1 August 2024 is available for download below. You will need to source any card images yourself, as with all custom cards.

Download RUSH custom.json