Modding:Modding Wiki Guidelines

The modding section of the wiki is a little different to the main portion of the wiki, and there are several guidelines that should be followed when editing this. Please read through all of this, but if you really want to be lazy, just read through the bold sections.

Modding Wiki Contacts

The modding wiki is actively maintained by Nat. If you have any questions about anything in the modding wiki, please contact me on Discord. It's @Nat, with the picture of a puppy. When this page uses 'I' or 'me', then it means Nat.

Page Version Validation

Due to the everchanging nature of modding, it is important to keep pages up-to-date and verified. Whilst help on maintaining pages is appreciated, please do not worry about doing this. I have a list of every page to verify, and I will validate each page regardless of whether someone else has done it.

Also, please do not update pages to any pre-release or release candidate versions.

Creating New Pages

To help the organization, maintainability, and readibility of the modding wiki, there are a few rules that every page needs to abide by.

1. Ensure that the information you are writing does not already exist elsewhere on the wiki.
2. New pages must be in the modding namespace. Just include "Modding:" before the name of the page when you create it.
3. Pages should be focused on a single topic. Any pages which focus on more than one topic or concept should be split into multiple pages.
4. Pages should be specific to a single mod type. Pages which discuss content modding should not contain any code. If you need to do this, make two new pages.
5. Pages should be created in line with the most stable version.
6. All pages should be categorized with at least the default 'Modding' category.

Tutorial Pages

A good portion of the modding wiki are tutorials. Tutorials should follow these rules:

1. Tutorials should mostly follow a pattern of do, analyse, experiment. Guide the reader through how to do something, then analyse how it works, then get the reader to experiment with what they have done. This follows the idea of inquiry-based learning, to provide new modders with the tools they need to understand what they are doing.
2. All tutorials should begin with an "Objective", and then "Prerequisites". The prerequisites section can simply be "It is recommended that you have completed the 'Basic Code Tutorials' before starting this tutorial.", or some such text.
3. Keep in mind the audience of your tutorial. Is it a tutorial for beginners, or more rehearsed modders? Do not include information that will not be understood by your audience.

New pages MUST be added to the 'New Pages' modding category. This will allow me to find them and add them to the relevant navigation boxes and lists. See the 'Categorize New Pages' section below.

Categorize New Pages

Please, please, please categorize your new pages using language-specific category definitions. Uncategorized pages will not be maintained and will lead to inconsistencies in the wiki.

To add a page to a category, copy and paste the category codes below which are relevant to the very bottom of the page. You will need to use the source editor to do this.

All modding pages should be added to the Modding category, and any other relevant categories.

The following categories should be used:

• [[Category:Modding{{#translation:}}]] - For all pages.

• [[Category:Modding:Content{{#translation:}}]] - For any pages which discuss content mods.
• [[Category:Modding:Content Guides{{#translation:}}]] - For any pages which give information about content topics. These are not tutorials, but informational guides.
• [[Category:Modding:Community Content Tutorials{{#translation:}}]] - For any pages which are content tutorials. Please ensure that your tutorials meet the requirements in the 'Creating New Pages' section.
• [[Category:Modding:Code{{#translation:}}]] - For any pages which discuss code mods.
• [[Category:Modding:Code Guides{{#translation:}}]] - For any pages which give information about code topics. These are not tutorials, but informational guides.
• [[Category:Modding:Community Code Tutorials{{#translation:}}]] - For any pages which are code tutorials. Please ensure that your tutorials meet the requirements in the 'Creating New Pages' section.
• [[Category:Modding:Model Creator{{#translation:}}]] - For any pages which discuss how to use the VS Model Creator. Please note that there are some official tutorials coming soon to this category.
• [[Category:Modding:Troubleshooting{{#translation:}}]] - For any pages which discuss troubleshooting mod issues, and generally improving modding efficiency and tactics.
• [[Category:Modding:VS Engine{{#translation:}}]] - For pages which discuss some more complexities about how the game engine works. We're talking pages such as rendering methods, function execution orders, and other complex discussions.

There are a few more categories, but these have specific requirements before being added. Please contact Nat if you think a page should be included in one of these categories:

• [[Category:Modding:Asset Types{{#translation:}}]] - For pages that give specific details on the asset types for content mods. These need to include certain details.
• [[Category:Modding:Basics{{#translation:}}]] - For pages that give details for new modders, usually explaining how modding in VS works. These should be very beginner friendly.
• [[Category:Modding:Fundamental Content Tutorials{{#translation:}}]] - For specific content tutorials. These are essentially tutorials which follow a very structured pattern, and would introduce a single and important concept to content mods. See the existing fundamental tutorials for more information.
• [[Category:Modding:Fundamental Code Tutorials{{#translation:}}]] - For specific code tutorials. These are essentially tutorials which follow a very structured pattern, and would introduce a single and important concept to code mods. See the existing fundamental tutorials for more information.

New pages MUST be added to the 'New Pages' modding category. This will allow me to find them and add them to the relevant navigation boxes and lists.

• [[Category:Modding:New Pages{{#translation:}}]] - For all new modding pages. If this is not included, then expect your page to barely get found.

Navigation

Yes, okay, the navigation on the modding wiki is a nightmare as of writing this. I'm working on it.

To try and improve the system, please do not edit any navigation boxes. Add your page to the 'new pages' category, and I will sort them out and add them to the relevant navigation boxes and lists.

If you have any brilliant ideas on how to improve the navigation system, please let me know!

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.