-
Notifications
You must be signed in to change notification settings - Fork 27
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 "Modding APIs" section #44
Conversation
would love any comments on this @MaxWasUnavailable @Xilophor since I'm not 100% sure the best way to go about this I want to keep the playing field as fair as possible, but I do think we should incentivize modders to write guides on their APIs - I've done this in the PR by adding a gold star to any on-wiki modding APIs Once this (or something similar) is merged we can get #28 onto the wiki |
there might also be some APIs missing right now, feel free to suggest/add some. I just did a quick general overview of APIs I've seen mentioned a lot |
I feel like advanced topics should come before APIs. Since we then have a fairly clear logical ordering going from non-API to API stuff, rather than no/yes/no. |
I was thinging about this yesterday. With all of this being added, the main non-developer stuff is being "squished" in the sidebar; should we look into separating it into a Beginner's Guide and a Developer's Guide - may be appropriate for another PR/issue |
I'm also honestly not 100% sure what the line between an API and advanced modding topic is, that might have to be figured out as we go Like, the page on custom networking uses UnityNetcodeWeaver, which I would technically class as an API, but the concept is so fundamental to modding |
I think we can also have two separate sidebars like bsmg.wiki does, I can look into it in a later PR |
This would be good imo. Separate mod creation and mod usage. |
We can work this out as we go. We may want to eventually boil it down to the fundamentals, and link to APIs that make it easier. |
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 think we've already discussed everything relating to this PR, so I'll go ahead and approve.
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.
Whoops, did that in the wrong order
The wiki needs a definitive source of user-created APIs for common usecases, as discussed in #28
This PR adds a modding API section with:
I think going forward, at least for now, the sections should be:
Here's an example of what I think the Modding APIs section could look like once we start getting some guides (like #28)