Increase requirements for Workshop publishing #3643
Comments
Mirsario
added
Needs Discussion
github-actions
bot
removed
the
Requestor-TML Maintainers
|
Hello, first: I am not sure if I am allowed to write this here. I used the DragonLens mod together with my own mod (not published) where I made a prefix that tries to boost max minion count to test said prefix. When DragonLens tried to load the icon_small which I didn't have, it errored out. Took me some days to find this issue until I stumbled upon this thread. When not having an icon_small.png in your own mod, it can be that mods that contain searches for icon_small.png error out and one does not know quite why, because no icon_small was generated as starter file for your mod. I suggest maybe when creating a new mod skeleton TML also creates an empty 32x32 icon_small.png. By creating an empty 32x32 icon_small.png as a placeholder I solved the error. |
|
icon_small has never been required, that's just a bug with that mod. We can consider making it required, but it currently isn't. |
Mirsario
added
the
Requestor-TML Maintainers
|
I feel like, when playing, many mods in the workshop are low quality, and make it hard to find ones where the creator has put some effort into making it. This is a great idea, that I’ve wanted for quite some time when playing. I will leave it up for discussion but I will draft a way to make it work if others feel it should be necessary. I would add that with the assembly checking, that would break some mods that purely act as localisation for other mods and feel that this is not the way forward |
…escription before publishing to workshop. See tModLoader#3643
…escription before publishing to workshop. See tModLoader#3643
Mirsario
added
Contributions Welcome/Easy
|
The issue's labels were outdated for a long time, it has been discussed well enough in Discord, and no one has really raised outstanding objections to the proposed requirements. |
|
Ok, I’ve implemented the description checker on my own fork, and the checking for the workshop icon wouldn’t be too hard. However, I have no idea on how to implement assembly checking or the image comparison. |
|
Done, apart from assembly checking |
* Checks description for less than 20 characters or being the default description before publishing to workshop. See #3843 * Checks description for less than 20 characters or being the default description before publishing to workshop. See #3643 * Checks description for less than 20 characters or being the default description before publishing to workshop. See #3643 * Added icon.png and icon_workshop.png checks before publishing See #3643 * Streamlined the implementation. * Count only letters & digits towards description length. * Account for description.txt missing. * More legible report texts. * Auto-upscale previews and create icon_workshop.png. * Append ticks to temp file location. * Create icon_workshop.png if not resizing too. * Upscale to 480x480 instead of 512x512. * Create icon_workshop only 'if missing and not resized'. * (Vanilla bug) Fixed icon file handles lingering. * Adjust resize message color, generate localization --------- Co-authored-by: Mirsario <me@mirsar.io> Co-authored-by: JavidPack <javidpack@gmail.com>
Since the Mod Browser has been moved to Steam Workshop, it has been nearly flooded with various low effort submissions, and even high effort ones tend to look lame due to only 80px icons being suggested.
This issue lists suggestions that could help mitigate these problem.
Requirements
The mod initializes correctly.
This is already handled by the fact that the
Publishbutton only shows up for mods that are loaded.Might be worth keeping this in mind for various "Github CI" ordeals of the future.
description.txt
Require a non-default ("X is a pretty cool mod") description.txt with length of at least ~20 characters.
If the required character count is increased further - it should be noted that we'll probably need to count different languages' characters differently, as some languages (Chinese, Japanese, perhaps Korean) are known to be far more "compact".
Assembly-checking
Require the published mods to contain anything that differs them from what building "Create mod" outputs would produce.
This may be a topic of its own, but it's helpful that the mod assemblies must be loaded and running before publishing.
icon.png
Disallow using the empty frame icon added to new mods by default.
icon_workshop.png
Require a special workshop icon with the minimal size of
480x480px.512pxis prefered, but480is what you get if you want40/80pxto scale up well.Alternatively, should we just upscale
icon.pngto 480x480?Not to be required
icon_small.png
A few mods would benefit from other mods always having a small icon to be used in GUIs, but they could just use a fallback texture if they don't.
description_workshop.txt
Not a serious necessity if we make mod info open workshop pages, thus making
description.txtalready mostly be used for bb-code.The text was updated successfully, but these errors were encountered: