Anonymous edits have been disabled on the wiki. If you want to contribute please login or create an account.

PCGamingWiki:Editing guide/Fixboxes and providing instructions

From PCGamingWiki, the wiki about fixing PC games
< PCGamingWiki:Editing guide
Revision as of 12:05, 16 September 2015 by Anonymous (talk | contribs) (Protected "PCGamingWiki:Editing guide/Fixboxes and providing instructions" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))

The main focus of this wiki is providing a centralized hub for PC game fixes. However, if the fixes provided are not explained in a clean and easy to follow process, then they are useless. Ultimately, this defeats the purpose of this wiki.

This section handles two critical aspects of providing fixes: the Fixbox, and how to give instructions "properly".

The Fixbox

Syntax

{{Fixbox|1=
{{Fixbox/fix|Name|ref=<ref>Reference</ref>}}
--instructions go here--
}}

Example

Taken from Full Spectrum Warrior
Instructions

The Fixbox is a specialized container used exclusively for fixes, workarounds, and step-by-step instructions. It provides a formal base for them, as well as keeping the wiki clean.

General rules

  • The title need to summarize what the fix/workaround is trying to accomplish.
    • See above example.
  • For sequenced instructions, use # to label each step.
    • # allows numbered lists to be dynamic.
    • Ex. If new entries are placed in the middle of a list, the old entries are automatically re-numbered.

Providing instructions

Due to the countless variability with games and potential workarounds, it is impossible to come up with rules for every single scenario. For the most part, the contributor will need to use their discretion to write clearly communicated instructions.

That being said, there are some base guidelines that can be applied to almost all fixes:

  • It can be safely assumed that the target audience for the fix can operate a computer at a basic level.
    • i.e. Can use an internet browser, can navigate the OS's file system, knows basic keyboard shortcuts like Ctrl+C and Ctrl+V, etc.
  • Do NOT ever assume that the reader can "figure out the rest". Provide a full set of instructions for the fix, up until the game is fixed completely and can be played.
  • Use relative path locations. Not every user will have C:\ as the drive letter.
  • If a fix requires a particular class of program (ex. hex editors), choose a program, provide a download link for it, and write up the instructions in the context of that particular program.
    • If possible, use programs that are available for free. Fixes are useless if locked behind a paywall.
  • If a fix requires major configuration file modifications (>10 changed lines), create a config file with the changes included and provide a download link.
    • Config file text dumps will be removed.
  • Instructions should gently ease the reader into each step. Everything should be a natural progression of events.

Good example

The Fixbox example from the previous section is also a good case study of clear instructions
  1. Download <File X.zip>.
  2. Go to <file location>.
  3. Rename <File Y> to <File Z>.
  4. Extract the contents of the downloaded file into this folder.
  5. Once extracted, open <File Y-2> with <program name> or other <program type>.
  6. Change the values of <Line 1> and <Line 2> to true.
  7. Save the changes and launch the game.

Common fix templates

While each game has their own fixes and instructions, many of them share universal techniques that can be reused.

Applying compatibility settings (Windows only)

The order of options should remain the same, regardless of what gets removed
Instructions

Using a command line argument

Instructions

Using a in-game console command

Instructions

Installing a program

Instructions

Adding a file(s)

Instructions

Modifying a file

Instructions


References