Template:Infobox emulator
Revision as of 17:33, 8 March 2018 by FosterHaven (talk | contribs) (adding activity parameters (to account for situations like mess))
Developer(s) | Anonymous/Unidentified |
---|---|
Latest version | Unknown |
Platform(s) | {{{platform}}} |
Emulates | {{{target}}} |
Infobox for pages about specific emulators. This role is currently being taken up by Template:Infobox, but this version is improved. It now looks like Wikipedia's primary infobox, and allows for much more parameters, listed below. Many parameters are optional, and have explanations as to why they are optional.
Example
- Note: This example is not shown because the markup is on the same page as the template itself and thus would be recursive.
{{Infobox emulator |title = higan |logo = Icon.png |logowidth = 160 |developer = byuu et al. |version = {{higanVer}} |active = Yes |platform = Windows<br/>macOS<br/>Linux<br/>libretro |architecture = x86_64 |target = [[Nintendo Entertainment System emulators|NES]]<br/>[[Super Nintendo emulators|SNES]]<br/>[[Game Boy / Game Boy Color emulators|GB]]<br/>[[Genesis emulators|MD]]<br/>''others'' |compatibility = 100% for commercial titles<br/>Some homebrew may have small defects |accuracy = Cycle-accurate |website = [http://byuu.org/emulation/higan/ byuu.org] |prog-lang = C <!-- this may not actually be true, it could also be C++, but this is just an example --> |source = [https://gitlab.com/higan/higan GitLab] }}
Parameters
The parameters here are in the order they are displayed. You can technically place these in any order you want (as opposed to first
, second
, third
, etc.), but it's discouraged because the values will only show up one way. That's how the template is designed.
title
- The name of the emulator. Required.
logo
- Right now, this is used for logos. It's optional.
logowidth
- Also optional. Set the width of the logo. Might be useful for logos that require detail to be seen that aren't visible at the default size (210 pixels wide).
orig-developer
- If development was passed onto other people, use this to write the original developer (and use
developer
for the current). This will change the text accordingly, and is optional. developer
- Who's making the emulator? If the project is inactive, then who made the emulator? If the project is on GitHub, link the contributors page and say "(project) Team". Leave it unanswered and it will say "Anonymous/Unidentified".
version
- What's the current version? For new pages, you will want to templatize this, especially when updates happen often. Emugen naming conventions are usually Template:(Project)Ver and you transclude it into the infobox by doing
{{ (Project)Ver }}
. See the pages of other emulators if you're confused. For the targeted platform's own table, apply the same template there.last-version
- Replaces
version
(don't use both at the same time). If the project is actually defunct and no longer in development, this parameter should be used to show the last version published.
active
- Is the project active? If its repository hasn't received any activity in the last month or two, it probably went inactive. Always be sure to check other branches. Optional, because not everyone has the time to check.
fate
- If the project is defunct and no longer in development, what happened to the project? Do not use for active projects (obviously).
platform
- What platforms does the emulator run on? Often called the host in virtualization. Required because it's gotta run somewhere. List the operating systems and consoles (if it has a standalone package for them), otherwise put libretro if they have libretro cores.
architecture
- What architecture is the emulator coded for? Not to be confused with the target architecture, which will always be the same so long as you target the same device.
target
- What platforms does the emulator... well, emulate? Often called the guest in virtualization. Required because it's gotta emulate something to be an emulator. Be sure to link to the target's own page.
compatibility
- This one's optional, since there's no universally accepted metric for what counts as compatible, but essentially... does it run every game? What can it run?
accuracy
- How accurate the emulator is. Optional.
website
- Optional because not every project has a website (especially true of older and inactive projects for which we have articles on).
language
- Optional because this is really only needed if it's not in English, for example XEBRA.
prog-lang
- Optional, especially given that it's difficult to determine what programming languages closed-source projects use.
source
- Where can the source code be found? Optional as closed-source emulators don't provide this (obviously).