Difference between revisions of "Underrail Wiki:Community portal"

From Underrail Wiki
Jump to navigation Jump to search
m (→‎New pages: linked to random event navbox)
Line 1: Line 1:
 
{{Registration guide}}
 
{{Registration guide}}
−
'''Welcome to {{SITENAME}}!''' 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.
+
'''Welcome to {{SITENAME}}!''' The Community Portal is the portal for resources intended to wiki editors—style guides and overviews of the progress on wikifying the games.  
  
 
== Style guide ==
 
== Style guide ==
−
We don't have strict style policies. Generally, editors should follow common sense. When in doubt, [[wikipedia:WP:MOS|Wikipedia Manual of Style]] is a good resource for all things wiki style.
+
See [[Underrail Wiki:Style guide]].
  
−
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.
+
The gist of it is that we don't have strict style guides. Loosely following Wikipedia's MOS works for the most part. Editors are encouraged to follow style set by existing articles of same type; It is often the easiest way to get things done.
−
 
 
−
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.
 
−
 
 
−
Below are a 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.
 
−
* [[:Category:Portraits|Portraits]] and [[:Category:Portrait backgrounds|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:
 
−
* {{t|spoiler warning}} for adding a large spoiler warning on top of articles that are basically full of spoilers.
 
−
* {{t|spoiler}} for short inline spoiler text for use anywhere - middle of body text, infobox parameters, etc.
 
−
* {{t|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 <nowiki><sup></nowiki> 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 ==
 
== State of the wiki ==
 
There are many ways in which you can help. Don't be afraid to edit and create articles!
 
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.
+
These links contains state of each game on the wiki, along with links to all infoboxes, navboxes and other resources you need. There's plenty of work to be done in all of them.
−
 
 
−
=== Existing articles ===
 
−
Loosely ordered by overall status; from good to bad.
 
  
−
{| class="wikitable" width="100%"
+
{| class="wikitable"
−
|-
 
−
! Major page group
 
−
! Progress
 
−
! Things to do
 
−
|-
 
−
| [[:Category:Navbox templates|navboxes]] / lists
 
−
| {{color|green|☑ Good}} ||
 
−
* Add anything that's missing. Navboxes can be edited via the <code>v-d-e</code> links in their upper left corner.
 
−
|-
 
−
| [[Feats]]
 
−
| {{color|green|☑ Good}} ||
 
−
* Additional detailed explanations should be added if game mechanics are ambiguous, or if the feat description omits some information.
 
−
|-
 
−
| [[Items]]
 
−
| {{color|green|☑ Ok}} ||
 
−
* Major item pages like the main weapon and armor variations need more comprehensive example sets and more detailed write-up.
 
−
* Oddity locations need to be checked and detailed
 
−
* <s>Pages in [[:Category:Components with example stats]] need to be updated with their stat ranges. Tabbed item infoboxes be edited via the <code>v-d-e</code> links in their upper right corner.</s>
 
−
* Gun frames and metals lack [[Template:Quality table]].
 
−
|-
 
−
| [[Psi abilities]], [[Abilities]], [[Status effects]]
 
−
| {{color|green|☑ Ok}} ||
 
−
* Explain ambiguous game mechanics
 
−
* Add scaling information if necessary
 
−
* Check if relevant lists include everything they should
 
−
|-
 
−
| [[Quests]]
 
−
| {{color|gray|☐ Basics}} ||
 
−
* Some walkthroughs miss entire quest paths or are outdated.
 
−
* Walkthrus may also need different routes for different character skillsets.
 
−
* Pages with long walkthrus should be split into tldr and detailed version; see [[Old man Nosek]].
 
−
|-
 
−
| [[Locations]]
 
−
| {{color|gray|☐ Basics}} ||
 
−
* Detail pages; many have short sections or are stubs/redirects.
 
−
* Body text for most locations could use additional write-up.
 
 
|-
 
|-
−
| [[Skills]], [[Base Abilities]], [[Combat Stats]]
+
!colspan="2"| Wikifying progress by game
−
| {{color|gray|☐ Basics}} ||
 
−
* Many of the pages for individual skills have lists that need expansion.
 
−
* Game mechanics research: precision
 
 
|-
 
|-
−
| [[Characters]], [[Enemies]]
+
| ''Underrail'' base game || [[Underrail Wiki: Base game status]]
−
| {{color|gray|☐ Basics}} ||
 
−
* Many pages lack minimal level of body text.
 
−
* For enemies: rewrite or at least improve fluff text and fighting tips.
 
−
* Pages in [[:Category:Characters without health]] probably lack most infobox data.
 
 
|-
 
|-
−
| [[Factions]]
+
| ''Underrail: Expedition'' expansion || [[Underrail Wiki: Project Expedition]]
−
| {{color|red|☒ Bad}} ||
 
−
* Detail individual pages; these are really lacking in story/lore details.
 
−
* The main factions page needs to be improved too.
 
 
|}
 
|}
  
−
=== New pages ===
+
== About images ==
−
Overall status: Practically 100% of base game content up to version [[1.0.2.4]] has pages the wiki!
+
Some conventions, tips and tools for editing and uploading images. Some assets are best exported from game files, others created from screenshots taken while playing. How to name your files is discussed at [[Underrail Wiki: Style guide#Naming]].
  
−
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!
+
'''Icons''' (export from game resources)
 +
* Icons should be '''33x33px''' PNG, with transparent background and correct transparency.
 +
* Can be extracted from game resources at <code>\Underrail\Data\Icons\</code> with XNB tools.
  
−
{| class="wikitable" width="100%"
+
'''Portraits''' (export from game resources)
−
|-
+
* Can be extracted from game resources at <code>\Underrail\Data\Portraits\</code> with XNB tools.
−
! Major article group
 
−
! Progress
 
−
! Infobox and documention
 
−
! Navboxes (should link to all pages)
 
−
! Notes / other resources
 
−
|-
 
−
| [[Quests]]
 
−
| {{color|green|☑ Good}}
 
−
| [[Template:Quest Infobox|Quest Infobox]]
 
−
| [[Template:Missions navbox|Missions navbox]]
 
−
| Existing quest pages can be used as references, though there is much room for improvement in walkthroughs.
 
−
|-
 
−
| [[Items]]
 
−
| {{color|green|☑ Good}}
 
−
| [[Template:Infobox item|Infobox item]]
 
−
| Most of [[:Category:Navbox templates]]
 
−
| Use existing item pages for reference, but longer body text is welcome.
 
−
* [[Template:ComponentGroup]] will also be helpful if you're working with blueprint/component pages
 
−
* Similarly, [[Template:AmmoGroup]] for weapon/ammo pages
 
−
|-
 
−
| [[Characters]], [[Enemies]]
 
−
| {{color|green|☑ Good}}
 
−
| [[Template:Character Infobox|Character Infobox]]
 
−
| [[Template:NPCs navbox|NPCs]], [[:Template:Mentioned characters navbox|mentioned characters]], [[:Template:Minor NPCs navbox|minor NPCs]] and [[:Template:Enemies navbox|enemies]]
 
−
| Existing pages can be used as references, though many are stubs.
 
−
* [[:Category:Portraits]] and [[:Category:Portrait backgrounds]] have all the portraits
 
−
* [[:Category:In-game models]] for important NPC pictures
 
−
* [[:Category:Sprites]] and subcats for generic sprites with transparent background
 
−
|-
 
−
| [[Locations]]
 
−
| {{color|green|☑ Good}}
 
−
| [[Template:Location Infobox|Location Infobox]]
 
−
| [[Template:Locations navbox|Locations navbox]]
 
−
|
 
−
* [[Zones]] lists every zone file, its article and map screenshot
 
−
* Every zone should have its own detailed article later on, for now locations only have larger common pages
 
−
|-
 
−
| [[Feats]]
 
−
| {{color|green|☑ Good}}
 
−
| [[Template:Feat Infobox|Feat Infobox]]
 
−
| [[Template:Feats navbox|Feats navbox]]
 
−
| Use existing pages for reference.
 
−
|-
 
−
| [[:Category:Abilities|Abilities]]
 
−
| {{color|green|☑ Good}}
 
−
| [[Template:Ability Infobox|Ability Infobox]]
 
−
| [[Template:Abilities navbox|Abilities navbox]], [[Template:Psi 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.
 
−
|-
 
−
| [[:Category:Status effects|Status effects]]
 
−
| {{color|green|☑ Good}}
 
−
| [[Template:Ability Infobox|Ability Infobox]]
 
−
| [[Template:Status effect navbox|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)''
 
−
|-
 
−
| [[:Category:Random events|Random events]]
 
−
| {{color|green|☑ Good}}
 
−
| None (yet)
 
−
| [[Template:Random events navbox|Random events navbox]]
 
−
| Given their random nature and other factors, documenting these will be an ongoing long-term process.
 
−
|}
 
  
−
=== Uploading images ===
+
'''NPCs''' (screenshotting/export from game resources)
 +
* 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. These you can get from <code>\Underrail\Data\Locale\Creatures\</code> subfolders.
  
−
==== Screenshots and editing ====
+
'''Locations''' (screenshotting)
−
* 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.
 
* 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 [[:Category:Maps|global map]].
 
** Articles for large areas with their own global map (eg. [[Foundry]], [[Upper Underrail]]) should use a screenshot of the [[:Category:Maps|global map]].
 +
*** See [[Underrail Wiki: Imagemap guide]] for how to make clickable imagemaps out of them.
 
** Articles for areas spanning multiple zones, but no global map, should use a [[:Category:Screenshots|screenshot]].
 
** Articles for areas spanning multiple zones, but no global map, should use a [[:Category:Screenshots|screenshot]].
 
** Articles for single zone can just use a full [[:Category:Zone screenshots|zone screenshot]].
 
** Articles for single zone can just use a full [[:Category:Zone screenshots|zone screenshot]].
 +
* This [https://underrail.info/junk/CustomConfig.xml CustomConfig.xml] lets you see the zone name by holding '''Alt''' in-game. Save it in your <code>Documents\My Games\Underrail\</code>.
  
−
==== Image categories ====
+
'''Other''' (screenshotting)
−
* [[:Category:Images]] is the root category.
+
* Quests infobox supports '''300x200px''' images (or larger with same aspect ratio), can be a key event or point of interest in the quest.
−
** [[:Category:Item icons]] for item icons ({{color|green|☑ complete}})
 
−
*** [[:Category:Armor icons]] for armor icons ({{color|green|☑ complete}})
 
−
*** [[:Category:Oddity icons]] for oddity icons ({{color|green|☑ complete}})
 
−
*** [[:Category:Weapon icons]] for weapon icons ({{color|red|☐  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 ({{color|green|☑ complete}})
 
−
** [[:Category:Icons]] for all other icons - menus, abilities, status effects, etc ({{color|green|☑ complete}})
 
−
** [[:Category:Furniture]] for player house furniture ({{color|green|☑ complete}})
 
−
** [[:Category:Maps]] for global map view screenshots ({{color|red|☐  incomplete}})
 
−
** [[:Category:Zone screenshots]] for area screenshots - see also [[Zones]] ({{color|red|☐  incomplete}}, missing new waterways)
 
−
*** This [https://underrail.info/junk/CustomConfig.xml CustomConfig.xml] lets you see the zone name by holding '''Alt''' in-game. Save it in your <code>Documents\My Games\Underrail\</code>.
 
−
** [[:Category:Portraits]] for NPC portraits ({{color|green|☑ complete}})
 
−
*** [[:Category:Portrait backgrounds]] for NPC portraits ({{color|green|☑ complete}})
 
−
** [[:Category:In-game models]] for in-game models of NPCs/mobs ({{color|red|☐  incomplete}})
 
−
** [[:Category:Sprites]] for transparent generic sprites ({{color|green|☑ complete}})
 
−
*** [[:Category:Player sprites]] for player sprites with different armor suits ({{color|green|☑ complete}})
 
−
*** [[:Category:Vehicle sprites]] for vehicle sprites ({{color|green|☑ complete}})
 
−
** [[:Category:Quest images]] for quest infobox images ({{color|green|☑ complete}})
 
  
−
=== Quality assurance ===
+
== Quality assurance ==
  
−
The usual wiki cleanup stuff:
+
There's always the usual wiki cleanup stuff to be done:
 
* Tag dubious information with <code>{{t|verify}}</code> or help '''[[:Category:Verify|verify]]''' information in existing articles.
 
* Tag dubious information with <code>{{t|verify}}</code> or help '''[[:Category:Verify|verify]]''' information in existing articles.
 
* Tag outdated articles with <code>{{t|outdated}}</code> or help update any '''[[:Category:Outdated articles|outdated articles]]'''.
 
* Tag outdated articles with <code>{{t|outdated}}</code> or help update any '''[[:Category:Outdated articles|outdated articles]]'''.

Revision as of 01:28, 18 October 2020

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 is the portal for resources intended to wiki editors—style guides and overviews of the progress on wikifying the games.

Style guide

See Underrail Wiki:Style guide.

The gist of it is that we don't have strict style guides. Loosely following Wikipedia's MOS works for the most part. Editors are encouraged to follow style set by existing articles of same type; It is often the easiest way to get things done.

State of the wiki

There are many ways in which you can help. Don't be afraid to edit and create articles!

These links contains state of each game on the wiki, along with links to all infoboxes, navboxes and other resources you need. There's plenty of work to be done in all of them.

Wikifying progress by game
Underrail base game Underrail Wiki: Base game status
Underrail: Expedition expansion Underrail Wiki: Project Expedition

About images

Some conventions, tips and tools for editing and uploading images. Some assets are best exported from game files, others created from screenshots taken while playing. How to name your files is discussed at Underrail Wiki: Style guide#Naming.

Icons (export from game resources)

  • Icons should be 33x33px PNG, with transparent background and correct transparency.
  • Can be extracted from game resources at \Underrail\Data\Icons\ with XNB tools.

Portraits (export from game resources)

  • Can be extracted from game resources at \Underrail\Data\Portraits\ with XNB tools.

NPCs (screenshotting/export from game resources)

  • 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. These you can get from \Underrail\Data\Locale\Creatures\ subfolders.

Locations (screenshotting)

  • Location infobox looks best with 1.5:1 or higher aspect ratio image, width is limited to 300px.
  • This CustomConfig.xml lets you see the zone name by holding Alt in-game. Save it in your Documents\My Games\Underrail\.

Other (screenshotting)

  • Quests infobox supports 300x200px images (or larger with same aspect ratio), can be a key event or point of interest in the quest.

Quality assurance

There's always the usual wiki cleanup stuff to be done:

Want to discuss something?

Retrieved from "https://www.stygiansoftware.com/wiki/index.php?title=Underrail_Wiki:Community_portal&oldid=43459"