Revamp usage instructions #297
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JeodC
suggested changes
May 6, 2024
Lgt2x
reviewed
May 6, 2024
305500b to
cb86315
Compare
cb86315 to
81dc5fd
Compare
JeodC
approved these changes
May 13, 2024
01eaf59 to
f26732f
Compare
20 tasks
JeodC
suggested changes
May 20, 2024
Before this change, users would have to jump through hoops in order to make sure that they’re using the .d3m files from this repo (as opposed to the .d3m files that came with their version of Descent 3). Specifically, users would have to remove or backup Descent 3’s original netgames/ directory, create a new one, hunt down TCP_IP.d3c and copy it to the new netgames/ directory. This change makes it easier for users to use the latest version of working by creating a netgames/ directory for them. All they have to do is replace the old one with the new one. Fixes DescentDevelopers#369.
This commit revamps the usage instructions in order to accomplish two goals: 1. Make the instructions easier to follow by turning them into a numbered list. 2. Make sure that macOS and Linux users install all of the built libraries for their platforms.
f26732f to
e246c01
Compare
JeodC
approved these changes
May 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Type
Description
This commit revamps the usage instructions in order to accomplish two goals:
In order to accomplish goal number 2, this PR makes it so that the
online/andnetgames/directories are automatically generated for macOS and Linux users.Related Issues
Resolves #120. Fixes #369.
Checklist
Additional Comments
Here are some things that I wasn’t sure about:
NetgamesDir. I wasn’t sure if I should call itNetgamesDirorNetGamesDir. I went withNetgamesDirbecause the folder itself doesn’t do anything to separate the two words..hogfiles, except ford3-linux.hog”. This is done to make sure that an old version ofd3-linux.hogdoesn’t get used. Is there a macOS equivalent of that file? The Steam version of Descent 3 for macOS usesd3-linux.hog. Does the GraphSim version of Descent 3 have something similar tod3-linux.hog?