1. These forums are being retired. Please ask all questions and help threads and any other type of discussions on GitHub. During this time, new threads and user registrations have been disabled.

1.22 (obsolete) Documentation

Creates documentation about various parts of Terraria

  1. Wight
    API Version:
    TShock Version:
    Source URL:
    Documentation is a plugin that acts as a tool for creating CSV or JSON formatted files with information about particular parts of Terraria.
    It is currently able to create documentation about:
    • NPCs
    • Items
    • Walls
    • Tiles
    • Commands
    • Projectiles

    • docgen [type] [format] - generates documentation for the specified type in the specified format.
    Valid types:
    • mobs - documents information about each NPC
    • items - documents information about each item
    • tiles - documents information about each tile
    • walls - documents information about each wall
    • commands - documents information about each command
    • projectiles - documents information about each projectile
    • all - does all of the above
    Valid formats:
    • JSON
    • CSV
    • JSON -simple (Removes many pieces of (often useless) information)

    The created files can be found in your /tshock/DocGen folder

    A huge thank you to @Ijwu who probably worked harder on this than I did and who added CSV formatting and extended everything to allow it to do all the cool stuff it does. You're awesome.

Recent Updates

  1. 1.22 API
  2. 1.21 API tick
  3. 1.20 API tick