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

sm64ex: Replace old launcher tutorial #2383

Merged
merged 4 commits into from
Nov 23, 2023

Conversation

N00byKing
Copy link
Collaborator

What is this fixing or adding?

The old launcher was """inherited""" from an existing project aiming to provide a launcher for windows and linux.
Original intention was to improve upon it, and merge everything into upstream, keeping it as generic as possible.
However, upstream abandoned the project not long after, without responding to pull requests.

The launcher additionally had many assumptions built in, and was very unstable. Extending it for new features (such as the patches) was annoying to say the least. There was very little input validation, and users often stumbled on simple issues, causing frustration. Examples include leaving fields empty, use of invalid make flags, exiting the program early due to missing feedback, providing invalid paths and more. While I've fixed some of these issues (Adding Browse... buttons for folder paths, allowing for special characters in some areas), working with this launcher is also frustrating to me.

The new launcher should hopefully remedy these issues by introducing a new and modular base, and check for more issues ahead of the user pressing Compile. It logs significantly more info to help for debugging, and presents the log to the user during compilation to show that something IS happening, and they aren't just staring at a crashed program.

How was this tested?

The new launcher has been tested continuously for about a week during active development, before starting public testing about 4 days ago.
The launcher is not yet feature complete, and bug testing will continue until that is the case.
I've opened this PR to gather feedback on wording, as new functionality is limited to advanced users anyway (Applying Patches).
I'll mark the PR as ready once I am confident that the new launcher will not introduce new issues, and reaches feature parity with the old one.

If this makes graphical changes, please attach screenshots.

@ScootyPuffJr1 ScootyPuffJr1 added the is: documentation Improvements or additions to documentation. label Oct 27, 2023
Update launcher info for linux support, minor improvements to other sections
@N00byKing N00byKing marked this pull request as ready for review November 2, 2023 11:29
@N00byKing N00byKing changed the title DRAFT: sm64ex: Replace old launcher tutorial sm64ex: Replace old launcher tutorial Nov 2, 2023
@N00byKing
Copy link
Collaborator Author

While I'm still giving people time to test, the new launcher is, as far as features are concerned, ready for release.
As such the documentation is now essentially finalized.

@ThePhar ThePhar merged commit 286dfd8 into ArchipelagoMW:main Nov 23, 2023
7 checks passed
@N00byKing N00byKing deleted the sm64ex_launcher branch November 23, 2023 21:39
Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is: documentation Improvements or additions to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants