Difference between revisions of "TerraFirmaCraft:How To Contribute"
(→New versions of images not updating?) |
m |
||
| Line 121: | Line 121: | ||
so as you can see, pretty """""simple"""""" | so as you can see, pretty """""simple"""""" | ||
| + | |||
| + | == Changelog and confirmed upcoming features == | ||
| + | |||
| + | If Dunk confirms an addition, change, or fix in a future update, you can add it to the commented section (<code><nowiki><!-- This is a comment --></nowiki></code>) of wikicode on the changelog page. When the new version comes out, it will be there ready to move into the visible part of the article. | ||
{{Blocks}} | {{Blocks}} | ||
Revision as of 07:19, 25 September 2019
This article aims to aid new editors with starting to edit the TFC+ wiki. Please feel free to add your own notes, as long as they aren't obvious.
Contents
Note about using search bars on special wiki pages
File search (eg: the search box on Special:ListFiles) is broken. This is a long-standing bug with the wiki software. The way to work around it is to drop the first letter from your search term. So if you want to find "linen", search for "inen" instead. :/
Creating A New Page
Remember to include {{Blocks}} at the end of the page. This adds the Navigation menu.
Knapping Template
Here is the blank knapping template:
{{Knapping
|A1= |B1= |C1= |D1= |E1=
|A2= |B2= |C2= |D2= |E2=
|A3= |B3= |C3= |D3= |E3=
|A4= |B4= |C4= |D4= |E4=
|A5= |B5= |C5= |D5= |E5=
|Output=
}}
Materials used in knapping template have "Flat" in the filename. ex: Flat Straw, Flat Leather, Flat Linen, etc. Just add the name of the material next to the cell you want it displayed in. For example:
{{Knapping
|A1= Flat Straw |B1= |C1= |D1= |E1= Flat Straw
|A2= Flat Straw |B2= |C2= |D2= |E2= Flat Straw
|A3= Flat Straw |B3= |C3= |D3= |E3= Flat Straw
|A4= Flat Straw |B4= |C4= |D4= |E4= Flat Straw
|A5= Flat Straw |B5= Flat Straw |C5= Flat Straw |D5= Flat Straw |E5= Flat Straw
|Output= Straw Basket}}
results in:
|
|
|
|
|
|
|
|
|
|
|
|
| ||
|
|
|
|
|
| ||
|
|
|
|
|
| ||
|
|
|
|
|
|
There is another version of the template that begins {{Grid/Knapping that's sometimes used on the wiki when there are alternate knapping recipes. This template allows the pattern to animate, but it is buggy: it resizes the alt textures to 32px). In the few cases there are two knapping recipes for something, it's usually swapping materials as a whole (wolf fur vs bear fur) or it's mirroring the pattern (clay axe mold). It might be better to just make a note in the text instead.
Alternate outputs can be animated by listing them in the appropriate space separated by a semicolon. To add a number to the output, follow the name with a comma and the number.
Recipe Template
Certain recipes need to be displayed multiple places across the wiki and it can be tedious to keep typing out the recipe grids. Even if you copy/past, there will be problems making sure you find every instance of the recipe if it changes.
I'm experimenting with a Recipe Template to hold those item's recipe grids in its subpages. This allows the recipe to be easily transcluded into guides like Stone-Age Guide or pages such as Differences from TFC or Crafting Differences. This would mean a recipe's knapping grid or inventory crafting grid would be at Template:Recipe/ItemName and invoked by adding{{Recipe/ItemName}} to a page. Changes made to the recipe subpage would be reflected anywhere it is invoked. See the Recipe Template for documentation and a list of recipes. See the wikicode in this section of the Stone-Age Guide for a live example.
Uploading Images
Finding Images
The textures can be found in the mod folder (or unzipped jar) under \assets\terrafirmacraftplus\textures.
Resizing
When you scale them up set interpolation to none or nearest neighbor to keep the pixel edges clean. For batch editing, I use the BIMP 2.0 extension for GIMP 2.10 to scale a whole folder of images.
Naming Conventions
Files names should have the first letter of each word capitalized. The exception is when ProPick is used. Spaces and underscores are interchangeable. ex: Foo Bar.png or Foo_Bar.png not Foo bar.png.
Sizes
Items may need to be uploaded in two versions:
A 32x32 px with the naming convention: Grid_Item.png is used for items in [crafting grid templates.]
A 36x36 px with the naming convention: Grid_Flat_Item.png is used for knapping materials.
A 150x150 px (or as close as possible) with the naming convention: Item.png is used in the block info template for an item's individual wiki page. A gif can be used instead of a png for the larger item image. Use a frame delay of 2000 ms.
New versions of images not updating?
If you upload a new version of an image and it is displaying the old version, open the direct link to the image and append ?action=purge to the url (but before any #) and hit enter. This might fix it.
Other times it's on your side and you need to do a hard refresh (shift+F5, or Ctrl-F5, etc.)
If an article renders an image as missing, you may have to edit and save the page or section without making changes to tell the wiki server to rebuild the page.
Displaying uploaded images on a page
[[ Image:Image.jpg | frame(or thumb) | position | 300px | caption ]]
Page markers
These templates add a message indicating the status of the page:
- Template:NeedsUpdating ({{NeedsUpdating}}) - For pages which have information that need to be updated to match TFC+.
- Template:Stub ({{Stub}}) - For pages that are extremely short and need expanding.
- Template:Wip ({{Wip}}) - For pages that are not completely done.
Creating new grid templates
If there isn't already a template created for a crafting method (ex: one had to be created for displaying sewing recipes) here are the steps to putting a new template together:
- copy the template table from another template and delete everything inside (other than the {| and |} rows)
- make a "header row" which will decide the widths for each column: it should look like
| width="36"| | width="36"| | width="36"| | width="50"| <- For example, if you want to leave a space between the inputs and the outputs | width="50"| <- The output grid.
(Wiki standard for Grid widths is 36)
- Make the grid rows. Use rowspan="" to decide how many rows they stretch across, if you want things below the table, for example. I suggest using a placeholder such as {{Grid|Raw Porkchop, 20}} for now, to prevent yourself from getting confused.
- Make the "arrow" - use rowspan="", align="", and colspan="" to align it.
- Make the output - use rowspan="2" for it to wrap over 2 rows of grid slots, for example. Wiki standard is Width=54
so as you can see, pretty """""simple""""""
Changelog and confirmed upcoming features
If Dunk confirms an addition, change, or fix in a future update, you can add it to the commented section (<!-- This is a comment -->) of wikicode on the changelog page. When the new version comes out, it will be there ready to move into the visible part of the article.
