Help:Contributing

Revision as of 21:06, 27 July 2022 by TheOnlyZac (talk | contribs) (Added article naming guidelines and other changes)

Welcome to the Sly Cooper Modding Wiki! Our focus is on technical documentation of the Sly Cooper games to aid in making mods and modding tools. If you would like to contribute but aren’t sure where to start, keep reading for how to get started.

Content Policy

When adding new content to the wiki, please abide by the following rules:

  1. No copyrighted content – Do not post any copyrighted game code, assets, or content from other websites without the proper license/attribution.
  2. Keep it relevant – Please only add content that is relevant to modding and reverse-engineering the Sly Cooper games.
  3. Be respectful – Please be respectful of other users and their contributions. If you have any questions or concerns feel free to contact a wiki administrator.
  4. When in doubt, ask for help - If you aren't sure how to do something, or whether something is allowed, you can always ask for help on Discord or ask an administrator on their talk page.

How to Contribute

Documenting game content

Documentation is the core focus of this wiki. If, through modding or reverse-engineering, you learn some new technical information about a file format, game mechanic, or something along those lines, please add it! The goal is to make information readily accessible and prevent people from doing the same work over and over, thereby making it quicker and easier to make mods.

If you have something to add something but there is no page for it, create one. Even if it’s very short, just add the {{stub}} tag to the bottom of the page, and eventually someone will come along and expand it.

Adding images

If an article has no images it is usually a good idea to add some. This might be as simple as taking a screenshot in PCSX2 and uploading it. A list of articles that need images can be found at Category:Articles with missing images

When uploading images, please follow these guidelines:

  • For in-game screenshots, use native resolution PNG images if possible
  • Use descriptive files names, eg. Sly 1 May Proto Debug Menu.png instead of SCREENSHOT_202207050937.PNG.

If you can improve the wiki by adding an image, please do so! When in doubt, adding an image that may need to be replaced later is better than having no image at all if it will improve the article.

Fact-checking

One way to improve the wiki is by fact-checking statements to confirm their accuracy. The category Category:Articles needing fact-checking contains a list of pages with statements that need to be checked. If you are adding something to an article and you aren't 100% sure it's correct, add the {{check}} tag and it will automatically add the article to that category.

If you are able to confirm something is true, simply remove the [check] tag or replace it with a citation. If you check a statement and find out that it’s incorrect, feel free to correct it!

Citing Sources

You can cite sources using ref tags. If you’re in a hurry, you can just include the URL of the source. If you have time, please include the article title, publication name, and date published as follows:

<ref name=“sly 4 review”>[https://www.ign.com/articles/2010/11/17/the-sly-collection-review?amp=1 The Sly Collection Review] - IGN, 4 May 2012</ref>

The above code will add a reference to the bottom of the page that looks like this:

The Sly Collection Review - IGN, 4 May 2012

If the information you are citing is coming directly from one of the games, you can use the template {{Sly 1}}, {{Sly 2}}, {{Sly 3}}, or {{Sly 4}} in the reference.

Editing guidelines

Creating new articles

When creating new articles, use sentence case for the title unless it is a proper noun.

E.g. Entity swap tutorial, not Entity Swap Tutorial).

If the subject exists in one game, you don't need to add the game in parenthesis after the title.

E.g. The LOCK data structure is only used in Sly 1, so you would name the article LOCK, not LOCK (Sly 1).

If you are documenting something that uses the same name in multiple games, you don't need to add the game name in parenthesis after the title if it is the first article with that name; just make it clear in the article which game you are writing about. However, if it is not the first article with that name, include the game name in parenthesis and rename the existing page to also include the game name.

E.g. If you are writing about the CM struct in Sly 1, but there is no CM article for Sly 2 or Sly 3, just name the article CM.
E.g. If you're writing about the JT struct in Sly 2 and there is already an article named JT for Sly 1, name the new article JT (Sly 2) and rename the old article to JT (Sly 1).