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

Streamline Mac onboarding #3199

Merged
merged 1 commit into from
Nov 18, 2020
Merged

Conversation

HebaruSan
Copy link
Member

Motivation

Mac users have been struggling with how to start using Console UI, see #3047, #3185, and recent discussions in the macos support channel in Discord. On close inspection, not all the on-screen prompts are as clear or helpful as they could be.

Problems

If you start ConsoleUI with no instances and you don't have KSP installed in Steam, you get the KSP instance list screen:

select a game instance

  • There's not much of a hint of what to do (the right answer is to press a to add an instance.)
  • "Select a game instance" is incomplete on a screen where you can also add instances

When adding an instance:

enter a value

  • The fields have the default <Enter a value> ghost text, which could be more helpful
  • Not all users may necessarily know what a path is, and if they do, they might not be sure about what format to use (macOS uses : as a path separator in some contexts and / in others)

Multiple users have asked for help with this exact screenshot:

does not correspond

  • The header says "Edit KSP Instance", but we're adding
  • I think they got here by dragging and dropping their KSP folder into Terminal, which "helpfully" adds backslashes on the incorrect assumption that the string will be used by bash
  • I think /Applications/Kerbal Space Program is where the KSP Store installer installs KSP

Changes

  • Now if you're on Mac, you don't have any instances, and your game is located in /Applications/Kerbal Space Program, we detect it automatically like we can with Steam
  • New more inclusive help label on the instance list screen:
    image
  • Now if you don't have any instances and we can't detect the game automatically, Console UI will jump to the add instance screen instead of the empty list

When adding an instance:

image

  • Add instance title changed from "Edit KSP Instance" to "Add KSP Instance"
  • Field ghost text now gives more info about what the fields are for
    • Also done for the add repo screen, which was the only other spot where we weren't customizing the ghost text
  • A help label under the path field shows <Program Files>\Kerbal Space Program or /Applications/Kerbal Space Program in your OS's path format, so you can figure out what to enter even if it's different from the default
  • If you drag and drop /Applications/Kerbal\ Space\ Program onto the path field, we remove the backslashes when you try to save. Note that backslashes in general are not removed; only the ones in the specific string Kerbal\ Space\ Program because this is common and guaranteed wrong

@HebaruSan HebaruSan added Core (ckan.dll) Issues affecting the core part of CKAN Pull request macOS Issues specific for macOS ConsoleUI Issues affecting the interactive console UI labels Nov 16, 2020
Copy link
Member

@DasSkelett DasSkelett left a comment

Choose a reason for hiding this comment

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

Yup, does a good job at pointing the users in the right directions now.

@HebaruSan HebaruSan merged commit 80adb33 into KSP-CKAN:master Nov 18, 2020
@HebaruSan HebaruSan deleted the fix/mac-usability branch November 18, 2020 01:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ConsoleUI Issues affecting the interactive console UI Core (ckan.dll) Issues affecting the core part of CKAN macOS Issues specific for macOS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants