Underrail Wiki:Community portal
Normal registration and anonymous editing are currently disabled due to spambots. Sorry for the inconvenience. In the meantime, please email admin@underrail.com, PM Styg on the forums, or DM him on the Underrail Discord for a wiki account. New editors are welcome, everyone (except spambots) are accepted! |
Welcome to Underrail Wiki! The Community Portal hosts a simple style guide and "state of the wiki" list for the base game. See Underrail Wiki: Project Expedition for the state of Expedition articles.
Style guide
We don't have strict style policies. Generally, editors should follow common sense. When in doubt, Wikipedia Manual of Style is a good resource for all things wiki style.
Core elements of articles are usually right-side infobox or image, short introductory text, main body text under headings common for that type of article, navbox for easy access to related articles, and finally categories. Editors are encouraged to follow style set by existing articles of same type; It is often the easiest way to get things done, particularly if one is not familiar with mediawiki in general and/or local templates.
All templates have documentation explaining their parameters and typical use cases. Template pages are easily accessible when previewing an article you're editing - links to all templates used on that article appear on the bottom of the edit page. There's also Category:Templates and its subcategories.
Here are few oddities that markedly differ from wikipedia's encyclopediac nature:
Naming
The basis for article naming is what you see in the game. Every notable object in the game (Items, characters and such) should have corresponding page in the wiki, even if it's just a redirect to the main article. (As is the case with most craftable item variations.) In case of name conflict, use disambigation with no preference given to any one page over others sharing the name. (eg. Guard for the feat and various generic NPCs.)
Quick note on file naming.
- Icons: Every item name has File:<Item name>.png file redirect pointing to its icon to make creating new infoboxes easy. Other icons: File:<Feat name> icon.png, File:<Status effect name> effect.png, File:<Ability name>.png.
- Common character sprites (with transparent background) and character screenshots with in-game surroundings both generally use File:<Character name>.png.
- Screenshots of Zones are named after their internal name, since most zones share their in-game name with many others. For zones consisting of multiple screens, the additional screens have a running number suffix. Their order is arbitrary.
- Portraits and their backgrounds are directly ripped from the game as is. Filenames are original, unless that would lead to naming conflict.
- Others files may use whatever conventions are established; Look at how other files in the same category are named.
Spoiler policy
We try to avoid spoiling surprises and secrets, but spoilers are not explicitly marked where they are to be expected. (Eg. lore and quest pages can contain unmarked spoilers pertaining to the topic.)
Templates:
- {{spoiler warning}} for adding a large spoiler warning on top of articles that are basically full of spoilers.
- {{spoiler}} for short inline spoiler text for use anywhere - middle of body text, infobox parameters, etc.
- {{hiddensection}} for larger sections, full paragraphs or more. Starts hidden with a toggle to show/hide.
A good rule of thumb is to keep spoilers proportional to what a reader would reasonably expect. On a character or faction article having background information should not be a problem, but for bits that are treated as secrets in the game, or for those that are not but are not revealed until much later, it is better to use inline spoiler or hiddensection. And when the spoiler is too big to take the risk or its presence is in itself a spoiler, it is best to split. Conversely on pure lore articles – such as Biocorp projects, historical events, obscure mentioned-only characters, articles in general you would be unlikely to visit by accident – do not worry too much about marking spoilers, if at all. That said, it's best decided on a case by case basis.
Sources and references
This wiki does not have the standard mediawiki Cite extension installed, so <ref> tags can't be used. References are normally not required as the main source for nearly everything in this wiki should be the game itself. When necessary (citing developer posts or such), unnamed external link wrapped in <sup> tags will create an inline reference link that looks like a familiar mediawiki reference.
Prefer primary sources: information directly from the developers and the game itself. Information from secondary sources is acceptable, but confirm its validity if possible. Let's try to keep this wiki authoritative.
Notable exception: This wiki started hosting player-made maps as a stopgap measure to help players before the Global Map was introduced. Given enough interest, we could also host guides, player builds, or other such content. But given the wiki's small contributor base, such projects seem very unlikely at this time.
State of the wiki
There are many ways in which you can help. Don't be afraid to edit and create articles!
Note: The below concerns progress of wikifying the base game! See Underrail Wiki: Project Expedition for the state of Expedition articles.
Existing articles
Loosely ordered by overall status; from good to bad.
Major page group | Progress | Things to do |
---|---|---|
navboxes / lists | ☑ Good |
|
Feats | ☑ Good |
|
Items | ☑ Ok |
|
Psi abilities, Abilities, Status effects | ☑ Ok |
|
Quests | ☐ Basics |
|
Locations | ☐ Basics |
|
Skills, Base Abilities, Combat Stats | ☐ Basics |
|
Characters, Enemies | ☐ Basics |
|
Factions | ☒ Bad |
|
New pages
Overall status: Practically 100% of base game content up to version 1.0.2.4 has pages the wiki!
Check out the Special:WantedPages for a list of frequently linked-to pages that don't yet exist. Feel free to create any of them!
Major article group | Progress | Infobox and documention | Navboxes (should link to all pages) | Notes / other resources |
---|---|---|---|---|
Quests | ☑ Good | Quest Infobox | Missions navbox | Existing quest pages can be used as references, though there is much room for improvement in walkthroughs. |
Items | ☑ Good | Infobox item | Most of Category:Navbox templates | Use existing item pages for reference, but longer body text is welcome.
|
Characters, Enemies | ☑ Good | Character Infobox | NPCs, mentioned characters, minor NPCs and enemies | Existing pages can be used as references, though many are stubs.
|
Locations | ☑ Good | Location Infobox | Locations navbox |
|
Feats | ☑ Good | Feat Infobox | Feats navbox | Use existing pages for reference. |
Abilities | ☑ Good | Ability Infobox | Abilities navbox, Psi abilities navbox | Use existing pages for reference. Feat abilities should go to relevant feat page; no need for two pages and disambiguation. |
Status effects | ☑ Good | Ability Infobox | Status effect navbox | Use existing pages for reference. Status effects should be added to relevant main article when they share name (e.g. Irongut medicine item and status effect) |
Random events | ☑ Good | Depends on the event; usually standalone event page or noted on relevant character page(s) | Given their random nature and other factors, documenting these will be an ongoing long-term process. |
Uploading images
Screenshots and editing
- Icons should be 33x33px PNG, with transparent background and correct transparency
- NPC/mob models should be minimum 100x100px or taller as required, similar in size with the portrait next to it in the infobox
- Unique NPCs can use cropped screenshots to illustrate their surroundings
- Mobs and generic NPCs are better off with generic sprite, transparent background
- Quests infobox supports 300x200px images (or larger with same aspect ratio), can be a key event or point of interest in the quest
- Location infobox looks best with 1.5:1 or higher aspect ratio image, width is limited to 300px.
- Articles for large areas with their own global map (eg. Foundry, Upper Underrail) should use a screenshot of the global map.
- Articles for areas spanning multiple zones, but no global map, should use a screenshot.
- Articles for single zone can just use a full zone screenshot.
Image categories
- Category:Images is the root category.
- Category:Item icons for item icons (☑ complete)
- Category:Armor icons for armor icons (☑ complete)
- Category:Oddity icons for oddity icons (☑ complete)
- Category:Weapon icons for weapon icons (☐ incomplete) - few base game gun variant icons related to rapid reloader configurations are missing, see full variant lists at Chimera, Hornet, Huszar, Marauder, Impala, Steel Cat, Jaguar, Jackrabbit, Neo Luger, Hawker.
- Category:Feat icons for feat icons (☑ complete)
- Category:Icons for all other icons - menus, abilities, status effects, etc (☑ complete)
- Category:Furniture for player house furniture (☑ complete)
- Category:Maps for global map view screenshots (☐ incomplete)
- Category:Zone screenshots for area screenshots - see also Zones (☐ incomplete, missing new waterways)
- This CustomConfig.xml lets you see the zone name by holding Alt in-game. Save it in your
Documents\My Games\Underrail\
.
- This CustomConfig.xml lets you see the zone name by holding Alt in-game. Save it in your
- Category:Portraits for NPC portraits (☑ complete)
- Category:Portrait backgrounds for NPC portraits (☑ complete)
- Category:In-game models for in-game models of NPCs/mobs (☐ incomplete)
- Category:Sprites for transparent generic sprites (☑ complete)
- Category:Player sprites for player sprites with different armor suits (☑ complete)
- Category:Vehicle sprites for vehicle sprites (☑ complete)
- Category:Quest images for quest infobox images (☑ complete)
- Category:Item icons for item icons (☑ complete)
Quality assurance
This wiki uses MediaWiki File cache, which serves pages to anonymous visitors directly from file cache instead of generating them on every page load. This has the downside that category listings are updated to anonymous visitors only when the category page is edited (practically never) or its cache is purged manually. Thus, category pages should be manually purged after adding content to said category.
- Purging can be done by appending
&action=purge
to any url. (Eg. https://www.underrail.com/wiki/index.php?title=Underrail_Wiki:Community_portal&action=purge)
And the usual wiki cleanup stuff:
- Tag dubious information with
{{verify}}
or help verify information in existing articles. - Tag outdated articles with
{{outdated}}
or help update any outdated articles. - Tag short articles with
{{stub}}
or help expand some article stubs. - Single sections in need of expansion can be marked with
{{expand section}}
or you can help with articles that need expansion. - Mark pages for deletion with
{{delete}}
or help improve some candidates for deletion. - Check article content for typos and/or bad grammar. Any typos present in the game need not be reproduced in the wiki, instead report them here
- Improve syntax/formatting as you see fit.
- Add pages to correct categories by adding
[[Category:Category's name]]
on the page. - Check for any internal links to disambiguation pages and fix them.
- Create some links on dead end pages and create links to some orphaned pages.
- Fix any double redirects by redirecting the first page to the third page. Also check for broken redirects and fix them.
- Most of the above are either at Special:SpecialPages or Category:Site maintenance.
Want to discuss something?
- If you want to discuss anything specific to an article, you can use the talk page for that article.
- Also check the wiki thread on forums!
- The official Underrail discord also has a channel for wiki.
- If you need an admin, drop a message on epeli's talk page or PM via the forums. (If urgent, use forums or directly contact Styg.)