Difference between revisions of "Emulation General Wiki:Guidelines"

From Emulation General Wiki
Jump to navigation Jump to search
(Created page with "Guidelines for making and editing certain types of pages on the wiki. ==Emulator Pages== Pages for the emulators themselves. If an emulator's name starts with a lowercase let...")
 
(Emulators table)
Line 109: Line 109:
 
'''Accuracy''': See the [[Emulation Accuracy]] page to determine how emulators should be ranked.
 
'''Accuracy''': See the [[Emulation Accuracy]] page to determine how emulators should be ranked.
  
'''FLOSS''': Whether or not the emulator is open source. Note that if the source code was leaked or if the project was open source at one point but now isn't, this should be marked as <nowiki>{{✗}}</nowiki>
+
'''FLOSS''': Whether or not the emulator is both [https://www.gnu.org/philosophy/free-sw.html.en free/libre software] and [https://opensource.org/osd open source] simultaneously. Note that if the source code was leaked or if the project was open source at one point but now isn't, or if the source code is available but non-commercial, this should be marked as <nowiki>{{✗}}</nowiki>
  
 
'''Active''': If the project has seen development/releases/news in the past year or so. This isn't a hard rule, as sometimes an emulator will regularly go over one year without releases, and other times a developer will say that they're stopping development on the emulator.
 
'''Active''': If the project has seen development/releases/news in the past year or so. This isn't a hard rule, as sometimes an emulator will regularly go over one year without releases, and other times a developer will say that they're stopping development on the emulator.

Revision as of 10:27, 6 September 2021

Guidelines for making and editing certain types of pages on the wiki.

Emulator Pages

Pages for the emulators themselves. If an emulator's name starts with a lowercase letter make sure to include {{lowercase title}}

Example pages: MAME, redream

Intro

Include the {{Infobox emulator}} template and fill it out. For the logo try to find a high resolution image from the emulator's website, preferably with a transparent background.

The page should lead with a very brief overview (one or two sentences) of the emulator.

Download

Example table to copy/paste when starting a new page:

Windows Linux Official release

Linux Other downloads
Latest dev build
  • Put the best option first, and bold the text.
  • Use -big icons for single platform links, regular icons for multiplatform links.
  • Use <br><small>Text goes here</small> tags for extra information/notes

Overview

Put a longer description of the emulator here. Highlight its features, what it's good at, where it falls short, etc.

System requirements

If an emulator has system requirements list them here.

External links

Add official links here, stuff like the emulator's/developer's YouTube channel, Twitter, Discord, wiki and compatibility lists (unofficial compatibility lists are okay too).

Make sure to add all relevant category links.

System/Console Pages

These pages are for the system that is being emulated. The page name should be *System Name* emulators

Example pages: Super Nintendo emulators and PlayStation emulators.

Intro

Include the {{Infobox console}} template and fill it out. For the logo use a picture of the system, preferably with a transparent background.

The page should lead with a brief overview of the system: The maker, year and generation it was released, the price it released at (use the {{Inflation}} template), a simplified overview of the hardware specs, and any interesting tidbits about it (eg. This was the first console to..., It was originally meant to be a collaboration between..., etc.).

Emulators table

Do not add an emulator to a table without linking to either its website, source code, wiki page, or a download link.

Example table to copy/paste when starting a new page:

Name Platform(s) Latest Version Accuracy FLOSS Active Recommended
PC / x86
Example-emu Windows Linux macOS FreeBSD Git High
Mobile / ARM
Example-emu Android 1.0 Low
Console
Example-emu GameCube Xbox One V2.64 Mid ~
  • Do not list every emulator made for a system if there is a ton of them. Keep it to the notable (whether that be good or bad) ones.
  • The columns can change depending on the what the emulators offer, for example if one or more of the above emulators had a Libretro port you could include a Libretro Core column. If a couple emulators offered higher resolution rendering while the others didn't, that might be worth adding a column for - though if all did (or didn't) then adding a column for that would be superfluous.
  • List the emulators as they're recommended. Best emulators on top, worst on bottom.
  • Only include the Mobile / ARM and Console rows when there are emulators for them.

Name: If there is an existing page on the wiki for the emulator link to it, and if not link to the emulator's website/source code repository.

Platform(s): Use the template and align it left.

Latest Version: The text should be the latest version number/name, and if an emulator's version is posted on many pages it may have a template (eg. {{MednafenVer}}). If the emulator updates very often you can use 'Nightly', or if the emulator is open source with a buildbot, 'Git'. This should also be linked to the download page of the emulator.

Accuracy: See the Emulation Accuracy page to determine how emulators should be ranked.

FLOSS: Whether or not the emulator is both free/libre software and open source simultaneously. Note that if the source code was leaked or if the project was open source at one point but now isn't, or if the source code is available but non-commercial, this should be marked as {{✗}}

Active: If the project has seen development/releases/news in the past year or so. This isn't a hard rule, as sometimes an emulator will regularly go over one year without releases, and other times a developer will say that they're stopping development on the emulator.

Recommended: See the Recommended Emulators page to determine how emulators should be ranked.

Comparisons

Give a brief overview of the emulators, what they do well and where they fall short, and try to explain why they are or are not recommended compared the the others.

List the emulators in the same order they are on the table.

Other

A system may have unique quirks that make emulation difficult or different, an Emulation issues section could be useful for explaining why that is.

If there was a hardware revision of the system that emulates different games add a section detailing it and if any of the emulators support it.

A Peripherals section showcasing and explaining how to emulate (or use the hardware on an emulator) a system's various non-standard peripherals would be a good addition if applicable.

Make sure to add all relevant category links.