-
Notifications
You must be signed in to change notification settings - Fork 751
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
Docs: slight adding games.md rework #1192
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Curious about the reasoning for removing large sections and the simplification of some areas. I understand they're out of date, but I'm wondering if we should just put in the time to properly update this rather than cut out information and then update later.
Feels very: #TODO: Write more docs
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that the notepad++ screenshots should go. The world api covers all of it and screenshots are impossible to maintain.
docs/adding games.md
Outdated
from the server in-game so players can read them, award items when the server tells you to, sync and re-sync when necessary, | ||
avoid double-awarding items while still maintaining game file integrity, and allow players to manually enter commands in | ||
case the client or server make mistakes. | ||
|
||
Refer to the [Network Protocol documentation](./network%20protocol.md) for how to communicate with Archipelago's servers. | ||
|
||
## But my Game is a console game. Can I still add it? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rather than "Can I Still Add it?", which sounds like you are asking permission, "How Easy will it be to add?" is kinder and does not suggest we will limit the games being added. Some of the sections below should probably be adjusted to reflect this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
untouched by this PR. goal was to remove redundant information and fix blatant inaccuracies.
Co-authored-by: el-u <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There were complaints, but given that nobody proposed an actual improvement to the "Requirements" section, I'll just merge as-is. (We should maybe think about axing the last section and just pointing to world api.md.)
* begin reworking adding games.md * make it presentable * some doc cleanup * style cleanup * rework the "more on that later" section of SDV * remove now unused images * make the doc links consistent * typo Co-authored-by: el-u <[email protected]> --------- Co-authored-by: el-u <[email protected]>
* begin reworking adding games.md * make it presentable * some doc cleanup * style cleanup * rework the "more on that later" section of SDV * remove now unused images * make the doc links consistent * typo Co-authored-by: el-u <[email protected]> --------- Co-authored-by: el-u <[email protected]>
Please format your title with what portion of the project this pull request is
targeting and what it's changing.
ex. "MyGame4: implement new game" or "Docs: add new guide for customizing MyGame3"
What is this fixing or adding?
How was this tested?
If this makes graphical changes, please attach screenshots.