Difference between revisions of "Underrail Wiki:Community portal"

From Underrail Wiki
Jump to navigation Jump to search
 
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{Registration guide}}
 
{{Registration guide}}
−
'''Welcome to {{SITENAME}}!''' The Community Portal hosts a "state of the wiki" list. Check the forums' [http://underrail.com/forums/index.php?topic=290.0 wiki thread] for additional community discussion.
+
'''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.  
  
−
= Contributing to the wiki =
+
== 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!
 
There are many ways in which you can help. Don't be afraid to edit and create articles!
  
−
== Improving existing 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.
−
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.
 
−
* 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.
 
−
* Few quality-scaling components 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.
 
−
* Some moving and renaming will be necessary once certain areas get official names.
 
 
|-
 
|-
−
| [[Skills]]
+
!colspan="2"| Wikifying progress by game
−
| {{color|gray|☐ Basics}} ||
 
−
* Many of the pages for individual skills have lists that need expansion.
 
−
* Skills page itself could use better formatting?
 
 
|-
 
|-
−
| [[Characters]], [[Enemies]]
+
| ''Underrail'' base game || [[Underrail Wiki: Base game status]]
−
| {{color|gray|☐ meh...}} ||
 
−
* 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 lac most infobox data.
 
−
* New pages also required, see [[#Creating new pages]] below.
 
 
|-
 
|-
−
| [[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.
 
 
|}
 
|}
  
−
== Creating new pages ==
+
If you undertake a big project to update one of the areas that's in bad shape, please update those pages accordingly once your work is done.
−
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!
+
 
 +
== 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]]. Image categories are listed for each game in their "state of wiki" pages above.
  
−
{| class="wikitable" width="100%"
 
−
|-
 
−
! 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.
 
−
* See [[:Category:Item icons]] and subcats for already uploaded item icons.
 
−
* [[Template:ComponentGroup]] will also be helpful if you're working with blueprint/component pages
 
−
* Similarly, [[Template:AmmoGroup]] for weapon/ammo pages
 
−
|-
 
−
| [[Characters]], [[Enemies]]
 
−
| WIP
 
−
| [[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)''
 
−
|}
 
  
−
== Uploading images ==
+
'''Icons''' (export from game resources)
−
See [[:File:Misc icon.png#filelinks]] for pages that still lack images
+
* 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.
 +
 
 +
'''Portraits''' (export from game resources)
 +
* Can be extracted from game resources at <code>\Underrail\Data\Portraits\</code> with XNB tools.
  
−
; Screenshots and editing!
+
'''NPCs''' (screenshotting/export from game resources)
−
* Icons should be 33x33 PNG or few px larger, with transparent background
+
* NPC/mob models should be minimum '''100x100px''' or taller as required, similar in size with the portrait next to it in the infobox.
−
* NPC/mob models should be roughly 100x100px or a bit larger, similar in size with the portrait next to it
 
 
** Unique NPCs can use cropped screenshots to illustrate their surroundings
 
** Unique NPCs can use cropped screenshots to illustrate their surroundings
−
** Generic NPCs and mobs are better off with transparent background
+
** Mobs and generic NPCs are better off with generic sprite, transparent background. These you can get from <code>\Underrail\Data\Locale\Creatures\</code> subfolders.
−
* Quests infobox supports 300x200 images, can be a key event or point of interest in the quest
+
 
−
* Every area should have a map image, preferably transparent, fully explored and without visible NPCs
+
'''Locations''' (screenshotting)
−
** Most zones have their map images in the wiki, check [[Zones]] for image redlinks.
+
* 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]].
 +
*** 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 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>.
 +
 
 +
'''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.
 +
 
  
−
; Image categories
+
That covers the common image types. Other images are welcome as well, use your own judgement where and how to use them.
−
* [[:Category:Images]] is the root category.
 
−
** [[: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|green|☑ complete}})
 
−
** [[:Category:Feat icons]] for feat icons ({{color|green|☑ complete}})
 
−
** [[:Category:Icons]] for all other icons - menus, abilities, status effects, etc ({{color|green|☑ complete}})
 
−
** [[:Category:Maps]] for area screenshots (incomplete)
 
−
** [[: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 (incomplete)
 
−
** [[:Category:Sprites]] for transparent generic sprites ({{color|green|☑ complete}})
 
−
*** [[:Category:Player sprites]] for player sprites with different armor suits
 
−
*** [[:Category:Vehicle sprites]] for vehicle sprites
 
−
** [[: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]]'''.
Line 163: Line 61:
 
* Single sections in need of expansion can be marked with <code>{{t|expand section}}</code> or you can help with '''[[:Category:Needs expansion|articles that need expansion]]'''.
 
* Single sections in need of expansion can be marked with <code>{{t|expand section}}</code> or you can help with '''[[:Category:Needs expansion|articles that need expansion]]'''.
 
* Mark pages for deletion with <code>{{t|delete}}</code> or help improve some '''[[:Category:Candidates for deletion|candidates for deletion]]'''.
 
* Mark pages for deletion with <code>{{t|delete}}</code> or help improve some '''[[:Category:Candidates for deletion|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 [http://underrail.com/forums/index.php?topic=241.0 report them here]
+
* Check article content for typos and/or bad grammar.
 +
** Any typos present in the game need not be reproduced in the wiki, instead [http://underrail.com/forums/index.php?topic=241.0 report them here]. This applies to games that are still in active development and receiving updates.
 
* Improve syntax/formatting as you see fit.  
 
* Improve syntax/formatting as you see fit.  
−
* Add pages to correct categories by adding <code><nowiki>[[Category:Category's name]]</nowiki></code> on the page.
+
* Add pages to correct categories by adding <code><nowiki>[[Category:Category's name]]</nowiki></code> on the page. See '''[[Special:UncategorizedPages|uncategorized pages]]'''. Also check for any '''[[Special:UncategorizedFiles|uncategorized images]]''' and categorize them appropriately.
−
* Check for any internal links to '''[[Special:Disambiguations|disambiguation]]''' pages and fix them.
+
* Articles with missing images can be found through '''[[Special:WhatLinksHere/File:misc_icon.png|Links to misc_icon.png]]''' or '''[[:Category:Pages with broken file links|Pages with broken file links]]'''.
 +
* Check for any internal links to '''[[:Category:Disambiguation pages|disambiguation pages]]''' and fix them.
 
* Create some links on '''[[Special:DeadendPages|dead end pages]]''' and create links to some '''[[Special:LonelyPages|orphaned pages]]'''.
 
* Create some links on '''[[Special:DeadendPages|dead end pages]]''' and create links to some '''[[Special:LonelyPages|orphaned pages]]'''.
 
* Fix any '''[[Special:DoubleRedirects|double redirects]]''' by redirecting the first page to the third page. Also check for '''[[Special:BrokenRedirects|broken redirects]]''' and fix them.
 
* Fix any '''[[Special:DoubleRedirects|double redirects]]''' by redirecting the first page to the third page. Also check for '''[[Special:BrokenRedirects|broken redirects]]''' and fix them.
 +
* Most of the above are either at '''[[Special:SpecialPages]]''' or '''[[:Category:Site maintenance]]'''.
  
−
= Want to discuss stuff? =
+
== Want to discuss something? ==
 
* If you want to discuss anything specific to an article, you can use '''the talk page''' for that article.
 
* If you want to discuss anything specific to an article, you can use '''the talk page''' for that article.
 
* Also check [http://underrail.com/forums/index.php?topic=290.0 the wiki thread] on forums!
 
* Also check [http://underrail.com/forums/index.php?topic=290.0 the wiki thread] on forums!
 +
* The official [https://discord.gg/5XXea6r Underrail discord] also has a channel for wiki.
 +
* If you need an admin, drop a message on [[User talk:PaposikG6|PaposikG6's talk page]] or PM via the forums or discord. (If urgent, you can directly contact Styg.)
  
  
 
[[Category:Community]]
 
[[Category:Community]]

Latest revision as of 08:20, 21 November 2023

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

If you undertake a big project to update one of the areas that's in bad shape, please update those pages accordingly once your work is done.

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. Image categories are listed for each game in their "state of wiki" pages above.


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.


That covers the common image types. Other images are welcome as well, use your own judgement where and how to use them.

Quality assurance

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

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 PaposikG6's talk page or PM via the forums or discord. (If urgent, you can directly contact Styg.)
Retrieved from "https://www.stygiansoftware.com/wiki/index.php?title=Underrail_Wiki:Community_portal&oldid=54302"