Jump to content
Search the Forums BEFORE making a new post.
Currently supported: All versions

Help setting up Forge dev for MC 1.14.3

zv_odd

By zv_odd
in Modder Support

 Share

Recommended Posts

zv_odd Tree Puncher

zv_odd

Posted
Posted (edited)

So I am having a couple of problems whilst trying to get started with Forge. I Downloaded and extracted a nightly MDK forge build and tried following instructions from docs.

 

  1.  `gradlew setupDecompWorkspace`does not appear to be a valid gradlew task.
  2. Having some issue with running gradle tasks from IntelliJ - wrong Java Version (I think i must have set import settings wrong) - I did manage to get it working on a previous try (reimport fixed this)
  3. I have no idea how to generate the API Java Docs so I can find my way around MC / MCForge and actually write code. Yes I tried gradle task Javadoc, but that just  generate docs for the example Mod

 

 

1) Console printscreen -  trying to run gradlew on a freshly unziped Forge mdk folder copy `forge-1.14.3-27.0.60-mdk.zip`: 

D:\Code\Gamedev\MCMOD\forge_mdk60_Simple
λ set J
JAVA_HOME=C:\Program Files\Java\jdk1.8.0_211

D:\Code\Gamedev\MCMOD\forge_mdk60_Simple
λ gradlew setupDecompWorkspace
To honour the JVM settings for this build a new JVM will be forked. Please consider using the daemon: https://docs.gradle.org/4.9/userguide/gradle_daemon.html.
Daemon will be stopped at the end of the build stopping after processing

> Configure project :
New Dep: net.minecraftforge:forge:1.14.3-27.0.60_mapped_snapshot_20190719-1.14.3

FAILURE: Build failed with an exception.

* What went wrong:
Task 'setupDecompWorkspace' not found in root project 'forge_mdk60_Simple'.

* Try:
Run gradlew tasks to get a list of available tasks. Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

Deprecated Gradle features were used in this build, making it incompatible with Gradle 5.0.
Use '--warning-mode all' to show the individual deprecation warnings.
See https://docs.gradle.org/4.9/userguide/command_line_interface.html#sec:command_line_warnings

BUILD FAILED in 5s

D:\Code\Gamedev\MCMOD\forge_mdk60_Simple
λ gradlew genIntellijRuns
To honour the JVM settings for this build a new JVM will be forked. Please consider using the daemon: https://docs.gradle.org/4.9/userguide/gradle_daemon.html.
Daemon will be stopped at the end of the build stopping after processing

> Configure project :
New Dep: net.minecraftforge:forge:1.14.3-27.0.60_mapped_snapshot_20190719-1.14.3

Deprecated Gradle features were used in this build, making it incompatible with Gradle 5.0.
Use '--warning-mode all' to show the individual deprecation warnings.
See https://docs.gradle.org/4.9/userguide/command_line_interface.html#sec:command_line_warnings

BUILD SUCCESSFUL in 7s
4 actionable tasks: 4 executed
D:\Code\Gamedev\MCMOD\forge_mdk60_Simple
λ

 

2) See attached screen shot of IntelliJ - I had this issue before and then change IntellJ and my environment vars use Java 8 JDK, so I'm stupped as to why this is happening again. i.imgur.com/7N9OCFk.png

 

3) I am guessing `gradlew javadoc` would generate the docs if  `gradlew setupDecompWorkspace` existed/succeeded.

 

Any help would be much appreciated.

Edited by zv_odd
zv_odd Tree Puncher

zv_odd

Posted
  • Author
Posted

Ok I get that `setupDecompWorkspace ` is depreciated and removed. I have a working setup in IntelliJ - happy launches MC with forge + example mod loaded.

But I still have no idea how to generate MC / MCForge Java docs! Running the javadoc gradle task just creates docs for ExampleMod.

 

Can any one please point me to a tutorial on how to generate  API Docs for forge MC?

I'm really not great with the Java environment, but i do write a lot of code in other languages, and it seems flipping crazy that the topic of "how to get A readable API reference" is not the #1 first step after "setup your build environment".
 

DaemonUmbra Reality Controller

DaemonUmbra

Posted
Posted

You could run gradlew javadoc I suppose, but Forge being a framework rather than an API and Minecraft not being designed to be modded you're almost always going to find yourself using your IDE to browse through Minecraft and Forge to see how things are used and what they do.

This is my Forum Signature, I am currently attempting to transform it into a small guide for fixing easier issues using spoiler blocks to keep things tidy.

 

As the most common issue I feel I should put this outside the main bulk:

The only official source for Forge is https://files.minecraftforge.net, and the only site I trust for getting mods is CurseForge.

If you use any site other than these, please take a look at the StopModReposts project and install their browser extension, I would also advise running a virus scan.

 

For players asking for assistance with Forge please expand the spoiler below and read the appropriate section(s) in its/their entirety.

Spoiler

Logs (Most issues require logs to diagnose):

Spoiler

Please post logs using one of the following sites (Thank you Lumber Wizard for the list):

https://gist.github.com/: 100MB Requires member (Free)

https://pastebin.com/: 512KB as guest, 10MB as Pro ($$$)

https://hastebin.com/: 400KB

Do NOT use sites like Mediafire, Dropbox, OneDrive, Google Drive, or a site that has a countdown before offering downloads.

 

What to provide:

...for Crashes and Runtime issues:

Minecraft 1.14.4 and newer:

Post debug.log

Older versions:

Please update...

 

...for Installer Issues:

Post your installer log, found in the same place you ran the installer

This log will be called either installer.log or named the same as the installer but with .log on the end

Note for Windows users:

Windows hides file extensions by default so the installer may appear without the .jar extension then when the .log is added the log will appear with the .jar extension

 

Where to get it:

Mojang Launcher: When using the Mojang launcher debug.log is found in .minecraft\logs.

 

Curse/Overwolf: If you are using the Curse Launcher, their configurations break Forge's log settings, fortunately there is an easier workaround than I originally thought, this works even with Curse's installation of the Minecraft launcher as long as it is not launched THROUGH Twitch:

Spoiler
  1. Make sure you have the correct version of Forge installed (some packs are heavily dependent on one specific build of Forge)
  2. Make a launcher profile targeting this version of Forge.
  3. Set the launcher profile's GameDir property to the pack's instance folder (not the instances folder, the folder that has the pack's name on it).
  4. Now launch the pack through that profile and follow the "Mojang Launcher" instructions above.

Video:

Spoiler

 

 

 

or alternately, 

 

Fallback ("No logs are generated"):

If you don't see logs generated in the usual place, provide the launcher_log.txt from .minecraft

 

Server Not Starting:

Spoiler

If your server does not start or a command window appears and immediately goes away, run the jar manually and provide the output.

 

Reporting Illegal/Inappropriate Adfocus Ads:

Spoiler

Get a screenshot of the URL bar or copy/paste the whole URL into a thread on the General Discussion board with a description of the Ad.

Lex will need the Ad ID contained in that URL to report it to Adfocus' support team.

 

Posting your mod as a GitHub Repo:

Spoiler

When you have an issue with your mod the most helpful thing you can do when asking for help is to provide your code to those helping you. The most convenient way to do this is via GitHub or another source control hub.

When setting up a GitHub Repo it might seem easy to just upload everything, however this method has the potential for mistakes that could lead to trouble later on, it is recommended to use a Git client or to get comfortable with the Git command line. The following instructions will use the Git Command Line and as such they assume you already have it installed and that you have created a repository.

 

  1. Open a command prompt (CMD, Powershell, Terminal, etc).
  2. Navigate to the folder you extracted Forge’s MDK to (the one that had all the licenses in).
  3. Run the following commands:
    1. git init
    2. git remote add origin [Your Repository's URL]
      • In the case of GitHub it should look like: https://GitHub.com/[Your Username]/[Repo Name].git
    3. git fetch
    4. git checkout --track origin/master
    5. git stage *
    6. git commit -m "[Your commit message]"
    7. git push
  4. Navigate to GitHub and you should now see most of the files.
    • note that it is intentional that some are not synced with GitHub and this is done with the (hidden) .gitignore file that Forge’s MDK has provided (hence the strictness on which folder git init is run from)
  5. Now you can share your GitHub link with those who you are asking for help.

[Workaround line, please ignore]

 

  • 2 weeks later...
zv_odd Tree Puncher

zv_odd

Posted
  • Author
Posted (edited)

I absolutely tried running ` gradlew javadoc`, but as I said it only generated the docs for things declared in the ExampleMod package.

Do you know, are there some arguments that I can pass to it to change the scope of document generation?

As I'm really not that comfortable with the 2 main Java IDEs  (I mostly use Sublime or VIM), I was really hoping I could generate some searchable reference of all the main "packages"( modules,?) names and there classes, methods and their signatures, so I could easily search and browse for useful stuff whilst experimenting.

I'm not sure I really understand what you mean documentation can't be generated for a framework, it still has a collection of commented classes, methods, interfaces, etc.  Seems like going through that with an AST and grabbing comments + signatures is a large part of what Java Doc does? IDK seems strange that the layout of a codebase into a framework  ( i.e. rather than a complete main loop style application) should make much difference to that process.

 

I guess I just assumed that there would be some of the same tooling that IDE's like eclipse use to generate auto completion & etc, would have some standard way for generating a html version of those "mappings".

I have spent some time reading the forge code base on github - yeah that's an OK option, but there isn't a similar option for the decompiled Minecraft classes (obviously without comments) - which I also would also need to reference fairly regularly.

 


Also, partially this desire was promoted by this weird problem I'm having where some of the classes from ForgeMC (forge-1.14.3-27.0.57-mdk - could be a version specific issue?) didn't seem to exist,  specifically when I tried:  

import net.minecraftforge.common.config.Config;


I got a compiler error saying it couldn't find that class/package.

I was hoping to verify the package was actually there  via the generated docs.

Edited by zv_odd
clarify understanding
zv_odd Tree Puncher

zv_odd

Posted
  • Author
Posted

I totally understand what your saying, I just find it hard to believe there isn't a way ( that is already tooled and used by  mc modders) to generate/export list of class names + function sigs.

 

Quote

In my opinion it is not feasible to create Minecraft mods without always cross-referencing the vanilla and Forge code.


^ 100% agree!
 

Quote

You need an IDE for that.

5% agree -  It also makes plenty of sense for the collection of class names and signatures to be aggregated by some docgen tooling. Isn't that kinda one of the core purposes of JavaDoc?

Does anyone know how to generate that from the decompiled MC source and ForgeMC? 

Animefan8888 Reality Controller

Animefan8888

Posted
Posted
3 hours ago, zv_odd said:

I totally understand what your saying, I just find it hard to believe there isn't a way ( that is already tooled and used by  mc modders) to generate/export list of class names + function sigs.

We all use an IDE. Which allows use to look through the source code. If I'm not mistaken a lot of the Minecraft source for 1.14 is still being made readable you know after obfuscation.

VANILLA MINECRAFT CLASSES ARE THE BEST RESOURCES WHEN MODDING

I will be posting 1.15.2 modding tutorials on this channel. If you want to be notified of it do the normal YouTube stuff like subscribing, ect.

Forge and vanilla BlockState generator.

DaemonUmbra Reality Controller

DaemonUmbra

Posted
Posted

Exactly why do you need a dump of the class names and method sigs?

This is my Forum Signature, I am currently attempting to transform it into a small guide for fixing easier issues using spoiler blocks to keep things tidy.

 

As the most common issue I feel I should put this outside the main bulk:

The only official source for Forge is https://files.minecraftforge.net, and the only site I trust for getting mods is CurseForge.

If you use any site other than these, please take a look at the StopModReposts project and install their browser extension, I would also advise running a virus scan.

 

For players asking for assistance with Forge please expand the spoiler below and read the appropriate section(s) in its/their entirety.

Spoiler

Logs (Most issues require logs to diagnose):

Spoiler

Please post logs using one of the following sites (Thank you Lumber Wizard for the list):

https://gist.github.com/: 100MB Requires member (Free)

https://pastebin.com/: 512KB as guest, 10MB as Pro ($$$)

https://hastebin.com/: 400KB

Do NOT use sites like Mediafire, Dropbox, OneDrive, Google Drive, or a site that has a countdown before offering downloads.

 

What to provide:

...for Crashes and Runtime issues:

Minecraft 1.14.4 and newer:

Post debug.log

Older versions:

Please update...

 

...for Installer Issues:

Post your installer log, found in the same place you ran the installer

This log will be called either installer.log or named the same as the installer but with .log on the end

Note for Windows users:

Windows hides file extensions by default so the installer may appear without the .jar extension then when the .log is added the log will appear with the .jar extension

 

Where to get it:

Mojang Launcher: When using the Mojang launcher debug.log is found in .minecraft\logs.

 

Curse/Overwolf: If you are using the Curse Launcher, their configurations break Forge's log settings, fortunately there is an easier workaround than I originally thought, this works even with Curse's installation of the Minecraft launcher as long as it is not launched THROUGH Twitch:

Spoiler
  1. Make sure you have the correct version of Forge installed (some packs are heavily dependent on one specific build of Forge)
  2. Make a launcher profile targeting this version of Forge.
  3. Set the launcher profile's GameDir property to the pack's instance folder (not the instances folder, the folder that has the pack's name on it).
  4. Now launch the pack through that profile and follow the "Mojang Launcher" instructions above.

Video:

Spoiler

 

 

 

or alternately, 

 

Fallback ("No logs are generated"):

If you don't see logs generated in the usual place, provide the launcher_log.txt from .minecraft

 

Server Not Starting:

Spoiler

If your server does not start or a command window appears and immediately goes away, run the jar manually and provide the output.

 

Reporting Illegal/Inappropriate Adfocus Ads:

Spoiler

Get a screenshot of the URL bar or copy/paste the whole URL into a thread on the General Discussion board with a description of the Ad.

Lex will need the Ad ID contained in that URL to report it to Adfocus' support team.

 

Posting your mod as a GitHub Repo:

Spoiler

When you have an issue with your mod the most helpful thing you can do when asking for help is to provide your code to those helping you. The most convenient way to do this is via GitHub or another source control hub.

When setting up a GitHub Repo it might seem easy to just upload everything, however this method has the potential for mistakes that could lead to trouble later on, it is recommended to use a Git client or to get comfortable with the Git command line. The following instructions will use the Git Command Line and as such they assume you already have it installed and that you have created a repository.

 

  1. Open a command prompt (CMD, Powershell, Terminal, etc).
  2. Navigate to the folder you extracted Forge’s MDK to (the one that had all the licenses in).
  3. Run the following commands:
    1. git init
    2. git remote add origin [Your Repository's URL]
      • In the case of GitHub it should look like: https://GitHub.com/[Your Username]/[Repo Name].git
    3. git fetch
    4. git checkout --track origin/master
    5. git stage *
    6. git commit -m "[Your commit message]"
    7. git push
  4. Navigate to GitHub and you should now see most of the files.
    • note that it is intentional that some are not synced with GitHub and this is done with the (hidden) .gitignore file that Forge’s MDK has provided (hence the strictness on which folder git init is run from)
  5. Now you can share your GitHub link with those who you are asking for help.

[Workaround line, please ignore]

 

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
Unfortunately, your content contains terms that we do not allow. Please edit your content to remove the highlighted words below.
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
Go to topic listing

Announcements



×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use.

  I accept