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

Feat/equipment descriptions #5992

Closed

Conversation

mwerle
Copy link
Contributor

@mwerle mwerle commented Dec 6, 2024

Anybody can contribute to this PR; feel free to add commits

Even though this PR is a draft, as long as people have no objections with the proposed text, it could be merged at any time. Specifically the first commit (add missing translations) is more a bug fix than a feature.

This aims to fix #5951


Feature creep:

I've started adding additional missile racks to this PR.. this work -probably- belongs in a new PR but a very quick attempt to cherry-pick the commits into a new PR turned out to be a pain due to the interleaved descriptions. Yes, I can pick it apart, but would there be a huge issue with turning this PR simply into a "missiles and missile racks" PR instead?


Some equipment has additional functionality or slots which are not immediately obvious to the player, so it is important to provide an in-game description to allow them to choose the correct equipment as buying and selling loses money (there should probably be a "return" option where a purchased piece of equipment can be sold back at the same price as long as the player has not undocked in the meantime - this could be considered as "browsing").

Then there's also the question of simply adding more flavour to the game by adding some, potentially humorous, descriptions to equipment which might include extravagant advertising from the manufacturer.

Added some missing translations strings for left and right hard points.
Add some in-game descriptions for missile racks and pylons to give the
player and indication of how many and what size missile each equipment
item can hold.

Also add some proposed flavour-text for the missiles.
data/lang/equipment-core/en.json Show resolved Hide resolved
"MISSILE_RACK_322": {
"description": "Name for a multiple-missile external missile rack. 'Hydri' is a brand name.",
"message": "LH-230 Hydri Missile Rack"
},
"MISSILE_RACK_322_DESCRIPTION": {
"description": "Equipment description",
"message": "External missile rack able to carry up to 2 medium-sized missiles. Bigger bangs for your bucks!"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like the sillyness to be in the sales-pitch. I assume this string is for tooltip?
I'm all for silliness, but we've usually (always?) kept it out from the tooltip.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the description on the equipment-purchase page. It's also the tooltip when hovering over the equipment on the same page. (I discovered that this is used for a tooltip after seeing it used for the description..)

image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO the tooltip / short description should ideally be a single sentence - at most two, if they're short.

"External missile rack able to carry up to 2 medium-sized missiles." <- Impartial description of what the item is/does; should be used as tooltip / item description.

"Bigger bangs for your bucks!" <- Colorful flavor text, product reviews, information about the manufacturer or item's history. Generally should not be displayed as part of the tooltip.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in #5993

The "_DESCRIPTION" is used for equipment tooltips and to start off the description blurb in the side-panel now. The "_FLAVOURTEXT", if present, is displayed underneath that and can add anything additional.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW, I'm not a huge fan of the tooltips hovering over everything.. I think I'd prefer the hovering to auto-update the right-hand panel instead..

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bszlrd thoughts? IMO we'd need to either change the background color or in some way indicate that the stats shown are from the hovered item and not the selected item, or it could get confusing quickly.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't change anything on the right panel on hover. I think that is not good UX, makes things a bit unpredictable, jumpy. And now you would have to keep the mouse on the item to see its data.
Do we even need a tooltip in this case?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I find the tooltips a bit annoying as they tend to hover over the top of the information on the card which I do want to see. But I also see the point of the tooltips in being able to quickly browse through a list and get some basic information without having to click on each item.

But at the end of the day, the player will have to click on the item to either purchase it, or to look at the detailed info which isn't in the tooltip anyway.

I've seen quite a few UIs which use the detail-pane-on-hover-over-list-item approach which is why I mentioned it. If you want to look at an item in more detail, you can just click on it to actually select it and "pin" it to the detail pane - my thinking was that the selected item is the one displayed unless the player hovers over something else.

It looks like it could be implemented pretty easily. But I see the point on it being potentially a "jumpy" and disorienting experience for people not used to this kind of interface.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, tooltips hiding the stuff under them is not good either. I never found that detail pane approach you mention good. They feel like an artifact of console UX, where you don't have a proper mouse, so you have to do these odd gymnastics.
But on the other hand, it could very well work, I just can't imagine it. How complex it would be to prototype it for testing?
Or how about having a hover portion of that screen that shows it, instead of a tooltip?

Another approach I could imagine, but not fully sure about:
Expanding the equipment card downrads to show the description:
equip-hover-1
equip-hover-2
It would still be jumpy in a way, but I not excessively I think. The expansion should only be one line at most, so the height change upon going over a new card wouldn't make it too unpredictable. With keyboard navigation it wouldn't make a difference. And maybe there vould be a very quick animation to it to make it easier on the eyes. I think there are games having a similar UI solution, but I can't recall any on top of my head.
Not sure how complex it would be from the implementation side though.

"MISSILE_UNGUIDED": {
"description": "",
"message": "R40 Unguided Rocket"
},
"MISSILE_UNGUIDED_DESCRIPTION": {
"description": "Equipment description",
"message": "A generic dumb-fire rocket mass-produced on most worlds. Simply aim and fire to solve your problems."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same. I'm not saying to remove it, I'm just opening it up for discussion.

This is to make it consistent with the other rack names. Basically the
numbering scheme is LH-XY0, X: size of missile, Y: number of slots.
Tech level is the same as the tech level of the missile which can fitted
into the rack.

Price is calculated as the base price of the "111" rack, which is 150,
multiplied by the tech-level multiplier (1, 2.5, 3), and multiplied by
the number of slots.
Ships like the AC33 Dropstar have slots sizes up to 5 for missile racks,
so let's add equipment up to that slot size.
* Add translations for HARDPOINT_WEAPON_FRONT_(LEFT|RIGHT)
Following discussion with sturnclaw, racks should carry at most 4
missiles with the possible exception of custom solutions for specific
ships.
@mwerle
Copy link
Contributor Author

mwerle commented Dec 7, 2024

I've merged the commits from this PR into #5993 ; seems a bit silly to manage separate PR's, and it was getting a bit confusing trying to keep in mind what was changed here and what was changed there since really, it's pretty closely-related work.

I can easily split it apart again if preferred.

@mwerle mwerle closed this Dec 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Equip-v2 : have flavour text for all equipment
5 participants