docs: clarify logoFile filename restrictions #174
Conversation
| | `version` | string | `"1"` | The version of the mod, preferably in a [variation of Maven versioning][versioning]. When set to `${file.jarVersion}`, it will be replaced with the value of the `Implementation-Version` property in the JAR's manifest (displays as `0.0NONE` in a development environment). | `version="1.20.2-1.0.0"` | | ||
| | `displayName` | string | value of `modId` | The display name of the mod. Used when representing the mod on a screen (e.g., mod list, mod mismatch). | `displayName="Example Mod"` | | ||
| | `description` | string | `'''MISSING DESCRIPTION'''` | The description of the mod shown in the mod list screen. It is recommended to use a [multiline literal string][multiline]. This value is also translatable, see [Translating Mod Metadata][i18n] for more info. | `description='''This is an example.'''` | | ||
| | `logoFile` | string | _nothing_ | The name and extension of an image file used on the mods list screen. The logo must be in the root of the JAR or directly in the root of the source set (e.g. `src/main/resources` for the main source set). Valid filename characters are lowercase letters (`a-z`), digits (`0-9`), underscores (`_`), periods (`.`) and hyphens (`-`). The complete character set is `[a-z0-9_-.]`. | `logoFile="example_logo.png"` | |
There was a problem hiding this comment.
If we want to be more accurate, it would be good to specify that the image can be in a subdirectory of the root of the JAR or source set, as long as the path is absolute.
For example test/example_logo.png would be a valid asset location if at src/main/resources/test/example_logo.png. However using ./test/example_logo.png or ../test/example_logo.png would not. This can be added for the other versions as well as this change occurred in 1.20.2.
There was a problem hiding this comment.
How can I do that retroactively for other Versions as well?
There was a problem hiding this comment.
All versions are within the same branch, just in the versioned_docs, so you can do an across project search in your editor of choice for the word logoFile. That'll probably be the easiest.
Merges neoforged#174 changes
|
@mainrs, this pull request has conflicts, please resolve them for this PR to move forward. |
neoforged-automation
bot
added
the
needs rebase
|
Added by #178 |
Closes #157.