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

Proof-of-Concept: Display unknown version information in GUI #459

Closed
wants to merge 2 commits into from

Conversation

lordhoto
Copy link
Contributor

@lordhoto lordhoto commented Apr 4, 2014

I wanted to push this out for discussion for a long time, so let's do it now :-P. As the title suggests this is a try at showing unknown version information on detection to the user. This will hopefully raise awareness of the users that even though ScummVM might detect a game he still might have an unkown version (and thus that we would like to get a report about it).

The GUI is pretty a simple hack (and should be replaced by a proper scrollable text field, since otherwise it doesn't really fit in lowres mode). The API extensions to detectGames is also really simple and we might think of making this nicer (maybe we add a getLastDetectionError/Information?).

Attached some screenshots so you get a feeling of how it looks like. These show the dialog which will come up when ScummVM's AdvancedDetector detects a game via fallback.
Hires:
scummvm-hires-unknown
Lowres:
scummvm-lores-unknown

@fuzzie
Copy link
Contributor

fuzzie commented Apr 4, 2014

I seem to recall we discussed this at some point, but really we want the user to submit the log (at some point I changed this from printf to logMessage so this actually works), or at least have a way to copy-and-paste the data. This way is obviously better than not notifying the user at all, though.

@lordhoto
Copy link
Contributor Author

lordhoto commented Apr 4, 2014

Yes, we might just point out that there's a log (then again on some systems there is none...).

@PaulGilbert
Copy link
Contributor

I can't remember if this was suggested the last time this was discussed or not, but why not have something similar to above but, for systems that have an API to support it, a notification that the needed information has been copied to the clipboard (and copy it to the clipboard). That way it makes it easier for people to send us the message, rather than hunting down the location of the log file.

@somaen
Copy link
Member

somaen commented Apr 4, 2014

If you want it to the clipboard, please don't do it automatically, let the user have a button for doing so if that's what they want (instead of possibly pushing something they care about from their clipboard).

I think this makes the information more visible to the end-user in total, and should thus increase the chance of getting the md5-reports from the users.

@somaen
Copy link
Member

somaen commented Apr 4, 2014

Oh, and that warning doesn't really look good in low-res, would it be possible to break the text differently in lo-res mode?

@dreammaster
Copy link
Member

I'm not even sure all that text is needed, particularly since the user can't directly copy it off the screen anyway. It could be simplified so that there's no problem with lo-res modes.

@criezy
Copy link
Member

criezy commented Apr 4, 2014

For reference on the last time we discussed this, see this email from Max and the emails that follow: http://sourceforge.net/p/scummvm/mailman/scummvm-devel/thread/65691CCC-3686-4AFF-B578-6B9953AAFEE9%40quendi.de/#msg26507203

We did discuss options such as a "Open Log", "Copy to clipboard" or "Send by email" button, or even a button that automatically fills a form.

@digitall
Copy link
Member

digitall commented Apr 5, 2014

@lordhoto : Looks like a good move in the right direction.

One small point, you seem to have spelt "unknown" as "unkown" in the commit message for cd1ffb7 and a couple of the comments in the code...

Johannes Schickel added 2 commits April 5, 2014 15:11
This can (and will) be used to display unknown version information to the user
through our GUI.

Currently only AvancedDetector is updated to supply this information in case
it encounters unknown versions.
@lordhoto
Copy link
Contributor Author

Oh, and that warning doesn't really look good in low-res, would it be possible to break the text differently in lo-res mode?

We might do that. Currently I just chose the easy way out and used our line wrapping code in Font. As I tried to hint in the subject this was just some quick hack to get some more opinions ;-).

I'm not even sure all that text is needed, particularly since the user can't directly copy it off the screen anyway. It could be simplified so that there's no problem with lo-res modes.

Yes, probably we should do something like having a "open the log" button in case we have a log and/or have this "copy to clipboard" option if that is possible. Otherwise, we might hint the user to watch the log/stderr/whatever. I guess we will need to handle this depending on what is possible on the target platform...

@sev-
Copy link
Member

sev- commented Apr 28, 2014

Yes, 'open the log' button or at least message would be beneficial, otherwise we are forcing users to type in those lengthy md5 which is error-prone.

@bluegr
Copy link
Member

bluegr commented Jul 5, 2014

This looks good, if we provide a way for users to copy/paste the detection details.

One way would be to send the text to the clipboard too, but this is highly platform-dependant. On Windows, there's OpenClipBoard() + SetClipboardData():
http://stackoverflow.com/questions/6436257/how-do-you-copy-paste-from-the-clipboard-in-c
http://www.cplusplus.com/forum/general/48837/
On OS X, there's NSPasteboard:
https://developer.apple.com/library/mac/documentation/Cocoa/Reference/ApplicationKit/Classes/NSPasteboard_Class/Reference/Reference.html
For Linux, it depends on the window manager used.

Another way would be to open the log file in a text editor systematically. In Windows, there's ShellExecute() / ShellExecuteEx() to open the default system text editor on the log file:
http://stackoverflow.com/questions/5658696/opening-a-file-with-different-text-editors
In *nix, this could likely be done via exec() and a set of known editors (e.g. Vim, gEdit, Nano, Emacs...)

@bluegr
Copy link
Member

bluegr commented Jun 24, 2015

Any update on this? Is there a cross-platform way to either copy the detection data to the clipboard, or open the log file in a text editor? (also refer to my previous reply)

@sev-
Copy link
Member

sev- commented Nov 7, 2015

Any updates?

@lordhoto lordhoto closed this Mar 15, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
9 participants