Skip to content

Instantly share code, notes, and snippets.

@LatvianModder
Last active April 19, 2017 14:16
Show Gist options
  • Save LatvianModder/55eb7c6628bc5d19d2931bc4bc809e56 to your computer and use it in GitHub Desktop.
Save LatvianModder/55eb7c6628bc5d19d2931bc4bc809e56 to your computer and use it in GitHub Desktop.
New FTBUtilities Guide System for 1.9

New FTBUtilities Guide System for 1.9

Online guides

Any modder or modpack author can ask me to add their guide to the repo list, when this new feature is done. If a server wants to make a guide, they can do it from server side. All guides will be hosted online, but could also be downloaded and launched from offline-mode too. Modpacks that need a guide to be installed together with modpack (like FTB Infinity Evolved or Skyblock), can add the guide url / ID in config file OR just drop the guide in modpack/guide/ folder.

What are the advantages?

  1. I would not only make guides for my mods for Minecraft ingame, but I would also develop a web-app And possibly an Android app that would allow to view all guides online without even opening Minecraft

  2. You wouldn't need to update the modpack to update the guide

  3. I could make it version-based, so that you can install older versions of guides / mods (for example, different mod guide versions for different minecraft versions)

  4. Since there would be just one file to download + images, the guides would pretty much work the same way Curse modpacks work

  5. I would definetly make an guide editor application, so you dont have to manually write the json file

Example (Super WIP)

https://github.com/LatvianModder/LatvianModder.github.io/tree/master/guides/ftbu

As you can see, info.json acts similar to mcmod.info in mods - display name, author list, latest version, logo, but the difference is, that this also lists all available versions (doesnt have to have more than 1, you can just always change the version number, if you want that). Also, "logo" and version's url can either be absoloute links (that start with http:// or https://) or they can start with /, and it will look into that folder for the files.

guide.json looks preeeety complicated and can get heavy when the guide is as huge as Infinity Evolved guide. It has "resource_path", so you can set any absolute or relative path to where grab resources from (images, maybe even sounds and recipes in future), "resources", which is a map of all resources to download, when you want to save the guide in offline mode (so it knows which files to download, to make the process way faster), "item_map", where you can link items with guide pages (this will be interesting, I promise!), and of course, "guide", which has tree-based structure, so you can add subpages to subpages, etc.

If you want to leave feedback, better do it in this reddit post, because I check it daily: https://redd.it/4iltvw

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment