search

neoforged / NeoForge

Neo Modding API for Minecraft, based on Forge
https://neoforged.net
Other
1.24k stars 179 forks source link

[1.21.3] Show a range's default value in config file #1652

Closed TelepathicGrunt closed 2 weeks ago

TelepathicGrunt commented 3 weeks ago

Closes https://github.com/neoforged/NeoForge/issues/1643

neoforged-pr-publishing[bot] commented 3 weeks ago

Last commit published: 157f2449845aaa72b786be9e45525ba46a499738.

PR Publishing ### The artifacts published by this PR: - :package: [`net.neoforged:neoforge:21.3.12-beta-pr-1652-DefaultRangeValueInConfigFile2`](https://github.com/neoforged/NeoForge/packages/2300782) - :package: [`net.neoforged:testframework:21.3.12-beta-pr-1652-DefaultRangeValueInConfigFile2`](https://github.com/neoforged/NeoForge/packages/2300785) ### Repository Declaration In order to use the artifacts published by the PR, add the following repository to your buildscript: ```gradle repositories { maven { name 'Maven for PR #1652' // https://github.com/neoforged/NeoForge/pull/1652 url 'https://prmaven.neoforged.net/NeoForge/pr1652' content { includeModule('net.neoforged', 'neoforge') includeModule('net.neoforged', 'testframework') } } } ``` ### MDK installation In order to setup a MDK using the latest PR version, run the following commands in a terminal. The script works on both *nix and Windows as long as you have the JDK `bin` folder on the path. The script will clone the MDK in a folder named `NeoForge-pr1652`. On Powershell you will need to remove the `-L` flag from the `curl` invocation. ```sh mkdir NeoForge-pr1652 cd NeoForge-pr1652 curl -L https://prmaven.neoforged.net/NeoForge/pr1652/net/neoforged/neoforge/21.3.12-beta-pr-1652-DefaultRangeValueInConfigFile2/mdk-pr1652.zip -o mdk.zip jar xf mdk.zip rm mdk.zip || del mdk.zip ``` To test a production environment, you can download the installer from [here](https://prmaven.neoforged.net/NeoForge/pr1652/net.neoforged/neoforge/21.3.12-beta-pr-1652-DefaultRangeValueInConfigFile2/neoforge-21.3.12-beta-pr-1652-DefaultRangeValueInConfigFile2-installer.jar).
Technici4n commented 3 weeks ago

Can you show an example of what this looks like? We could also put it on the same line as something else. For example:

# Configure how much power the machine needs. (Default: 3)
# Range: 1-5.
TelepathicGrunt commented 3 weeks ago

Was taking me a while to launch game with example. image

That is what is looks like. I would encourage not putting it on the same line as the modder created config. That will be gross.

Either same line as range somehow or below range

Technici4n commented 3 weeks ago

How about default first and then range? It doesn't really matter I know 😅

TelepathicGrunt commented 3 weeks ago

visual aid image

Technici4n commented 3 weeks ago

We can merge tomorrow to give more time for feedback.

Shadows-of-Fire commented 2 weeks ago

Thoughts on making it # Default (With a space) and applying the same change to # Range as well? That seems to be more consistent with the placement of the user-provided comment.

neoforged-releases[bot] commented 2 weeks ago

🚀 This PR has been released as NeoForge version 21.3.11-beta.