Skip to main content

Documenting Builds & Areas

Basics:

  • Documentation should be primarily done as lists but feel free to break format!
  • Builds are player creations, Areas are clusters of builds; they're represented by "Shelves"
  • Builds
    • Book: organized by era of build which normally correlates to where spawn is
    • Pages:
      • World x, y, z; ex: "100, 200, 150"
      • The area it is in; ex: "In 2010-2011 - Alpha Prospect"
      • Who built it (could be many people); ex: "By folkhack"
      • Transportation network info; ex: "Rail line to 2010-2011 Alpha Spawn"
      • ...then the history!
  • Areas
    • Has a "Builds" book that is list of builds
    • Has optional "History" book for lore that doesn't fit with builds (group builds, stories, etc)

Linking to "Entities"

The wiki software we use calls pages that you can link to "entities" - ie: books or pages.

  • Place your cursor where you want to add the link or select text that you would like to turn into a link
  • Click the chain icon in the editor toolbar
  • Click the up-arrow to the right of the URL field and search for the book or page you would like to link
  • When selected it will fill in all of the fields for you (URL, etc)

Uploading Images:

  • Use F1 to hide your UI if you're taking a screenshot!
  • Use a reasonable landscape resolution - the upload limit is 10Mb but we'd like to cap images at 1-4Mb if possible
  • Feel free to use shaders!
  • Get creative =)
  • Tips:
    • Use freecam for good angles
    • Use zoom to modify your FOV as you would with a camera lens: Tweakeroo zoom, Optifine zoom etc.
    • Try unique shots; here's some ideas:
      • Fully top-down
      • Showing how a build blends into it's environment
      • Composition, rule of 2/3rds, unique placement of subject
Back to top