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 "Modding APIs" section #44

Merged
merged 9 commits into from
Dec 20, 2023
Merged

Add "Modding APIs" section #44

merged 9 commits into from
Dec 20, 2023

Conversation

legoandmars
Copy link
Contributor

@legoandmars legoandmars commented Dec 19, 2023

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:

  • A section for non-code APIs so non-programmers can have a section to check for simple swaps (like audio replacement, custom suits, etc)
  • A section for code APIs so modders can have an easy overview

I think going forward, at least for now, the sections should be:

  • Initial setup (Max's guide on how to get everything initialized)
  • Modding APIs (for user-created APIs, such as customsounds)
  • Advanced Modding (for specific topics like Networking and creating Configs. the section may need a rename)

Here's an example of what I think the Modding APIs section could look like once we start getting some guides (like #28)
image

@legoandmars
Copy link
Contributor Author

legoandmars commented Dec 19, 2023

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

@legoandmars
Copy link
Contributor Author

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

@MaxWasUnavailable
Copy link
Contributor

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.

@Xilophor
Copy link
Contributor

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

@legoandmars
Copy link
Contributor Author

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

@legoandmars
Copy link
Contributor Author

legoandmars commented Dec 19, 2023

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 think we can also have two separate sidebars like bsmg.wiki does, I can look into it in a later PR

@MaxWasUnavailable
Copy link
Contributor

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 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.

@MaxWasUnavailable
Copy link
Contributor

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

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.

@legoandmars
Copy link
Contributor Author

This would be good imo. Separate mod creation and mod usage.

Yeah, I think the sidebar is probably fine right this moment, but once #44 #38 and #28 are merged it's going to start getting overwhelming if we keep adding more pages

for now I've made an issue - #47

docs/apis/modding-apis.md Outdated Show resolved Hide resolved
Xilophor
Xilophor previously approved these changes Dec 20, 2023
Copy link
Contributor

@Xilophor Xilophor left a 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.

Copy link
Contributor

@Xilophor Xilophor left a 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

@Xilophor Xilophor merged commit ceef6e9 into main Dec 20, 2023
2 checks passed
@Xilophor Xilophor deleted the modding-apis branch December 20, 2023 14:55
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

Successfully merging this pull request may close these issues.

3 participants