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

Add a button to display the CrashReporter in the main menu #3

Open
aa019 opened this issue Nov 21, 2016 · 0 comments
Open

Add a button to display the CrashReporter in the main menu #3

aa019 opened this issue Nov 21, 2016 · 0 comments
Assignees

Comments

@aa019
Copy link
Collaborator

aa019 commented Nov 21, 2016

Description

When Terasology encounters a fatal exception, a lightweight Crash Reporter application is launched, allowing users to report the error using various methods - upload the crash log to Pastebin or Google Drive, file a GitHub issue and so on.

However, non-fatal errors and bugs cannot be easily reported using the Crash Reporter interface - the user will have to manually locate the game log then report it using whatever method they can think of. A button that'll open the Crash Reporter under normal working conditions would help report these non-critical issues.

Definition of 'Done'

A button is added to the game's pause menu that opens the Crash Reporter interface, showing the game's current log.
[Optional but nice to have] The Crash Reporter itself is reworked to have a "non-critical" mode that changes several strings and interface elements to remove any mentions of a crash having occurred (e.g. in the screenshot above, "A fatal error occurred" is changed to "Current game log" and the red warning icon is changed to something more neutral). This mode should be used when the Crash Reporter is launched manually.
Required skills

The issue involves working with the game's codebase and requires intermediate level Java skills.

Where to start?

The crash reporter can be launched using CrashReporter.report(Throwable throwable, Path logPath);.
The exception being thrown should be a dummy, since no critical exception actually occurs.
The path to the game log can be retrieved via LoggingContext.getLoggingPath().
Adding the button to the pause menu requires modifying its asset file (pauseMenu.ui), as well as the code-behind class (PauseMenu). For a quick overview on working with interface screens, check out the NUI Quick Start tutorial!
The optional item will require working on the Crash Reporter itself, which is located in an auxiliary repository: https://github.com/MovingBlocks/CrashReporter.
--- Want to back this issue? Post a bounty on it! We accept bounties via Bountysource

@aa019 aa019 changed the title Add a button to display the CrashReporter in the main menu #3 Add a button to display the CrashReporter in the main menu Nov 21, 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
Development

No branches or pull requests

1 participant