About
PEAK Modding Wiki is a project maintained by the PEAKModding organization on GitHub. If you’d like to help us with this wiki, make sure to reach out! For smaller changes such as minor corrections, a single pull request will do fine though.
A large part of the community is on the PEAK Modding Community Discord server we run which is where most discussions about maintaining this wiki and PEAKLib happens. That said, GitHub is also used for tracking issues.
Type of Content
Section titled “Type of Content”The main focus of this wiki is on providing content for mod developers. To keep this wiki small and easy to follow, we avoid writing too much duplicate content that is already documented by e.g. BepInEx or has a good page on another modding wiki.
This doesn’t mean we avoid mentioning useful information though. Just that when we do, we link to other articles. For example, see the page: Useful BepInEx APIs.
About Modding APIs
Section titled “About Modding APIs”The only API documentation this wiki hosts is PEAKLib, the community modding API. The benefit of this is that we can write guides for content creation with just this API in mind. We can also ensure that the project stays maintained, and all pull requests are reviewed by someone else.
Anyone can make a PEAKLib submodule, and doing so means that everything goes through code review and we help make the API good. You also won’t need to do as much work to keep the API maintained as we make sure PEAKLib submodules work after game updates, and we will take care of pull requests.
If you are interested in starting a PEAKLib submodule, come chat with us on the PEAK Modding Community Discord server, in the #peak-lib channel!
Categories
Section titled “Categories”When adding new content to this wiki, we’d hope it fits in either the Creating a Mod or Content Creation categories. Having only two major categories helps keep the wiki easy to comprehend, as:
- Creating a Mod has generic articles about making and publishing any mod
- Content Creation focuses on creating specific types of content, typically using PEAKLib
Contributing
Section titled “Contributing”We appreciate contributions to this wiki. As a first step, make sure you have read this and all of Type of Content above so you know how we manage this wiki.
If your contribution is small, you can just go ahead with your pull request. But if your contribution is on the larger side, you will want to chat with us on the PEAK Modding Community Discord server, in the #modding-wiki channel before you starting work on it.
When it’s clear what to write and how, you can start working on your new page or making modifications to existing pages. This wiki uses Astro Starlight, so for help see its documentation which you can find in the README of the wiki on GitHub: https://github.com/PEAKModding/PEAKModding.github.io.
Making Modifications
Section titled “Making Modifications”For small contributions, you can use the Edit page button on the bottom left of the page. It will open the article you are looking at in edit mode on GitHub. See GitHub Docs: Editing files in another user’s repository for more information.
If you need to see the website with your modifications, fork and clone the repository locally and read the README for more instructions: https://github.com/PEAKModding/PEAKModding.github.io.