Editing Wiki Help

This page will be a help for editing the wiki pages on the Good Company Wiki.

This will not cover the usual Media Wiki stuff, rather it will expect that you even know already some basics.

If you want to inform yourself about formatting and handling Mediawiki articles in general, please visit the Help section of it.


* https://www.mediawiki.org/wiki/Category:Help
** https://www.mediawiki.org/wiki/Help:Links
** https://www.mediawiki.org/wiki/Help:Formatting
** https://www.mediawiki.org/wiki/Help:Images


The administration of this Wiki is done officially by the Chasing Carrot team. If aside from content discussion you want to have an exchange about the wiki, visit us on our Discord: https://discord.gg/goodcompany


== Good Company Replacements ==

Those are very specific replacements done by a script that handles additional tags after initial parsing. It used sources from the game itself and if maintained with up-to-date data exports can be easily used to fill in for some content that would require manual texting and linking.

What it can generally do:

* Use game text
* Use game icons
* Display info with icon and link from the game
* Get very specific game data

We'll expand on the data that can be used with the system.



=== Localization Files ===

Contents from localization files can be used by using <code>[t:<textkey>]</code>

This will take the localization directly from game files. This does currently do not support multi-language support as the wiki is currently only in English.


<span class="example>Example: [<b></b>t:itm_plastic] => [t:itm_plastic]</span>


If there are any icons used in the text, they will be automatically replaced. But please note, the script will (not yet) take care of all replacement parameters used in Good Company.

What already works is modifications on story texts:

{| class="wikitable"
|-
|Original Text Content
|colspan="2"|<samp>[<b></b>portrait:portraits/kerry_normal3][<b></b>n:campaign_speech_kerry]The last step is to select the item you want to have crafted. Currently, we only have [<b></b>s:icons_modules/itm_plastic_case] Plastic Case available. Please select it.</samp>
|-
|Normal
|<code>[<b></b>t:campaign1_ms3_task3]</code>
|[t:campaign1_ms3_task3] 
|-
|Portrait
|<code>[<b></b>t:campaign1_ms3_task3:only_portrait]</code>
|[t:campaign1_ms3_task3:only_portrait] 
|-
|Without Portrait
|<code>[<b></b>t:campaign1_ms3_task3:remove_portrait]</code>
|[t:campaign1_ms3_task3:remove_portrait] 
|-
|Name
|<code>[<b></b>t:campaign1_ms3_task3:only_name]</code>
|[t:campaign1_ms3_task3:only_name] 
|-
|Without Name
|<code>[<b></b>t:campaign1_ms3_task3:<b>remove_name</b>]</code>
|[t:campaign1_ms3_task3:remove_name] 
|-
|Only Text
|<code>[<b></b>t:campaign1_ms3_task3:<b>only_text</b>]</code>
|[t:campaign1_ms3_task3:only_text] 
|}



=== Game Icons ===

In common cases if you are adding images into the wiki you may want to use the upload and image functions just as usual, but sometimes you may want to use Icons via replacements. This is usually used by other replacements to make the icons in text keys or data sets usable. 

The advantage of using the game icons is that they have the same path just as the game and can be easily used when processing a lot of data. They can also be used in links and such. The drawback is that they must be uploaded by someone with VPN access and can't be used from the normal file upload and you have less customization options.


<span class="example>Example: [<b></b>s:icons_materials/itm_plastic] => [s:icons_materials/itm_plastic]</span>


The icons offer some options for a parameter to modify the display:


{| class="wikitable"
|-
|(default)
|<code>[<b></b>s:icons_materials/itm_plastic]</code>
|[s:icons_materials/itm_plastic]
|-
|smaller/--/xs
|<code>[<b></b>s:icons_materials/itm_plastic:smaller]</code>
|[s:icons_materials/itm_plastic:smaller]
|-
|small/-/s
|<code>[<b></b>s:icons_materials/itm_plastic:-]</code>
|[s:icons_materials/itm_plastic:-]
|-
|medium/m
|<code>[<b></b>s:icons_materials/itm_plastic:m]</code>
|[s:icons_materials/itm_plastic:m]
|-
|big/+/l
|<code>[<b></b>s:icons_materials/itm_plastic:big]</code>
|[s:icons_materials/itm_plastic:big]
|-
|bigger/++/xl
|<code>[<b></b>s:icons_materials/itm_plastic:++]</code>
|[s:icons_materials/itm_plastic:++]
|-
|giant/+++/xxl
|<code>[<b></b>s:icons_materials/itm_plastic:xxl]</code>
|[s:icons_materials/itm_plastic:xxl]
|-
|portrait_small/ps
|<code>[<b></b>s:portraits/kerry_normal1:ps]</code>
|[s:portraits/kerry_normal1:ps]
|-
|portrait/pm
|<code>[<b></b>s:portraits/kerry_normal1:portrait]</code>
|[s:portraits/kerry_normal1:portrait]
|-
|portrait_large/pl
|<code>[<b></b>s:portraits/kerry_normal1:pl]</code>
|[s:portraits/kerry_normal1:pl]
|-
|portrait_larger/pxl
|<code>[<b></b>s:portraits/kerry_normal1:pxl]</code>
|[s:portraits/kerry_normal1:pxl]
|}



=== Info Replacements ===

Info replacements take things like items and objects, and makes a linked representation with the icon and the name localized through the localization files out if it. This works potentially for all data that have icon and loca_strings as identifier.


<span class="example>Example: [<b></b>item:icons_materials/itm_plastic] => [item:icons_materials/itm_plastic]</span>


Right now there are exported files available for:

{| class="wikitable"
!type
!tag
!file
!example
!result
|-
|Materials & Modules
|item
|[https://wiki.goodcompanygame.com/gamedb/gamedata/materials.json materials.json]
|<code>[<b></b>item:itm_plastic]</code>
|[item:itm_plastic]
|-
|Tables & Dekos
|object
|[https://wiki.goodcompanygame.com/gamedb/gamedata/equipment.json equipment.json]
|<code>[<b></b>object:bld_assembly_tier01]</code>
|[object:bld_assembly_tier01]
|}


For the info replacement there are also some modifiers that can be applied in any order. They will alter the display of an entry.

{| class="wikitable"
|-
|<code>type=text</code>
|only display the text
|<code>[<b></b>item:itm_plastic:type=text]</code>
|[item:itm_plastic:type=text]
|-
|<code>type=icon</code>
|only the icon + tooltip
|<code>[<b></b>item:itm_plastic:type=icon]</code>
|[item:itm_plastic:type=icon]
|-
|<code>notip/code>
|does not show tips
|<code>[<b></b>item:itm_plastic:type=icon:notip]</code>
|[item:itm_plastic:icon:notip]
|-
|<code>icon_class=?</code>
|sets another html class
|<code>[<b></b>item:itm_plastic:icon_class=gc_icon_big]</code>
|[item:itm_plastic:icon_class=gc_icon_big]
|-
|<code>nolink</code>
|does not link info
|<code>[<b></b>item:itm_plastic:nolink]</code>
|[item:itm_plastic:nolink]
|}



=== Data Replacements ===

Data replacements use the exact same files just as the info replacements, but instead you can pick a certain information and get that display. For example you could get the stack size of an item.

<code>[<b></b>itemdata:itm_plastic:stack_size]</code> => [itemdata:itm_plastic:stack_size]


----

This can in theory retrieve data into endless depths, but of course the data files are not that deep. But for example you could get the identifier of an input material:

<code>[<b></b>itemdata:itm_plastic:input_materials:0:loca_string]</code> => [itemdata:itm_7segment_display:input_materials:0:loca_string]

Note: Arrays always start at 0!


----

And if that seems fancy: It is possible to chain replacements. First data is grabbed, then the info replacements. This happens twice and after that come localization and finally icon replacements.

<code>[<b></b>t:[<b></b>itemdata:itm_7segment_display:input_materials:0:loca_string]]</code> => [t:[itemdata:itm_7segment_display:input_materials:0:loca_string]]

<code>[<b></b>item:[<b></b>itemdata:itm_7segment_display:input_materials:0:loca_string]]</code> => [item:[itemdata:itm_7segment_display:input_materials:0:loca_string]]


----

In case you try to fetch data that does not exist, the replacement will remove the replacement from the page and display nothing instead. This may proof useful when mass copying certain stuff into fixed tables, but might cause issues if further digging into data is based of it.

<code>[<b></b>itemdata:itm_plastic:input_materials:0:loca_string]</code> => [itemdata:itm_plastic:input_materials:0:loca_string]

<code>[<b></b>itemdata:itm_7segment_display:input_materials:2:loca_string]</code> => [itemdata:itm_7segment_display:input_materials:2:loca_string]


----

Last but not least: If you try to access an array or class through this, instead of getting the data placed, you will only get a true in return.

<code>Can be crafted: [<b></b>itemdata:itm_plastic:input_materials]</code> => Can be crafted: [itemdata:itm_plastic:input_materials]

<code>Can be crafted: [<b></b>itemdata:itm_7segment_display:input_materials]</code> => Can be crafted: [itemdata:itm_7segment_display:input_materials]