Modding:Using The Modding Wiki
Modding - Using the Wiki
Welcome to the modding wiki! When learning to mod, this will be the most invaluable source of information for the new topics and techniques you will need to know.
However, it can be a bit daunting at times, so here's some tips on how to make the most of your wiki-based journey.
Read The Pages
Seriously.
It is not recommended to cherry-pick articles when learning how to mod. Many of the modding tutorials are built to be progressive from one another, and a lot of them will have a "prerequisites" section in their introduction that gives a list of pages that are recommended to read or tutorials to complete. Do not ignore these prerequisites. They are there for a reason.
The tutorials created for the wiki are tutorials, and are here to teach you how to mod. They are not there to provide mod examples that can be copy and pasted - See the official mod examples if that is what you are looking for. If you copy and paste the code provided in the wiki tutorials without following along the previous steps, do not expect things to work.
The Wiki on Mobile
Due to the complex nature of some content included in the wiki, it is recommended to use a device with landscape support. Some mobile devices, including phones with small screen-widths, may struggle to display all of the necessary content.
By default, the wiki's search feature excludes the modding pages. To update your search preferences, click the "Search Modding" button below. The results page will show that the Main and Modding namespaces are checked. If you are logged in, you can check "Remember selection for future searches", then click search to save the changes.
Unfortunately, due to some limitations with the wiki, the search feature is not always ideal. To counter this, and to ensure that information can be easily found, pages are built using a hierachy system.
As shown below and on the home page, there are currently 7 main categories:
| Modding | |
|---|---|
| Basics • Content • Code • Asset Types • Model Creator • Troubleshooting • VS Engine | |
Every page will contain a navbox (like the one above) at the very bottom of the page. Rather than showing every link on the modding wiki, these will display links that are only relevant to the category and subcategories you are currently viewing.
Note that the modding wiki has over 170 pages which have to be maintained, and it is not feasible for anyone involved (both maintainers and readers) to have to navigate through a navbox of 170 links of similarly-named articles to find what they are looking for. Learn to use the categories and navboxes to your advantage, and you'll find what you're looking for.
For a more direct approach, and to observe a full list of pages that exist in the wiki, you can navigate the categories directly.
Every page on the modding wiki should be added to a category. You can view categories at the bottom of the left-hand panel of a page.
Categories are split in a hierachy too, but can be harder to navigate than using the navboxes. It is recommended to use the category pages when you are more experienced with what wiki pages exist.
By using a combination of the navboxes, searching, and categories, you should be able to find the pages relevant for what you need.
Use this link to go to the modding category.
| Modding | |
|---|---|
| Basics • Content • Code • Asset Types • Model Creator • Troubleshooting • VS Engine | |
| Using the Modding Wiki • Getting Started • Types of Mod • Other Resources | |
