Jump to content
Search In
  • More options...
Find results that contain...
Find results in...

Very first instructions for new modders are wrong


Recommended Posts

First, I'm a systems architect who's been coding in Java since version 0.8, so I know my way around an IDE.  I'm reading your directions for getting started and the very first instructions seem to be some kind of test to separate serious modders from those who just wanted to "try it out".  

The directions read:
https://mcforge.readthedocs.io/en/latest/gettingstarted/#from-zero-to-modding

--------------------------------------------------
2. Obtain the Mod Development Kit (MDK) from Forge’s files site.

3. Extract the downloaded MDK into an empty directory. You should see a bunch of files along with an example mod placed in src/main/java for you to look at. Only a few of these files are strictly necessary for mod development, and you may reuse these files for all your projects. These files are:
build.gradle
gradlew.bat
gradlew
the gradle folder
--------------------------------------------------
 

So I followed the link "Forge's files site", downloaded "forge-1.18.2-40.1.0-installer.jar", and used the extract option.  It did not work.  I exploded the jar using 7zip, but there doesn't seem to be any kind of project structure in the jar as described in step 3.  The only other 2 options when executing the jar are for installing the forge server or client, and that's not what I want to do.

It seems this bug/feature of the instructions is previously known, mentioned by user 0ryza here:

So, my questions are: where are the correct directions?  How am I supposed to get the mod project skeleton?  If I have to build it by hand, where is an example I can use?  And finally, why haven't the instructions, or the MDK jar, been fixed yet?  

Link to comment
Share on other sites

The link assigned to "Forge’s files site" is this:
https://files.minecraftforge.net/net/minecraftforge/forge/

So the first thing any new modder sees is the big "Download Latest" and "Download Recommended" links.  There's nothing to indicate those aren't the MDK.  So the first thing a new dev is going to do is click on one of those links, execute the downloaded jar, and see the "extract" option.  Now tell me that's not confusing.

Link to comment
Share on other sites

Posted (edited)

When you're writing docu, you can't assume everyone has your practiced eye.  You always have to assume they are coming in clueless.  Your brain, knowing what it does, may immediately jump to "hit the 'Show All Versions' button and there's the MDK link", but someone who hasn't worked on the project for years won't know that. 

So yeah, I found the right link.  You can close this if you want.  I'd suggest you add a bit more verbiage to step 2, however.

Edited by Astrien
Link to comment
Share on other sites

I am sorry, but I disagree with your assessment. "Download Latest" and "Download Recommended" are not links. You cannot click on them. You have to pick one of the three options below, which are "Installer", "MDK" and "Changelog". The instructions clearly tell you to "Obtain the Mod Development Kit (MDK)" (emphasis added). I do not know how to make these instructions more clear.

  • Thanks 1
Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Reply to this topic...

×   Pasted as rich text.   Restore formatting

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

 Share



×
×
  • Create New...

Important Information

By using this site, you agree to our Privacy Policy.