@randsum/roller/bin/help.json

A flexible, type-safe dice roller for tabletop RPGs, game development, and probability simulations

{
  "title": "RANDSUM Roller CLI - Advanced Dice Rolling Engine",
  "usage": "randsum <dice-notation>",
  "sections": [
    {
      "title": "BASIC DICE NOTATION",
      "items": [
        "2d6          Roll 2 six-sided dice",
        "1d20         Roll 1 twenty-sided dice",
        "4d8          Roll 4 eight-sided dice",
        "100d1        Roll 100 one-sided dice (always 1)"
      ]
    },
    {
      "title": "MODIFIERS",
      "subsections": [
        {
          "title": "Drop Modifiers",
          "items": [
            "4d6L       Drop lowest die (D&D ability scores)",
            "4d6L2      Drop 2 lowest dice",
            "2d20H      Drop highest die (disadvantage)",
            "4d6LH      Drop both lowest and highest"
          ]
        },
        {
          "title": "Reroll Modifiers",
          "items": [
            "4d6R{1}    Reroll any 1s",
            "4d6R{1,2}  Reroll 1s and 2s",
            "4d6R{<3}   Reroll results below 3",
            "4d6R{>4}   Reroll results above 4"
          ]
        },
        {
          "title": "Exploding Dice",
          "items": [
            "3d6!       Reroll and add on max result (6s)",
            "2d10!      Reroll and add on max result (10s)"
          ]
        },
        {
          "title": "Unique Results",
          "items": ["4d20U      All dice must show different results"]
        },
        {
          "title": "Capping Results",
          "items": ["4d20C{>18} Cap results above 18", "4d20C{<3}  Cap results below 3"]
        },
        {
          "title": "Arithmetic",
          "items": [
            "2d6+3      Add 3 to total",
            "1d20+5     Add 5 to total",
            "2d6-1      Subtract 1 from total"
          ]
        }
      ]
    },
    {
      "title": "COMPLEX EXAMPLES",
      "items": [
        "4d6LR{1}!+3    Drop lowest, reroll 1s, exploding, add 3",
        "2d20H+5        Advantage with +5 modifier"
      ]
    },
    {
      "title": "OPTIONS",
      "items": ["-h, --help     Show this help message", "-v, --version  Show version information"]
    }
  ],
  "footer": "For more information, visit: https://github.com/RANDSUM/randsum"
}