Guides/Page Format Guide

From Modding Legacy Wiki
Revision as of 09:55, 18 October 2020 by Des (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

These format policies are based off the Aether Gamepedia's standards and thus based on of the official Minecraft wiki's. You may ask questions on the Official Discord or message Des if you need any help with anything on the wiki relating to formatting.

The guide does not have to be explicitly followed word for word (as there are exceptions to the following guidelines), but the desire here is to bring the wiki up to a consistent and clean style.

Further Examples

You can see this sandbox page for blocks and this sandbox page for mobs for an example page beyond examples listed here.

Text Formatting

Generally avoid using abbreviations of words, for example, use "do only what is needed" instead of "do only what's needed" or Blue Skies instead of BS, unless the usage is possessive as for the former.

Page Formatting

Introduction

The first word should be the page's name, and in bold, and using the, a, or an before it is generally improper. You can use the magicword {{PAGENAME}} as a trick/shortcut to automate things. Such usage implies an item is singular, which is most cases, is not true. There may be exceptions to the rule, but still. Using a plural title in the introduction is acceptable, if it is a page such as Leaves. Not overly fussy on some points though, so it shouldn't matter if a page addresses an example thing such as "is a type of" or "are a type of".

The opening paragraph of the page is intended to be very short and concise. All that should be explained is what type of object it is (block, item, mob, or other), and where it can be found in a mod if it cannot be crafted. You may note of any unusual qualities if possible, such as it's particularly overly rare, but do not state any other information unless it's not explained elsewhere and is crucial or functional use information.

Do not state it's crafting uses, as that information is redundant if it can found below in the Usage sub-section named Crafting ingredient, which will list it's associated crafting recipes. Do not put update history information in the introduction either, as those will go in History sections.

An example of an improper and proper introduction: This block is a mineral block. It used to be a stone-like material and not an ore.

To give you an idea of what it should look like, with the full possible info:

This block is a type of common ore block found in the mod name. It's primary use is for mod utility block.

Obtaining

State what tool (if not harvestable by hand) is used to mine it, for blocks. Try to use singular or plural indicatives depending on the item, such as for blocks that drop one item: a gemstone, or or for blocks that drop more than one item: ore blocks, i.e.

Breaking Times

Breaking times are based on a block's hardness, which can be found in a mod's gitlab src for blocks. To determine breaking times of an item accurately, use the equations listed below:

  • Hand: hardness * 1.5
  • Material 1 (Wood-equivalent): (hardness * 1.5) / 2
  • Material 2 (Stone-equivalent): (hardness * 1.5) / 4
  • Material 3 (Iron-equivalent): (hardness * 1.5) / 6
  • Material 4 (Diamond-equivalent): (hardness * 1.5) / 8

The results should be rounded to either the tenth or hundredth place as accurately to the original result, however there is no strict guideline on what numbers should be used in the tables. Looking through the Minecraft wiki's breaking time tables is the best reference for what to round to.

Natural generation

Any natural generation properties it may have.

Crafting/Smelting

Sections for how to craft an item.

Crafting GUI.png

Grid Crystal Sand.png

Grid Crystal Glass.png


Include an upcoming sub-section if the recipe changes in an Indev build. Upcoming uses two equal characters instead of three.

Usage

You may state its interaction with certain blocks and/or liquids if applicable, or if it has a smelting use as an ingredient and/or fuel. Crafting ingredient recipe infoboxes go here. The spacing (|A1=BlockName works, and so does |A1 = BlockName, but use the former to save room) and TemplateName does not matter, so you can just put Grid/Crafting Table instead of Template:Grid/Crafting Table.

Crafting ingredient

If there are multiple Crafting ingredient examples, try not to space them such as below:

Crafting GUI.png

Grid Crystal Sand.png

Grid Crystal Glass.png



Crafting GUI.png

Grid Crystal Sand.png

Grid Crystal Glass.png



Trivia

Trivia or tips goes here, and be sure to list such information here instead of other sections, especially the introducing paragraph.

Data values

The data values information goes here, and have the ID name and data value fields in the infobox redirect here. State it's ID name and data values, and what blocks and/or items it shares the ID name with, such as that Cobblestone shares its ID name with Mossy Cobblestone.

Be sure that the 16x16 icon matches the assets file name (such as crystal_sand) for ease of organization. If there are more than one associated assets (i.e, a crafting table variant as an example), choose the one that is generally the best representative image for the block.

You can find some information such as decimal data values and item ID names using the TellMe mod, specifically the "dump" command. The mod will dump the resulting text file(s) to .minecraft/config/tellme. The link can be found in #Resources.

Issues

Link to the mod's tracker here, and state to report issues for the item/block/mob/etc over there. Any mentions of bugs or anomalies should be omitted in favor of this. Also link to an indev tracker if possible.

History

History goes here, if it can be found via available changelogs and such.

Upcoming sub-sections also go here.

Gallery

Gallery images goes here. Try to make sure the available images are up to date, in terms of appearance in the current stable mod version and that their subject matter is centered and not a highly excessive resolution in widthxheight.

Navbox

Put navboxes at the very end of a page if suitable. Navboxes should be spaced, like so:

{{Blocks}}

Animated PNGs (APNG)

The browsers Mozilla, SeaMonkey, Iceweasel, Safari, Google Chrome, Chromium and Opera (v12 and earlier) can all see apng animations natively. The current versions of any browser besides those do not support apng animations at all, sadly. APNG is chosen over GIF because it supports 24-bit images (.gif animations have limited color palettes) and 8-bit transparency not available for GIFs. It is also easier on CPUs in mass amounts, leading to better page load times.

Animated PNGs can be used for having changing display images on a page. This is because some blocks are treated as a single block instead of two using data values (such as the multiple types of vanilla logs), and generally can be used interchangeably in crafting recipes where they can be used.

Methods of determining this, as well as info on how to create APNGs, can be found in #Resources.

Notice Templates

{{Upcoming}}
This contains content or features that may be part of the next release.
The content may have appeared in Development versions but the full update with these features has not had an official patch yet.
The content in this page is heavily subject to change.

This template is used on pages for upcoming releases. If any page is part of a release that has not had a full version released, then it is to be given this notice.

{{Stub}}
This page is a stub. You can help the Modding Legacy Wiki by editing the page.

This template is used on pages that don't have very much content on them and needs more information added to it.

{{Cleanup}}
Please help improve this if you can. The Discussion page may contain suggestions.

This template is used on pages that need their organization improved to better meet the standards of that page type based on other pages.

{{Unused}}
This page contains content that still exists but is inaccessible.
These features only exist via commands/creative mode/inv-editors or in the assets of this mod.

This template is used on pages for content that can't be accessed normally through a mod's content (and thus may only be seen via creative mode or commands) and is either only obtainable with commands or only found in the files.

{{Removed}}
This page contains content that is no longer in the mod.
These features only exist in previous versions of the Aether mod.

This template is used on pages for content that is not in the current version of a mod.

{{Disambig}}

Disambig.png This disambiguation page lists articles associated with the same title. If an internal link referred you here, you may wish to change the link to point directly to the intended article.

This template is used on disambiguation pages that link to multiple other pages from it that have similar names.

{{Old}}
This contains content or features that are outdated.
The content may have appeared in older mod versions. The content is no longer maintained and any issues with it will not be fixed.

This template is used on pages for content that is a part of a version of the mod that is no longer supported. This would mostly be used on pages pertaining to removed content or versions of mods below 1.14 (such as 1.12).

Resources

Making APNGs

APNGs can be made on sites like EZGif. The timing between each frame is always 100.

Gathering Data & Info

The TellMe mod can be used to determine various data such as Data Values, as well as info like block hardness.

Block hardness and mining speeds of a block are also most of the time the same as its Minecraft counterpart, if it has a Minecraft counterpart. Otherwise, using a stopwatch and estimating mining speeds by mining blocks can be used to get this data.

Creating Renders

The Block Renderer mod can be used render blocks and items to be used in #Infoboxes.

Recipes

In +1.12 versions, Minecraft's recipe book can be used to find recipes. Simply put an item into your inventory in creative mode to find any recipes for it.