You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I understand that if I ignore these instructions, my issue may be closed without review.
I have made sure that there are no similar opened issues.
I have made sure that the mod version matches the latest release.
Is your feature request related to a problem? Please describe.
Right now, all modinfo configurations are kinda inconsistent with each other, making them really hard to follow. This decreases the speed of the information consumption.
One of the options uses the "Sentence case" while others use the "Title Case". The descriptions are inconsistent as well, as it's really hard to tell which configuration option type is used just by looking at them. For example, I can't tell whether it's a bool or a custom option by just reading the description.
Moreover, since we are a single organization, we should follow a single format between all our mods. For example, I suggest applying the following (based on the general UX design rules):
Sort configurations alphabetically within each section:
it's easier to find any specific configuration;
no need to think about the order when adding new configuration;
Use "Sentence case" for labels:
easier to focus eyes on the first letter only when searching any specific configuration (especially when sorted alphabetically);
looks cleaner with the in-game font (for example, lowercase letters are usually shorter);
Start the description with the same word(s) to match the configuration type:
easier to guess what it does. For example:
bool options start with: When enabled...
custom options start with: Which...
keybind options start with: Key used for...
users get used to specific patterns, which increases the speed of information consumption;
For example, you may look at our dstmodders/mod-dev-tools where I've already applied a few mentioned proposals.
Describe the solution you'd like
We should discuss how to introduce modinfo consistency between all our mods and apply the same pattern and rules everywhere.
Describe alternatives you've considered
If applicable, add a clear and concise description of any alternative solutions or features you've considered.
Additional context
If applicable, add any other context or screenshots about the feature request here.
The text was updated successfully, but these errors were encountered:
Verify
Is your feature request related to a problem? Please describe.
Right now, all
modinfo
configurations are kinda inconsistent with each other, making them really hard to follow. This decreases the speed of the information consumption.One of the options uses the "Sentence case" while others use the "Title Case". The descriptions are inconsistent as well, as it's really hard to tell which configuration option type is used just by looking at them. For example, I can't tell whether it's a bool or a custom option by just reading the description.
Moreover, since we are a single organization, we should follow a single format between all our mods. For example, I suggest applying the following (based on the general UX design rules):
Sort configurations alphabetically within each section:
Use "Sentence case" for labels:
Start the description with the same word(s) to match the configuration type:
easier to guess what it does. For example:
users get used to specific patterns, which increases the speed of information consumption;
For example, you may look at our dstmodders/mod-dev-tools where I've already applied a few mentioned proposals.
Describe the solution you'd like
We should discuss how to introduce
modinfo
consistency between all our mods and apply the same pattern and rules everywhere.Describe alternatives you've considered
If applicable, add a clear and concise description of any alternative solutions or features you've considered.
Additional context
If applicable, add any other context or screenshots about the feature request here.
The text was updated successfully, but these errors were encountered: