Help:Mod pages

From Space Engineers Wiki
Revision as of 06:10, 26 March 2016 by Sapphire (talk | contribs) (moved info from help page)
Jump to: navigation, search

Mod makers have the ability to make use of the information space available on the wiki and create their own mod pages. It can be used to store all their updates, and all other information that they have no other place to keep it.

Mod creation rules

  • You may create your own mod page
  • You may request an administrator to delete your own mod page using the {{delete|reason}} template. See below for more information
  • You may create any number of subpages for your mod, these subpages do not require the infobox template. See below for more information
  • Mod pages must have the {{modinfobox}} template somewhere on the page. This cannot be changed, and its layout/content is up to the server. All other information below it is up to the user
  • Mod pages are only patrolled for potential vandalism, mod owners are responsible for the content of their mod pages
  • You may use other templates used in the main wikispace on your mod pages, including the itembox template. Please specify the nocat flag on these templates to prevent your mod blocks from being entered into the main namespaces categories, failure to do this will result in the annoyance of the administrators.

How to create a mod page

Creating a new mod page is very easy, and an in-depth tutorial here is written up to give you step-by-step instructions on how to make one. Follow each step carefully. Please note you must have a wiki account here to create a page. To create an account, click Create Account here, or at the top-right of the wiki page.

  • Note - If you have an ad blocker, be sure to disable or allow www.spaceengineerswiki.com, otherwise you may not be able to see the KeyCAPTCHA.

If you need additional help, you may request assistance at the Wiki Discussion forum on KeenSoftwareHouse website.

Getting started

Step 1

First go to your address bar on your browser. Copy the following link and paste it. Notice the Mod: this is very important for listing your page

http://www.spaceengineerswiki.com/Mod:

Step 2

Add whatever name you wish to call your mod page. For example MyPage It should look like this

http://www.spaceengineerswiki.com/Mod:MyPage

If you wish to add a space in-between you must use this symbol _ An example of this My_Page

http://www.spaceengineerswiki.com/Mod:My_Page

This simply is for linking purposes. Once created, your page will be listed as My page without the symbol

Step 3

Once you have the name of the page you want, hit enter. The wiki will inform you that the page doesn't exist yet, simply hit the Create new page. Once created, you will have a blank page in front of you. Paste the following code into the empty page, then hit Save page on the bottom.

{{subst:Mod page}}

Editing your new page

When you saved your page with the new code, you should notice a blank layout created by the wiki. Now you're ready to edit the page however you like. To edit the page, click the Edit button on the top right. If you have never used a template like this before, some explanation will be given on how to alter it to your liking.

Below is information to help you understand what each space means

Infobox

Properties Comments
Modinfobox Do not change this
Name The name of your mod
Author Primary author of the mod, if more than one separate with a <br /> (ex: Name1<br />Name2)
Description Short description of your mod for the main mod page
Website Website for your mod, must start with http:// or https:// (OPTIONAL)
Steamgroup Steam group mod page (OPTIONAL)
Forums Mod's Forum Thread (OPTIONAL)
Type Type of your Mod(Block, API, Server, Conversion ) other values are allowed but will not categorize your mod on the main mods page. More than one type is allowed.
Modversion Version number of your mod
Version SE version your mod was made in
Forumcontact Forum account name of your author (does not display, admin use only)
CustomRow1 Title of custom row1
CustomData1 Description for custom row1
CustomRow2 Title of custom row2
CustomData2 Description for custom row2
CustomRow3 Title of custom row3
CustomData3 Description for custom row3
CustomRow4 Title of custom row4
CustomData4 Description for custom row4
CustomRow5 Title of custom row5
CustomData5 Description for custom row5
nocat Disable automatic templates and properties. (This simply just un-lists your mod page)
hide Hide this template and only use the autocategory features, do not include this if you want the template to show

Additonal page info

You may add more than just the info box information. Below the template info box, you may type whatever information you wish for your mod. Some example information can be added to the page such as "Introduction" "Features" "Known issues". An example of how to add these:

==Introduction==
A description of my mod here
==Introduction==
A description of my mod here
==Features==
This is what my mod does
==Introduction==
Our server information here
==Features==
This is what my mod does
==Known issues==
This is the list of issues

If you wish to add further formatting to your page, please visit the Mediawiki formatting help page

How to upload images

Because the File namespace is shared with the main wiki space all file names used on mod pages must have the following text in them: Mod_Your Mod_filename. Replace Your Mod with your actual mod name or abbreviation. Image files created for server pages may be moved or deleted without warning if they do not follow the correct naming scheme.

Click the Upload File in the navigation menu. Select the image you wish to upload. Once you selected it, you'll notice in the Destination filename space below that your images name has been placed there. Edit the name to include Mod_Your Mod_filename

An example of how it should look when you upload an image for your server MyPage

Mod_MyPage_MypictureHere.jpg

If you have a space in your server My_Page, simply change to.

Mod_My_Page_MypictureHere.jpg

Next add one of the following codes into the description box. This helps keep the wiki organized as well for Copyright.

  • {{Game Screenshot}} - For in-game screenshots (Even modified ones)
  • {{Flag Image}} - For country flag images
  • {{User Image}} - For custom images you created


Adding images to your page

Because the File namespace is shared with the main wiki space all file names used on Mod pages must have the following text in them: Mod_Your Mod_filename. Replace Your Mod with your actual mods name or abbreviation. Image files created for mod pages may be moved or deleted without warning if they do not follow the correct naming scheme.

Click the Upload File in the navigation menu. Select the image you wish to upload. Once you selected it, you'll notice in the Destination filename space below that your images name has been placed there. Edit the name to include Mod_Your Mod_filename

An example of how it should look when you upload an image for your Mod MyPage

Mod_MyPage_MypictureHere.jpg

If you have a space in your mod My_Page, simply change to.

Mod_My_Page_MypictureHere.jpg

Next add one of the following codes into the description box. This helps keep the wiki organized.

  • {{Game Screenshot}} - For in-game screenshots (Even modified ones)
  • {{Flag Image}} - For country flag images
  • {{User Image}} - For custom images you created

How to add a subpage

Sub pages is simply another new wiki page attached to your mod page. If you are needing a lot of space for information for whatever reason (mod overview, specific instructions, example pages, FAQs, etc), then simply follow these instructions

In your address bar next to your mod page link, add the following /MySubPage and click enter.

An example of how it should look

http://www.spaceengineerswiki.com/Mod:My_Page/MySubPage

You'll be informed that the page has yet to be created on the wiki, click Create new page

Unlike your main mod page, there is no need to include the subst:Mod page code and immediately save. You are free to edit it however much you like right off the bat.

How to delete your page

If you wish to delete your mod wiki page, first go into edit mode. Then paste the following code at the very top; save the page.

{{delete|Your reason for deletion here}}

This will mark your page for deletion