search

QuiltMC / developer-wiki

The source code for the Quilt Developer Wiki
https://wiki.quiltmc.org
41 stars 31 forks source link

"Setting up a Development Environment" Guide doesn't mention non automatic gradle project import #71

Open Felan7 opened 8 months ago

Felan7 commented 8 months ago

Operating System

Windows

Web Browser

Chrome

Issue description

The Setup Guide doesn't mention the fact that when you are not using IntelliJ IDEA (which in fairness is the recommended IDE), the gradle project is not automatically imported. This has to be done via running the gradlew terminal command.

I understand that the getting started guide is not, and should not be a gradle tutorial, but I feel a couple lines pointing this out won't hurt. I found this solution in the setup guide for NeoForged by the way.

Another minor issue unrelated to the first is a possible typo in the code snippet for gradle.properties in the same guide. Feels to me like the last line (archives_base_name = bingus-mod) should be "bingus_mod"? Not entirely sure though.

ix0rai commented 8 months ago

the reason it's hyphenated is because archives_base_name is a property uniquely used for maven -- maven uses hyphens, as you can see from browsing the names in our repository

ix0rai commented 8 months ago

I've fixed the maven issue, but I think that the setup should have separate sections for different IDEs -- Eclipse, Intellij, Vscode, and "Other"