KeenWiki:Adding a new mod

From KeenWiki
Jump to: navigation, search

This page explains how to add a mod to the wiki using the latest templates (which may not be in use on all mods as it takes time to update pages.) It is better to follow the instructions here rather than blindly copying an existing mod's page, unless you are sure that mod is using the latest templates and styling.

Create the page

Add the infobox

Create a new page for the mod and include the infobox and standard templates:

{{Mod Infobox
 | Episode = 4
 | Authors = [[User:Someone|]]
 | ReleaseDate = 2010-01-02
 | Status = Complete
 | Discussion = [https://pckf.com/viewtopic.php?... PCKF release]
 | Homepage = 
 | Levels = 20
 | SecretLevels =
 | NewGameplay = No
 | NewGfx = Yes
 | NewLevels = Yes
 | NewSfx = Yes
 | NewMusic = Yes
 | LatestDownloadURL = http://example
}}

For more explanation on what to put in the infobox or what the items mean, see Template:Mod Infobox.

Add the lists

Add the item, actor and level lists. This will automatically give you a list of all the elements of the mod once the images are uploaded.

== Actors ==

{{ModActorList}}

== Items ==

{{ItemList}}

== Levels ==

{{ModLevelList}}

Tip: There is often some delay before newly uploaded images appear on a page using automatic lists like this. You can speed this up by using the Refresh link on the mod's page. (The Refresh link is next to the Edit link, under the "More" dropdown.)

Upload images

Upload images for each actor, item and level in the mod. See the images on Commander Keen's Valentine Bash for a working example.

Title images

After the infobox has been added to the page, clicking the Preview button will show the infobox with links to upload the two main images. One is of the title screen and one is a representative image of the game being played. Use the links in the infobox to upload the images, as this will ensure they have the correct filenames.

When selecting a screenshot for the "in-game" image, try to pick one that shows off a more interesting part of the mod.

Actor images

These are images of all the creatures, enemies and other interactive elements in the game.

To prevent conflicts with similarly named actors among mods, the uploaded filename should include the name of the mod. For example, when uploading "My Creature" from "My Mod", the image should be uploaded as "My Mod - My Creature.png".

When uploading the image, set the item description to be the actor infobox:

{{ModActorImage
 | Name = My Creature
 | Replacement = Mad Mushroom
 | Game = My Mod
 | Lethal = Yes
 | Immortal = No
 | Description = An optional description about the creature, if you want to provide more detail.
}}

There is no need to add the image to any categories as the template does this for you.

Unchanged actors

If the mod include actors from the original game that are unchanged, the image for the original game should be edited and a special template added. Do not add the usual template to an original actor as this will result in multiple conflicting elements on the page (two names, two 'is lethal' flags, and so on.) See File:Mad Mushroom.png for an example.

{{OriginalActorInMod|Game = My Mod}}

Item images

Items are anything collectible in the game, such as points, keycards, ammo, and so on. For edge cases, use your best judgement - e.g. the Foot in Keen 4 can't be "collected" so it is considered an actor. As with the actors, the item images should be uploaded as "My Mod - My Item.png" to avoid conflicts. The same ItemImage template is used for all items, but take note that point items are slightly different to other items.

Point items:

{{ItemImage
 | Name = My item
 | Type = Point
 | Points = 200
 | Game = My Mod
}}

Collectible items:

{{ItemImage
 | Name = Wetsuit
 | Type = Collectible
 | Description = Allows accessing the underwater levels.
 | Game = My Mod
}}

There is no need to add the image to any categories as the template does this for you.

If the same item is used in multiple mods, contact Malvineous or one of the other admins as another method will have to be used. The ItemImage template can't be used multiple times on the same page as there's no way to distinguish which properties (e.g. Type or Description) apply to which mod.

Unchanged items

If the mod include items from the original game that are unchanged, the image for the original game should be edited and a special template added. Do not add the usual template to an original item as this will result in multiple conflicting elements on the page (two names, two different point values, and so on.) See File:Key.png for an example.

{{OriginalItemInMod|Game = My Mod}}

Levels

Follow the same process as with the other images. "My Mod - Level 01.png" is preferred (note two-digit level numbers with leading zeros in the filename, but no leading zeroes in the template's LevelNumber parameter.) Typically the world map is considered "Level 00" for Keen: Galaxy and "Level 80" for Keen: Vorticons. For Vorticons, uploading all levels (including the menu background) is encouraged. For Galaxy, include the High Score level if it is accessible in the game.

This template is used on each uploaded image:

{{LevelImage
 | Game = My Mod
 | LevelTitle = My First Level
 | LevelNumber = 1
 | EntryText = Keen says something snappy as he enters My First LEvel
 | Required = No
 | Points = 123
 | AmmoPacks = 456
}}

See Template:LevelImage for more details about what each item represents, especially for Keen 3 and Dreams which distinguish between collecting single ammo items and 5-packs. For Vorticons, which has no next displayed while entering a level, omit the EntryText item completely.

Again, there's no need to add the image to any categories as the template does this for you.

Final details

At this point the rest of the detail can be added as you wish, such as including the backstory, credits and trivia.