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.

Sign up for GitHub

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
wants to merge 7 commits into from
Closed

Feat/equipment descriptions #5992

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2a0ece5
feat(equipment): add missing translations strings
mwerle Dec 6, 2024
4bda89c
feat(equipment_description): add descriptions for missiles and pylons
mwerle Dec 6, 2024
bc96fc6
feat(missile_racks): Rename LH-230 to LH-220
mwerle Dec 6, 2024
b4814d8
feat(missile_racks): give each rack a price and tech-level
mwerle Dec 6, 2024
24538e5
feat(missile_racks): add racks up to slot size 5
mwerle Dec 6, 2024
0742c15
feat(translations): add missing translation strings
mwerle Dec 7, 2024
59729c1
fixup(missile_racks): remove racks carrying 8 missiles
mwerle Dec 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions data/lang/equipment-core/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,10 +199,26 @@
"description": "Name for the 'Missile Bay' equipment hardpoint",
"message": "Missile Bay"
},
"HARDPOINT_MISSILE_BAY_LEFT": {
"description": "Name for the 'Missile Bay' equipment hardpoint",
"message": "Missile Bay Left"
},
"HARDPOINT_MISSILE_BAY_RIGHT": {
"description": "Name for the 'Missile Bay' equipment hardpoint",
"message": "Missile Bay Right"
},
"HARDPOINT_PYLON": {
"description": "Name for a generic missile pylon",
"message": "Pylon"
},
"HARDPOINT_PYLON_LEFT": {
"description": "Name for a generic missile pylon",
"message": "Pylon Left"
},
"HARDPOINT_PYLON_RIGHT": {
"description": "Name for a generic missile pylon",
"message": "Pylon Right"
},
"HARDPOINT_UTILITY": {
"description": "Name for a generic utility hardpoint",
"message": "Utility"
Expand Down Expand Up @@ -291,6 +307,10 @@
"description": "",
"message": "Guided Missile"
},
"MISSILE_GUIDED_DESCRIPTION": {
"description": "Equipment description",
"message": "A guided missile able to home in on your target using advanced LIDAR."
mwerle marked this conversation as resolved.
Show resolved Hide resolved
},
"MISSILE_NAVAL": {
"description": "",
"message": "Naval Missile"
Expand All @@ -299,34 +319,66 @@
"description": "Name for a multiple-missile external missile rack. 'Hydri' is a brand name.",
"message": "LH-120 Hydri Missile Rack"
},
"MISSILE_RACK_221_DESCRIPTION": {
"description": "Equipment description",
"message": "External missile rack able to carry up to 2 small missiles."
},
"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_RACK_341": {
"description": "Name for a multiple-missile external missile rack. 'Hydri' is a brand name.",
"message": "LH-140 Hydri Missile Rack"
},
"MISSILE_RACK_341_DESCRIPTION": {
"description": "Equipment description",
"message": "External missile rack able to carry up to 4 small missiles."
},
"MISSILE_RAIL_S1": {
"description": "Name for a single-missile external launcher. 'Cnida' is a brand name.",
"message": "Cnida-101 Missile Rail"
},
"MISSILE_RAIL_S1_DESCRIPTION": {
"description": "Equipment description",
"message": "External launcher for a single small missile."
},
"MISSILE_RAIL_S2": {
"description": "Name for a single-missile external launcher. 'Cnida' is a brand name.",
"message": "Cnida-102 Missile Rail"
},
"MISSILE_RAIL_S2_DESCRIPTION": {
"description": "Equipment description",
"message": "External launcher for a single medium missile."
},
"MISSILE_RAIL_S3": {
"description": "Name for a single-missile external launcher. 'Cnida' is a brand name.",
"message": "Cnida-103 Missile Rail"
},
"MISSILE_RAIL_S3_DESCRIPTION": {
"description": "Equipment description",
"message": "External launcher for a single large missile."
},
"MISSILE_SMART": {
"description": "",
"message": "Smart Missile"
},
"MISSILE_SMART_DESCRIPTION": {
"description": "Equipment description",
"message": "A smart rocket capable of tracking down your target using an advanced AI module."
},
"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.

},
"OCCUPIED_BERTHS": {
"description": "Label for the number of passenger berths currently occupied in a cabin equipment item",
"message": "Occupied Berths"
Expand Down