Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the "missing mods" error screen #2997

Merged
merged 1 commit into from Jun 23, 2016

Conversation

Projects
None yet
@mezz
Copy link
Member

commented Jun 18, 2016

I realize the log has all the information you need, but I see this error screen pasted all over the place with questions about it, so I figure it can use some improvements to help beginners out and cut down on the reports.

Before:
missing-mods-before

After:
edit: this is the final result after some discussion below
missing-mods-after-buttons2

I removed the "Forge Mod Loader blah blah" since it doesn't say anything and people stop reading there.
The message now prominently displays the mod that is missing its dependencies.
It formats the required version strings in a human-readable way (without requiring knowledge of the bracket/braces range notation). It also can display version ranges and maximum versions, which were not previously supported.

import net.minecraftforge.fml.common.MissingModsException;
import net.minecraftforge.fml.common.ModContainer;

This comment has been minimized.

Copy link
@kashike

kashike Jun 18, 2016

Contributor

Unused imports

This comment has been minimized.

Copy link
@mezz

mezz Jun 18, 2016

Author Member

thanks

@mezz mezz force-pushed the mezz:error-messages branch from ad3fac1 to 97799d8 Jun 18, 2016

@simon816

This comment has been minimized.

Copy link
Contributor

commented Jun 18, 2016

I think the use of color would greatly improve the readability of the message. Just highlighting the mod names in a different color will look nicer than plain white text.

@mezz

This comment has been minimized.

Copy link
Member Author

commented Jun 18, 2016

Interesting idea. How does this look?
missing-mods-after23

@GirafiStudios

This comment has been minimized.

Copy link
Contributor

commented Jun 18, 2016

I prefer the straight white text to be honest :)

@simon816

This comment has been minimized.

Copy link
Contributor

commented Jun 18, 2016

Colors need more contrast rather than just shades of gray.

@etaoinshrdlcumwfgypbvkjxqz

This comment has been minimized.

Copy link

commented Jun 18, 2016

I think you should use "or" instead of "and".
Example:
Mod(1.0 and above)
It is like it requires 1.0 and another version that is above 1.0 (1.1, 1.2 ...).

@mezz

This comment has been minimized.

Copy link
Member Author

commented Jun 18, 2016

I don't believe adding bright colors adds to the readability, it just makes the error ugly/scary.

@mezz

This comment has been minimized.

Copy link
Member Author

commented Jun 18, 2016

I think this is a good compromise:

missing-mods-after12s31

Also good suggestion @ChunHin

@mezz mezz force-pushed the mezz:error-messages branch 2 times, most recently from 7167821 to bc7f656 Jun 18, 2016

@darkhax

This comment has been minimized.

Copy link
Contributor

commented Jun 18, 2016

Looks good. This may be a bit outside the scope, but could you make the 'loge/fml-client-latest.log' bit clickable, and have it open the latest log in default editor?

@Actuarius Actuarius added the Cleanup label Jun 19, 2016

@Actuarius

This comment has been minimized.

Copy link

commented Jun 19, 2016

@mezz added labels [Cleanup]

@LexManos

This comment has been minimized.

Copy link
Member

commented Jun 19, 2016

but could you make the 'loge/fml-client-latest.log' bit clickable, and have it open the latest log in default editor?

That would be useful.

@mezz mezz force-pushed the mezz:error-messages branch from bc7f656 to 0ecb5ee Jun 19, 2016

@mezz

This comment has been minimized.

Copy link
Member Author

commented Jun 19, 2016

Alright,
missing-mods-after-buttons

Also added these strings to the localization file, make sure to add those.

@KnightMiner

This comment has been minimized.

Copy link
Contributor

commented Jun 19, 2016

This is minor, but maybe underline the filename so it stands out a bit more? Makes it more obvious it's a filename

Edit: just noticed the big buttons at the bottom, but an underline might still look nice there

@mezz

This comment has been minimized.

Copy link
Member Author

commented Jun 19, 2016

Only the buttons are clickable.

@mezz mezz force-pushed the mezz:error-messages branch 3 times, most recently from 451b30f to 4122d3e Jun 20, 2016

@mezz mezz force-pushed the mezz:error-messages branch from 4122d3e to 590a3b0 Jun 20, 2016

@Prospector

This comment has been minimized.

Copy link

commented Jun 21, 2016

What happens if there's a load of dependencies for whatever reason? Also what if multiple mod's dependencies are missing. For example EnderStorage is missing CodeChickenCore as well. Will it display that as well?

@mezz

This comment has been minimized.

Copy link
Member Author

commented Jun 21, 2016

Forge aborts as soon as it runs into a mod that's missing dependencies, so it will only show one at a time. Detecting every missing mod is not really possible, fix one issue may require shifting mods versions around, breaking more things... better to keep it simple and stable here.

@cpw cpw merged commit 86d5b5a into MinecraftForge:master Jun 23, 2016

1 check passed

licence/cla Contributor License Agreement is signed.
Details

@mezz mezz referenced this pull request Sep 30, 2017

Closed

Added CrashEvent #4432

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.