Documentation

[Arnox 1]

I seem to be at a loss for making 1.16.x mods in general since there doesn't seem to be a lot of documentation at all. Now, I do understand that Forge for 1.16.x is still early days, but even for 1.15.x, the official documentation seems content to only go over broad concepts with no examples and what seems like key pieces of information left out. Further, many of the tutorials you find for modding only seem to tell you WHAT to do, but not, most importantly, how things are working under the hood for Forge and Minecraft. Would the main Forge contributors be open to discussion about sitting down and expanding the documentation? I am willing to contribute here in this regard.

[DaemonUmbra 557]

The Docs are open source on GitHub like everything else Forge-related.

This conversation has been had many times with many people and it usually boils down to the devs preferring to continue working on Forge itself rather than writing pretty docs.

Given that we're dealing with undocumented, decompiled Minecraft code anyway folks are expected to have at least some ability to understand how code works by reading it.

[Arnox 1]

59 minutes ago, DaemonUmbra said:

The Docs are open source on GitHub like everything else Forge-related.

This conversation has been had many times with many people and it usually boils down to the devs preferring to continue working on Forge itself rather than writing pretty docs.

Given that we're dealing with undocumented, decompiled Minecraft code anyway folks are expected to have at least some ability to understand how code works by reading it.

 

And those "pretty docs" are what attract people to make content for Forge in the first place. I can't write anything to the github pages myself because obviously I'm not sure what to put down. I like to think I know how to write technical documents, but I also need to know what the hell I'm talking about. I (or someone) need to sit down with at least one dev and go through at least some basics with them. Like, for example, what does Forge always expect a mod to have? What file structure does Forge expect? What are some examples of very simple mods, and how would they all work under the hood basically? Although, of course, you should be able to understand what a function does by looking at it, it doesn't answer other more pressing questions about the Forge API as a whole.

 

Hell, if I just had a week with a dev where we just devoted a few hours to hammering out the documentation, then I'm sure we could make a huge dent, if not entirely complete it. I absolutely get that Forge is a big project and it needs a lot of time, but if these documentation needs aren't met, then many people are just gonna get frustrated and go work on something else. And you don't want that. You obviously want more people to use your API.

 

I also get that documentation isn't exactly a glamorous job. It's a very underappreciated part of making an API. But I think it will absolutely pay off in the end. It would address a lot of threads that are constantly getting made in the Modding Support sub-forum asking things that good documentation could easily answer. It saves your users time and it saves you time as well. Everyone's happy.

Edited August 20, 2020 by Arnox

[Aesthetic 0]

https://thebookofmodding.ml/