Difference between revisions of "Template:VH quest info/doc"
(Initial creation of template documentation) |
(Improve documentation) |
||
(12 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
+ | |||
This template creates a table that provides information about a particular quest in the [[VH|Violated Heroine]] game. It is intended to be used at the beginning of individual [[VH/Quests]] articles. | This template creates a table that provides information about a particular quest in the [[VH|Violated Heroine]] game. It is intended to be used at the beginning of individual [[VH/Quests]] articles. | ||
Line 7: | Line 9: | ||
{{VH quest info | {{VH quest info | ||
| [[VH/Capital|Capital]] | | [[VH/Capital|Capital]] | ||
− | | Select the quest from the Guild's Request Notebook, then talk to [[VH/Characters#Ziggy|Ziggy]] | + | | Select the quest from the Adventurer Guild's Request Notebook, then talk to [[VH/Characters#Ziggy|Ziggy]] |
+ | | Guild quests are only available during day time | ||
| Yes | | Yes | ||
| 100G | | 100G | ||
− | | | + | | |
− | | [[VH/Characters#Nanako| | + | | [[VH/Characters#Nanako|Nanako]], [[VH/Characters#Serena|Serena]], [[VH/Characters#Lime|Lime]] |
− | | Lose the quest intentionally to see a unique [[VH/H | + | | Lose the quest intentionally to see a unique [[VH/H Events|H scene]] |
}} | }} | ||
</pre> | </pre> | ||
Line 20: | Line 23: | ||
{{VH quest info | {{VH quest info | ||
| location = [[VH/Capital|Capital]] | | location = [[VH/Capital|Capital]] | ||
− | | how-to-start = Select the quest from the Guild's Request Notebook, then talk to [[VH/Characters#Ziggy|Ziggy]] | + | | how-to-start = Select the quest from the Adventurer Guild's Request Notebook, then talk to [[VH/Characters#Ziggy|Ziggy]] |
+ | | prereqs = Guild quests are only available during day time | ||
| repeatable = Yes | | repeatable = Yes | ||
| reward-gold = 100G | | reward-gold = 100G | ||
− | | reward-exp = | + | | reward-exp = |
− | | which-characters = [[VH/Characters#Nanako| | + | | reward-other = 2 Salves |
− | | notes = Lose the quest intentionally to see a unique [[VH/H | + | | which-characters = [[VH/Characters#Nanako|Nanako]], [[VH/Characters#Serena|Serena]], [[VH/Characters#Lime|Lime]] |
+ | | notes = Lose the quest intentionally to see a unique [[VH/H Events|H scene]] | ||
}} | }} | ||
</pre> | </pre> | ||
=== Parameters === | === Parameters === | ||
− | None of the parameters are technically required. If you omit any of the parameters, that cell will simply be blank. However, it's | + | None of the parameters are technically required. If you omit any of the parameters, that cell will simply be blank (with a couple of exceptions, noted in their descriptions below). However, it's encouraged to still put something in each of the fields, so that anyone reading the page can at least know that a particular field may not be applicable for this quest. |
− | ; location | + | |
− | ; how-to-start | + | {| class="wikitable" style="text-align: left;" |
− | ; repeatable | + | ! scope="col" | Parameter |
− | ; reward-gold | + | ! scope="col" | Description |
− | ; reward-exp | + | |- |
− | ; which-characters | + | ! scope="row" style="text-align: left;" | <code>location</code> |
− | ; notes | + | | Where do you go to start the quest. |
+ | |- | ||
+ | ! scope="row" style="text-align: left;" | <code>how-to-start</code> | ||
+ | | How do you go about starting the quest; i.e., which action(s) do you need to take, or who do you need to talk to. | ||
+ | |- | ||
+ | ! scope="row" style="text-align: left;" | <code>prereqs</code> | ||
+ | | What are the requirements or conditions that need to be met in order to start this quest. | ||
+ | |- | ||
+ | ! scope="row" style="text-align: left;" | <code>repeatable</code> | ||
+ | | Can the quest be repeated again after you complete it. | ||
+ | |- | ||
+ | ! scope="row" style="text-align: left;" | <code>reward-gold</code> | ||
+ | | How much gold you are given as a reward. When you enter the value, please remember to add a "G" to the end, without a space. Similar to how we don't put a space between "$" and "100" for $100, you don't put a space between the number and the currency symbol in the game either. If this parameter is left blank, the default is to display "None". | ||
+ | |- | ||
+ | ! scope="row" style="text-align: left;" | <code>reward-exp</code> | ||
+ | | How much EXP you are given as a reward. Similar to the value for the gold, please put "EXP", all caps, and no space between the preceding number and the "EXP". If this parameter is left blank, the default is to display "None". | ||
+ | |- | ||
+ | ! scope="row" style="text-align: left;" | <code>reward-other</code> | ||
+ | | <p>Any reward(s) besides gold or EXP.</p><p>If you don't use this parameter, then the entire row will not be rendered in the table. Also, this parameter does not exist as an unnamed parameter. If you want to use it, then you must either place it as the final parameter below the notes if you are using the "short syntax" method (and it must still be a named parameter), or you must use the "full syntax" method for all of the parameters.</p> | ||
+ | |- | ||
+ | ! scope="row" style="text-align: left;" | <code>{{nobr|which-characters}}</code> | ||
+ | | Which of the playable characters can start this quest. Since the game is still unfinished and subject to numerous bugs, characters who cannot complete the quest due to bugs should still be listed here, but notes should be made below. | ||
+ | |- | ||
+ | ! scope="row" style="text-align: left;" | <code>notes</code> | ||
+ | | <p>Any additional notes that are relevant for the quest. This is a good place to put information such as: whether taking certain actions might change the course of the quest in some way; bugs that can crash the game, cause other quests to become bugged; etc.</p><p>If you completely exclude this parameter from your wikitext, then the entire row will not appear in the rendered table; this is also applicable when you are using the "short syntax" method.</p> | ||
+ | |} | ||
+ | |||
+ | == Example == | ||
+ | Here is an example of a VH quest info template that is using the "short syntax" method, but without any notes and ''with'' the '''reward-other''' parameter: | ||
+ | |||
+ | <pre style="overflow: auto;"> | ||
+ | {{VH quest info | ||
+ | | [[VH/Capital|Capital]] | ||
+ | | Select the quest from the Adventurer Guild's Request Notebook, then talk to [[VH/Characters#Ziggy|Ziggy]] | ||
+ | | Guild quests are only available during day time | ||
+ | | Yes | ||
+ | | 100G | ||
+ | | | ||
+ | | [[VH/Characters#Nanako|Nanako]], [[VH/Characters#Serena|Serena]], [[VH/Characters#Lime|Lime]] | ||
+ | | | ||
+ | | reward-other = 2 Salves | ||
+ | }} | ||
+ | </pre> | ||
+ | |||
+ | This will get rendered as: | ||
+ | |||
+ | <div style="border: 1px solid grey; padding: 0 1em 0;"> | ||
+ | {{VH quest info | ||
+ | | [[VH/Capital|Capital]] | ||
+ | | Select the quest from the Adventurer Guild's Request Notebook, then talk to [[VH/Characters#Ziggy|Ziggy]] | ||
+ | | Guild quests are only available during day time | ||
+ | | Yes | ||
+ | | 100G | ||
+ | | | ||
+ | | [[VH/Characters#Nanako|Nanako]], [[VH/Characters#Serena|Serena]], [[VH/Characters#Lime|Lime]] | ||
+ | | | ||
+ | | reward-other = 2 Salves | ||
+ | }} | ||
+ | </div> |
Latest revision as of 17:52, 3 October 2024
This template creates a table that provides information about a particular quest in the Violated Heroine game. It is intended to be used at the beginning of individual VH/Quests articles.
Usage
Short syntax
{{VH quest info | [[VH/Capital|Capital]] | Select the quest from the Adventurer Guild's Request Notebook, then talk to [[VH/Characters#Ziggy|Ziggy]] | Guild quests are only available during day time | Yes | 100G | | [[VH/Characters#Nanako|Nanako]], [[VH/Characters#Serena|Serena]], [[VH/Characters#Lime|Lime]] | Lose the quest intentionally to see a unique [[VH/H Events|H scene]] }}
Full syntax
{{VH quest info | location = [[VH/Capital|Capital]] | how-to-start = Select the quest from the Adventurer Guild's Request Notebook, then talk to [[VH/Characters#Ziggy|Ziggy]] | prereqs = Guild quests are only available during day time | repeatable = Yes | reward-gold = 100G | reward-exp = | reward-other = 2 Salves | which-characters = [[VH/Characters#Nanako|Nanako]], [[VH/Characters#Serena|Serena]], [[VH/Characters#Lime|Lime]] | notes = Lose the quest intentionally to see a unique [[VH/H Events|H scene]] }}
Parameters
None of the parameters are technically required. If you omit any of the parameters, that cell will simply be blank (with a couple of exceptions, noted in their descriptions below). However, it's encouraged to still put something in each of the fields, so that anyone reading the page can at least know that a particular field may not be applicable for this quest.
Parameter | Description |
---|---|
location
|
Where do you go to start the quest. |
how-to-start
|
How do you go about starting the quest; i.e., which action(s) do you need to take, or who do you need to talk to. |
prereqs
|
What are the requirements or conditions that need to be met in order to start this quest. |
repeatable
|
Can the quest be repeated again after you complete it. |
reward-gold
|
How much gold you are given as a reward. When you enter the value, please remember to add a "G" to the end, without a space. Similar to how we don't put a space between "$" and "100" for $100, you don't put a space between the number and the currency symbol in the game either. If this parameter is left blank, the default is to display "None". |
reward-exp
|
How much EXP you are given as a reward. Similar to the value for the gold, please put "EXP", all caps, and no space between the preceding number and the "EXP". If this parameter is left blank, the default is to display "None". |
reward-other
|
Any reward(s) besides gold or EXP. If you don't use this parameter, then the entire row will not be rendered in the table. Also, this parameter does not exist as an unnamed parameter. If you want to use it, then you must either place it as the final parameter below the notes if you are using the "short syntax" method (and it must still be a named parameter), or you must use the "full syntax" method for all of the parameters. |
which-characters
|
Which of the playable characters can start this quest. Since the game is still unfinished and subject to numerous bugs, characters who cannot complete the quest due to bugs should still be listed here, but notes should be made below. |
notes
|
Any additional notes that are relevant for the quest. This is a good place to put information such as: whether taking certain actions might change the course of the quest in some way; bugs that can crash the game, cause other quests to become bugged; etc. If you completely exclude this parameter from your wikitext, then the entire row will not appear in the rendered table; this is also applicable when you are using the "short syntax" method. |
Example
Here is an example of a VH quest info template that is using the "short syntax" method, but without any notes and with the reward-other parameter:
{{VH quest info | [[VH/Capital|Capital]] | Select the quest from the Adventurer Guild's Request Notebook, then talk to [[VH/Characters#Ziggy|Ziggy]] | Guild quests are only available during day time | Yes | 100G | | [[VH/Characters#Nanako|Nanako]], [[VH/Characters#Serena|Serena]], [[VH/Characters#Lime|Lime]] | | reward-other = 2 Salves }}
This will get rendered as: