ParadiseStation Wiki:Manual of Style/Files

Return to Wiki Contributor Portal	Files					Return to MOS Main Page
Typography	Prose	Content	Layout	Templates	Files	Accessibility

This section of the Manual of Style describes File rules and standard for our wiki. This includes file types, naming schemes, file quality, and file specifications. It would be considered an acceptable edit to rename/modify a file given that if the name of the file was changed, all references to said file in articles would also be modified to adhere to the name.

File Naming

• All filetype endings should be in lower case EX: .png vs .PNG (WRONG)
• All image names should have the first letter of each word capitalized
• If most useful to contributors, the image name should match the in-game name of the object, location, or mob exactly.
  • Exceptions to this would be extremely long names, names that would be gibberish, or names that would be otherwise impossible to find through the search function
  • In cases where multiple objects share the same sprite, the most commonly used object should be the sprite name and in cases of object inheritance, the base/parent object should be the basis for the name
• Whitespace should be used instead of underscores for spacing
• There should be no space in-between the namespace declaration and file name

File Namespace

The only pages that should exist under the File: are where files are stored. All redirects and non-content pages should be expediently deleted. The File Talk: namespace is only to be used for special instruction pertaining to the maintenance and updating of the image.

Images

• Images should be in a state that most accurately represents their appearance in-game
• Any images (especially Location Images) should be taken using the native built-in BYOND screenshot taker
  • It is preferable to use admin tools to increase view range if necessary
  • If that is not large enough, multiple images should be taken and stitched together
• Any space in an image that a sprite/location does not directly take up should be made transparent

Specifications

• Images should only ever be uploaded as .png files.
• All in-game sprites should be upscaled by a factor of 2 using nearest neighbored scaling
  • For example, a 32x32 pixel sprite in-game would be scaled up to 64x64 for the wiki
  • The only exception to this is character HUDs which should be cropped to 8x8 pixels and then upscaled to 32x32 pixels
• Images should be centered/offset exactly as they appear in dream maker
• Editing to sprites after they are exported from dreammaker should only be done to apply overlays

Gifs

• Gifs should be in a state that most accurately represents their appearance in-game
• Any gifs should be taken directly from dreammaker or assembled with sprites taken directly from dreammaker
• Any space in a gif that the sprite does not directly take up should be made transparent

Specifications

• Animated files should only ever be uploaded as .gif files.
• All gifs should be upscaled by a factor of 2 using nearest neighbored scaling
  • The only exception to this is character HUDs which should be cropped to 8x8 pixels and then upscaled to 32x32 pixels
• Images should be centered/offset exactly as they appear in dream maker
• Editing to gifs after they are exported from dreammaker should only be done to apply overlays
• If there is not a native speed already set, all gifs should run at 1 frame seconds, if the gif is swapping through item states 2 frames a second is preffered.