CraftTweaker-Documentation icon indicating copy to clipboard operation
CraftTweaker-Documentation copied to clipboard

Suggestions: CrT 1.14 wiki

Open kindlich opened this issue 6 years ago • 3 comments
trafficstars

For CrT 1.14, the wiki currently is a blank slate. In the past some people had issues finding the wiki pages they needed, so this is an oppurtunity to re-structure where wiki files are put to make it easier to find everything.

Just comment if you have a valid suggestion.

kindlich avatar Oct 28 '19 22:10 kindlich

Here are my hot takes:

  • If Modtweaker is still gonna be a thing, dump all of the mods under the ModTweaker subcategory alongside the rest of the mods. At the top of each mod's page, in bold text note which mod is providing the ZS integration.
    • As a user, I care less about "What can ModTweaker do" and more about "Am I able to tweak Botania using zenscript, if I have to install an addon to do it, whatever". Having a separate modtweaker category means I just need to check 2 lists of mods instead of 1.
  • Why is "Mods" under "Vanilla" 🤔🤔🤔
  • Why is "Seed Drops" under "Recipes"
  • Rename "Advanced Functions" to just "ZenScript", or something like "Language Constructs"
    • It just holds basic language features like data structures, loops... These turn up all the time
    • Stuff like if/else, looping and iteration, and importing symbols is very important and I don't think you should classify them as "advanced".
    • Throw "global functions" under there too while you're at it.
  • Getting Started with Scripts tells you how to get started making scripts but it doesn't cover how to do anything useful with them. I think you should throw in a simple recipe-adding example (with a link to a page with more details) just to get people excited and get them familiar with the syntax of adding recipes.

There are a few "tutorial" pages that cover actually pretty important things that should probably be reiterated on their own page. "Getting Started with Scripts" covers the script loading and discovery process. If I have been using Crafttweaker for a while and wanted to check again for more details of how scripts are loaded, I would not expect the "Getting started" page to cover that in the most detail.

Overall I think the wiki should have more consistent formatting when it comes to, e.g., listing what zenmethods a particular type or symbol has. Sometimes they are presented as a table, sometimes as a page with one heading or section per method, sometimes as a page with one heading or section per task (Seed Drops), and sometimes they're... not described at all (IFormatter).

quat1024 avatar Oct 29 '19 18:10 quat1024

Oh, also: It might be nice to divide Vanilla and other mod-support pages into one subcategory for Recipes and another subcategory for Behavior or Gameplay. Especially in the Vanilla category, there is just so much stuff that it's hard to see at a glance what kinds of recipes CraftTweaker can do.

quat1024 avatar Oct 29 '19 18:10 quat1024

Can you elaborate on:

Why is "Mods" under "Vanilla" 🤔🤔🤔

jaredlll08 avatar Oct 29 '19 19:10 jaredlll08