Difference between revisions of "Template - Mods - XCOM:EU 2012"

From Nexus Mods Wiki
Jump to: navigation, search
(adjusted categories)
 
(3 intermediate revisions by the same user not shown)
Line 18: Line 18:
  
 
Not all elements of the Mod have been posted as yet.  While the available elements should be functional, other elements are needed to make the Mod work as described.
 
Not all elements of the Mod have been posted as yet.  While the available elements should be functional, other elements are needed to make the Mod work as described.
 +
 +
Contributors may want to consider writing their material in '''OpenOffice''' with the ''Sun Wiki Publisher'' extension, which enables you to create Wiki articles on '''MediaWiki''' servers without having to know the syntax of the '''MediaWiki''' markup language. All important text attributes such as headings, hyperlinks, lists and simple tables are supported. Even images are supported as long as they have already been uploaded to the wiki site. An automatic upload of images is currently not supported. It is the perfect extension for all users who want to make existing documentations and specifications available on '''MediaWiki''' servers. Just load the document and call the Extension with 'Send – MediaWiki Server'. A dialog will guide you to publish your document.
  
 
The author will remove this message when the Mod is complete.
 
The author will remove this message when the Mod is complete.
Line 261: Line 263:
 
**** Category:XGTacticalGameCoreData
 
**** Category:XGTacticalGameCoreData
 
** Category:XCOM Mods
 
** Category:XCOM Mods
 +
** Category:XCOM Templates
  
−
Remove the above list once your article is complete.  The actual category links appear below.  Just remove those that do not apply:
+
Remove the above list once your article is complete.  Category 'XCOM' should always be included on every page, as the umbrella category for all related articles to that game.  The actual category links for this page appear below.  Just remove and/or add those as appropriate:
  
−
[[Category:XCOM Mods]]
+
[[Category:XCOM Templates]]
−
[[Category:XGTacticalGameCoreData]]
 
−
[[Category:Code Breakdowns]]
 
−
[[Category:Functions XCOM Modding]]
 
−
[[Category:Explosive Damage - XCOM:EU 2012]]
 
−
[[Category:Enum Values XCOM Modding]]
 
−
[[Category:Classes XCOM Modding]]
 
−
[[Category:XCOM Modding]]
 
−
[[Category:Game Files & Modding - XCOM:EU 2012]]
 
−
[[Category:Tutorials_-_XCOM:EU_2012]]
 
−
[[Category:0_Start_here_-_XCOM]]
 
 
[[Category:XCOM]]
 
[[Category:XCOM]]
 +
[[Category:Mods]]
 +
[[Category:Templates]]

Latest revision as of 03:37, 17 November 2018

This is a template. Do not make any changes to this page. Instead, copy the contents below to a new page, and replace anything within {curly braces} with your own appropriate material.



Overview

This section is in need of development.

A very general synopsis description of the Mod.


Game Version Compatibility

This section is in need of development.

This subsection should give the game version (e.g. Patch 4 ( Changelist: 356266 ) ) that the mod is compatible with.


Known Issues

This section is in need of development.

This section should document any side effects or glitches known to be caused by the mod. This can include bugs that have yet to be fixed, as well as unavoidable side effects or UI issues that the player may experience.


Programs and Tools

This section is in need of development.

This section should list and if possible provide links to any program and/or tools needed to replicate your exploration of this subject or installation of the Mod. The section should not be omitted. Note that 'none are required' in that case.


Details

This section is in need of development.

Create an many subsections here as are useful to organize and describe what the Mod does in detail. Remember that you can upload and link to screenshot files to illustrate where ever needed. See this page for help on including files in your article.


File Changes

This section is in need of development.

This should be a general description of all files affected by the Mod, and if it is significant, they should be listed in the required installation sequence. If the install sequence is not significant, it is helpful to note that. When multiple files are involved, they should be linked immediately after the description of what they change, and also linked in the 'References' section in the same order.

'Code Breakdown' is where the hex code is explained by added comments. It is placed within a block pair of 'nowiki' and '/nowiki' (within <angle brackets>) HTML 'markup tags' to preserve the formatting. (Note it is REQUIRED to put a leading space before the 'nowiki' markup tag. The closing tag can be on the last line or after it, and does not require a leading space.)

For example: 

original hex: (virtual size 0x552)
header:
DB 7C 00 00 50 55 00 00 00 00 00 00 C0 7C 00 00 00 00 00 00 00 00 00 00 C6 7C 00 00 00 00 00 00 A9 02 00 00 2C 5C 00 00 52 05 00 00 B6 03 00 00 

body:
if(!DoesDamage())
07 19 00 81 1B 9B 1A 00 00 00 00 00 00 16 16 

return iHitChance;
04 00 C6 7C 00 00

This preserves the authors necessary non-HTML format.

A Code Breakdown that at least identifies the significant bytes a player may wish to adjust to their own purposes should be the minimum provided. If the installer the mod was designed to work with does not support embedded comments or descriptions, then separate Code Breakdown and Mod Install files should be provided.


This sub-section is is a mini-template. The lime text information boxes should be removed when used.

Mod Install files should provide the following data either internally of the file or externally at the point the file is described, in any suitable order: 



MOD NAME:

MOD FILE NAME: 

Include " 'number' of 'total number' " if appropriate.

AUTHOR:

FILE REVISION NUMBER:

COMPATIBILITY: 

This should indicate game revisions/patches known to be compatible with this version 
of the mod, and compatible installers.  A mod user should not be expected to alter 
anything more than the minimum of desired settings and values.  If they will be 
required to perform more complicated adjustments, the expected level of proficiency 
should be explained.

DESCRIPTION: 

A summary of the file's purpose within the overall Mod.

ADDITIONAL INFORMATION: 

* Tables or lists with the values to be used to effect the desired results within the 
mod should be provided where available, or links to that information.
* Affected files and whether or not backups of those files are necessary or handled by 
the installer automatically.
* How to revert the mod, or links to the relevant information (i.e. 
[http://wiki.tesnexus.com/index.php/Steam_and_mods Steam_and_mods on the Nexus XCOM Wiki].)


Localization Changes

This section is in need of development.

Detail any language localization changes that are required. This section should not be omitted. Simply note that 'none are required'.


References

This section is in need of development.

Specific page links go here, even if already referenced in the main body of the text. Put the HTML tag 'br' (in <angle brackets>) twice after each 'refer/referred' section so they will display separated. Use the asterisk format code ('*') to ensure each link appears on it's own line. If there is no reference, put '* <none>' as a placeholder so it's obviously not merely a missing entry.


Referred to by this article:



That refer to this article:



This section is in need of development.

Below the specific page links will be the 'Category' links. The category names be placed within double [square brackets]. Multiple categories are not unusual, but must each be placed on their own line. The Category:XCOM is standard and also serves as an example. These category links will appear when you click on the 'Show preview' button, but in the Category frame below the edit window action buttons. If a category page does not yet exist, it will appear in RED. You can click on the red entry and commence the process of creating the category page even before saving the one you are currently editing.

This box may be removed prior to saving the new page for the first time.


For your convenience, here are the current subject Category Names and their primary locations.

  • Category:XCOM
    • Category:0 Start here - XCOM
    • Category:Tutorials - XCOM:EU 2012
    • Category:Game Files & Modding - XCOM:EU 2012
    • Category:XCOM Modding
      • Category:Classes XCOM Modding
      • Category:Enum Values XCOM Modding
      • Category:Explosive Damage - XCOM:EU 2012
      • Category:Functions XCOM Modding
        • Category:XGTacticalGameCoreData
    • Category:XCOM Mods
    • Category:XCOM Templates

Remove the above list once your article is complete. Category 'XCOM' should always be included on every page, as the umbrella category for all related articles to that game. The actual category links for this page appear below. Just remove and/or add those as appropriate:

Retrieved from "https://wiki.nexusmods.com/index.php?title=Template_-_Mods_-_XCOM:EU_2012&oldid=42566"