Template:Campaign info/doc: Difference between revisions
Created page with "{{documentation subpage}} ==Parameters== <templatedata> { "description": "Creates an infobox with vital information for a campaign.", "params": { "system": { "la..." |
|||
(4 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{documentation subpage}} | <noinclude>{{documentation subpage}}</noinclude> | ||
==Parameters== | ==Parameters== | ||
<templatedata> | <templatedata> | ||
Line 25: | Line 25: | ||
"type": "number", | "type": "number", | ||
"example": "5" | "example": "5" | ||
}, | |||
"gmnoteslink": { | |||
"label": "gm notes link", | |||
"description": "Link to notes page for the gm. Should be in a GM namespace to deny view access to players.", | |||
"required": false, | |||
"type": "string", | |||
"example": "[[MiaBGM:Notes]]" | |||
}, | }, | ||
"startdate": { | "startdate": { | ||
Line 126: | Line 133: | ||
|gametime=Weekly saturday at 6pm PST | |gametime=Weekly saturday at 6pm PST | ||
|sessionlength=2 hours}}</pre> | |sessionlength=2 hours}}</pre> | ||
<includeonly>[[Category:Formatting templates]]</includeonly> |
Latest revision as of 06:34, 1 February 2022
This is a documentation subpage for Template:Campaign info. It contains usage information, categories and other content that is not part of the original Template page. |
Parameters
Creates an infobox with vital information for a campaign.
Parameter | Description | Type | Status | |
---|---|---|---|---|
game system | system | The game system to be used in the campaign.
| String | required |
game master | gm | Name of the campaign's game master.
| String | required |
number of players | players | Number of players expected to participate in the campaign.
| Number | required |
gm notes link | gmnoteslink | Link to notes page for the gm. Should be in a GM namespace to deny view access to players.
| String | optional |
campaign start date | startdate | The date the campaign began, or is planned to begin.
| String | optional |
campaign end date | enddate | The date the campaign ended, or is planned to end.
| String | optional |
game time | gametime | The day, frequency, and time of day when the game sessions begin.
| String | optional |
session duration | sessionlength | Approximate planned duration of each session.
| String | optional |
cover image | coverimage | An image to represent the campaign.
| String | optional |
tag line | tagline | A short description/zinger for the campaign. Displayed as a caption under the image, if present.
| String | optional |
Examples
Minimal example:
Exalted | |
---|---|
Game details | |
Game master | Matt |
Number of players | 5 |
Campaign start date | TBD |
Game time | TBD |
{{campaign info |system=Exalted |gm=Matt |players=5 }}
Completed campaign:
Vampire: the Masquerade | |
---|---|
Game details | |
Game master | Sally |
Number of players | 7 |
Campaign start date | June 3, 2019 |
Campaign end date | October 7, 2020 |
Game time | Every other Friday at 9pm CST |
Session length | 4 hours |
{{campaign info |system=Vampire: the Masquerade |gm=Sally |players=7 |startdate=June 3, 2019 |enddate=October 7, 2020 |gametime=Every other Friday at 9pm CST |sessionlength=4 hours}}
Campaign with image:
{{campaign info |system=Dungeons & Dragons 4e |coverimage=[[File:One eyed king.jpg|200px]] |tagline=The secrets of the Dragon-kings will be unveiled |gm=2C |players=4 |startdate=April 6, 2013 |gametime=Weekly saturday at 6pm PST |sessionlength=2 hours}}