Difference between revisions of "Contributor Guide"

From Virtuverse Wiki
Jump to navigation Jump to search
(Created page with "== Contributing to Wiki == == How to contribute == === Creatures === === Items === === Loot Tables === === Crafting Tables === == Additional Notes ==")
 
 
(31 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Contributing to Wiki ==
 
== Contributing to Wiki ==
 +
 +
The wiki is open for all Virtuverse players to contribute data such as creatures, items, etc. This document serves as guidance for wiki contributors to make use of the current system placed to automate data entry and retrieval.
  
 
== How to contribute ==
 
== How to contribute ==
 +
 +
First, you will need to create an account for this wiki if you haven't. Next, login with your account and follow the guides below to add / edit.
 +
 +
== General Information ==
 +
 +
* Please do not use ":" as part of the name of any item/weapons/quests/npc/etc. as it conflicts with MediaWiki's namespace character. Use others such as dash (-) instead
 +
* Please avoid using the same name for more than 2 entities.
 +
* Explanations of different checkboxes in [[Data:ItemForm|item form]]
 +
** <code>Lootable</code> means that the item can be looted from creatures, but NOT from mining or crafting activities. This is strictly creature loot only
 +
** <code>Craftable</code> means that the item can be crafted using a recipe. See [[Contributor_Guide/Recipes|Recipes and craftable items guide]] for more information on how to add/edit them
 +
** <code>Tradable</code> means that the item can be traded between players
 +
** <code>Mineable</code> means that the item can be obtained from mining claims
 +
** <code>Vendor buyable</code> means that the item can be bought at its value from NPC vendors
 +
** <code>Is an ammo</code> means that the item is used as an ammo for certain weapons/tools. Items with this property will show up on dropdowns of ammo list
 +
 +
 +
== Step-by-step guide ==
  
 
=== Creatures ===
 
=== Creatures ===
 +
 +
* Please check whether the creature is already added in [[Creatures]] List.
 +
* If it is not added yet, click on the + button to add them (or through [[Data:CreatureForm|here]])
 +
* Fill the required fields and click <code>Submit</code> too add the entry
 +
* You can check that your entry is already added through the [[Creatures]] list.
 +
* To create a personalized page of the creature, click the creature's name on the [[Creatures]] list. You can also access it through the form you used to add the entry.
 +
* If the personalized page is not created yet, click <code>Create</code> button on the top right page of the page.
 +
* You will be brought to the editing page. Note that the editor page will already be populated with template. This template is used to automatically retrieve and display creature data that you have entered before.
 +
** DO NOT edit the content of the template (the ones with <shtml> tags).
 +
** You can add backstory, tips to kill, new section, or move the shtml tags anywhere you want, but do not change its content.
 +
* Click <code>Save</code> to add the page. The system will automatically populate the creature's data
  
 
=== Items ===
 
=== Items ===
 +
 +
* Items here refer to all kinds of in-game obtainable items, such as weapons, armor parts, quest items, mineable resources, etc.
 +
* Please check whether the item is already added in [[Items]] List. There are also categorized lists such as [[Weapons]], [[Armors]], and [[Tools]]
 +
* If it is not added yet, click on the + button to add them (or through [[Data:ItemForm|here]])
 +
* Pick the item's type. An additional form will show up depending on the selected type.
 +
* Fill the required fields and click <code>Submit</code> to create the entry.
 +
** Note that the 4 checkboxes (Lootable, Tradable, Craftable, and Mineable) will decide whether the item's relational properties can be edited. For example, if you put a tick on Craftable, then there will be an option to edit the item's crafting table
 +
** If you are editing items that use other item as ammo (e.g. weapon, etc.), make sure you have added the ammo as an Item with "used as ammo" checkbox ticked
 +
* To create a personalized page of the item, click the item name on the [[Items]] list. You can also access it through the form you used to add the entry.
 +
** DO NOT edit the content of the template (the ones with <shtml> tags).
 +
** You can add additional information on how to obtain it, historical information, new section, or move the shtml tags anywhere you want, but do not change its content.
 +
* Click <code>Save</code> to add the page. The system will automatically populate the item's data
 +
 +
=== NPC ===
 +
 +
* Please check whether the NPC is already added in [[NPC]] List.
 +
* If it is not added yet, click on the + button to add them (or through [[Data:NPCForm | here]])
 +
* Fill the required fields and click <code>Submit</code> too add the entry
 +
** In case the NPC you want to add has the same name as NPCs in another area, e.g. Missive Terminal, do set a different name. It can be Missive Terminal followed by the area name, for example.
 +
* You can check that your entry is already added through the [[NPC]] list.
 +
* To create a personalized page of the NPC, click the npc's name on the [[NPC]] list. You can also access it through the form you used to add the entry.
 +
* If the personalized page is not created yet, click <code>Create</code> button on the top right page of the page.
 +
* You will be brought to the editing page. Note that the editor page will already be populated with template. This template is used to automatically retrieve and display creature data that you have entered before.
 +
** DO NOT edit the content of the template (the ones with <shtml> tags).
 +
** You can add backstory, npc's precise location, new section, or move the shtml tags anywhere you want, but do not change its content.
 +
* Click <code>Save</code> to add the page. The system will automatically populate the NPC's data
 +
 +
=== Quests ===
 +
 +
* Each Quest can be connected to a certain NPC (The quest giver). Please check if the NPC for this quest is already added through [[NPC]] list.
 +
* Next, check whether the Quest is already added in [[Quests]] List.
 +
* If it is not added yet, click on the + button to add them (or through [[Data:QuestForm | here]])
 +
* Fill the required fields and click <code>Submit</code> too add the entry
 +
** If you are creating a missive (by ticking the <code>Is a Missive</code>), do make sure that the NPC selected is the missive terminal located in the correct area.
 +
* You can check that your entry is already added through the [[Quests]] list.
 +
* To create a personalized page of the Quest, click the quest's name on the [[Quests]] list. You can also access it through the form you used to add the entry.
 +
* If the personalized page is not created yet, click <code>Create</code> button on the top right page of the page.
 +
* You will be brought to the editing page. Note that the editor page will already be populated with template. This template is used to automatically retrieve and display creature data that you have entered before.
 +
** DO NOT edit the content of the template (the ones with <shtml> tags).
 +
** You can add tips to finish the quest, coordinates of important locations, new section, or move the shtml tags anywhere you want, but do not change its content.
 +
* Click <code>Save</code> to add the page. The system will automatically populate the Quest's data
 +
 +
=== Area ===
 +
 +
* Please check whether the Area is already added in [[Areas]] List.
 +
* If it is not added yet, click on the + button to add them (or through [[Data:AreaForm | here]])
 +
* Fill the required fields and click <code>Submit</code> too add the entry
 +
* You can check that your entry is already added through the [[Areas]] list.
 +
* To create a personalized page of the area, click the area's name on the [[Areas]] list. You can also access it through the form you used to add the entry.
 +
* If the personalized page is not created yet, click <code>Create</code> button on the top right page of the page.
 +
* You will be brought to the editing page. Note that the editor page will already be populated with template. This template is used to automatically retrieve and display creature data that you have entered before.
 +
** DO NOT edit the content of the template (the ones with <shtml> tags).
 +
** You can add backstory, new sections, maps, or move the shtml tags anywhere you want, but do not change its content.
 +
* Click <code>Save</code> to add the page. The system will automatically populate the area's data
  
 
=== Loot Tables ===
 
=== Loot Tables ===
  
=== Crafting Tables ===
+
* Check first if the items / creatures for the loot table already exist.
 +
* Loot tables can be accessed through links on every row in [[Items]] list of [[Creatures]] list. The links will either be [Loot] or [Looter]
 +
* The [Looter] link will show the loot table of the given item against the list of creatures. The [Loot] link will show the given creature's loot against the list of items. The [Looter] link will only be shown if the item is Lootable.
 +
* In the loot form, add the item/creature on the left list to the right to assign which item/creature loots/is looted by which item/creature. If you are editing loot table for an item, the left list will contain the list of creatures, and vice versa
 +
* If you want to disable a certain loot entry, put <code>Invalid</code> on the rarity dropdown
 +
* Click <code>Submit</code> to submit the changes
 +
* The loot tables can be seen in the personalized pages of the given item / creature
 +
 
 +
=== Crafting Ingredients and Outputs ===
 +
 
 +
See [[Contributor_Guide/Recipes|Recipes and craftable items guide]]
 +
 
 +
=== Quest Relations Table ===
 +
 
 +
* Quest relations table is a table used to define relations between quest, such as predecessors (requires) and successors (unlocks)
 +
* Make sure that the quests are already added through [[Quests]] list
 +
* Each quest entry on the list will have [Relations] link. Clicking it will bring you to the Quest relations form
 +
* There will be a list on the left that contains the list of all quests excluding the one you are editing at the moment
 +
* There will also be 2 boxes on the right, denoting the requirements and unlocked quests
 +
* Add the quest from the list on the left to the suitable box on the right
 +
* Click <code>Submit</code> to save the changes
 +
* Note if you set a relation of 2 quests, you will only need to edit the relation of one of the quests. E.g. if Quest A unlocks B, then in Quest B, Quest A will automatically be set as the predecessor of the quest
 +
* The quest relations information can be seen in the personalized page of the Quest
 +
 
 +
=== Repair Tables ===
 +
 
 +
* Only [[Weapons]], [[Tools]], and [[Armors]] that are repairable.
 +
* There will be a [Repair] link on each weapon/tool/armor data. Clicking it will bring you to the Repair table form
 +
* The rest of the steps is similar to adding crafting ingredients
 +
 
 +
=== Skills ===
 +
 
 +
* Please check whether the Skill is already added in [[Skills]] List.
 +
* If it is not added yet, click on the + button to add them (or through [[Data:SkillForm|here]])
 +
* Fill the required fields and click <code>Submit</code> too add the entry
 +
* You can check that your entry is already added through the [[Skills]] list.
 +
* To create an individual page of the skill, click the skill name from the list and create the page
 +
** There will be a shtml template already inserted. Do NOT change the content of it
 +
** You can add new information as you wish
 +
* After creation, the page will automatically retrieve relevant data
 +
 
 +
=== Professions ===
 +
 
 +
* Please check whether the Profession is already added in [[Professions]] List.
 +
* If it is not added yet, click on the + button to add them (or through [[Data:ProfessionForm|here]])
 +
* Fill the required fields and click <code>Submit</code> too add the entry
 +
* You can check that your entry is already added through the [[Professions]] list.
 +
* To create an individual page of the Profession, click the profession name from the list and create the page
 +
** There will be a shtml template already inserted. Do NOT change the content of it
 +
** You can add new information as you wish, but leave out the shtml template
 +
* After creation, the page will automatically retrieve relevant data
 +
 
 +
=== Abilities ===
 +
 
 +
* Please check whether the Ability is already added in [[Abilities]] List.
 +
* If it is not added yet, click on the + button to add them (or through [[Data:AbilityForm|here]])
 +
* Fill the required fields and click <code>Submit</code> too add the entry
 +
* You can check that your entry is already added through the [[Abilities]] list.
 +
* To create an individual page of the Ability, click the ability name from the list and create the page
 +
** There will be a shtml template already inserted. Do NOT change the content of it
 +
** You can add new information as you wish, but leave out the shtml template
 +
* After creation, the page will automatically retrieve relevant data
 +
 
 +
=== Skill - Professions relation ===
 +
 
 +
* Make sure that the [[Skills]] and [[Professions]] are already added previously
 +
* Go to a profession you want to edit the skills for from [[Professions]] list and click the [Skills] link
 +
* In the skill-profession relation form, you can add the skills from the left list to add it to the right one
 +
* Fill in the necessary fields
 +
* Click <code>Submit</code> to submit it
 +
* The result can be seen on the individual page of the said profession
 +
 
 +
=== Ability unlock requirements ===
 +
 
 +
* Ability can be unlocked by several abilities or professions. Make sure that the abilities and professions required to unlock it are already added to [[Abilities]] and [[Professions]]
 +
* Pick the ability you want to edit its requirements in [[Abilities]] list and click [Edit Requirements] link. You can also navigate the individual page of the ability to get to the form
 +
* In the ability unlock form, add the required abilities / professions from the boxes on the left to the right and fill in the fields
 +
** If <code>active</code> checkbox is ticked, the added ability / profession will not be shown
 +
** Do note that only direct requirements are allowed. E.g. If Ability A is unlocked by ability B, which is unlocked by profession C, then for Ability A, only ability B is added (not the profession C as it's an indirect requirement)
 +
* Click <code>Submit</code> to update it
 +
* The unlock requirements will be shown on the individual page of the ability.
  
 
== Additional Notes ==
 
== Additional Notes ==
 +
 +
Formatting guidelines for MediaWiki: https://www.mediawiki.org/wiki/Help:Formatting
 +
 +
Note that the game itself is not released and is still in development phase. As such, there will be missing parameters / properties that should have been there in the forms. We are updating them as we receive new information from playtest during the game's development phases.
 +
 +
Deletion is not allowed for contributors. If you need to have an entry deleted, please inform the wiki devs through Virtuverse's Discord.

Latest revision as of 04:43, 5 October 2019

Contributing to Wiki

The wiki is open for all Virtuverse players to contribute data such as creatures, items, etc. This document serves as guidance for wiki contributors to make use of the current system placed to automate data entry and retrieval.

How to contribute

First, you will need to create an account for this wiki if you haven't. Next, login with your account and follow the guides below to add / edit.

General Information

  • Please do not use ":" as part of the name of any item/weapons/quests/npc/etc. as it conflicts with MediaWiki's namespace character. Use others such as dash (-) instead
  • Please avoid using the same name for more than 2 entities.
  • Explanations of different checkboxes in item form
    • Lootable means that the item can be looted from creatures, but NOT from mining or crafting activities. This is strictly creature loot only
    • Craftable means that the item can be crafted using a recipe. See Recipes and craftable items guide for more information on how to add/edit them
    • Tradable means that the item can be traded between players
    • Mineable means that the item can be obtained from mining claims
    • Vendor buyable means that the item can be bought at its value from NPC vendors
    • Is an ammo means that the item is used as an ammo for certain weapons/tools. Items with this property will show up on dropdowns of ammo list


Step-by-step guide

Creatures

  • Please check whether the creature is already added in Creatures List.
  • If it is not added yet, click on the + button to add them (or through here)
  • Fill the required fields and click Submit too add the entry
  • You can check that your entry is already added through the Creatures list.
  • To create a personalized page of the creature, click the creature's name on the Creatures list. You can also access it through the form you used to add the entry.
  • If the personalized page is not created yet, click Create button on the top right page of the page.
  • You will be brought to the editing page. Note that the editor page will already be populated with template. This template is used to automatically retrieve and display creature data that you have entered before.
    • DO NOT edit the content of the template (the ones with <shtml> tags).
    • You can add backstory, tips to kill, new section, or move the shtml tags anywhere you want, but do not change its content.
  • Click Save to add the page. The system will automatically populate the creature's data

Items

  • Items here refer to all kinds of in-game obtainable items, such as weapons, armor parts, quest items, mineable resources, etc.
  • Please check whether the item is already added in Items List. There are also categorized lists such as Weapons, Armors, and Tools
  • If it is not added yet, click on the + button to add them (or through here)
  • Pick the item's type. An additional form will show up depending on the selected type.
  • Fill the required fields and click Submit to create the entry.
    • Note that the 4 checkboxes (Lootable, Tradable, Craftable, and Mineable) will decide whether the item's relational properties can be edited. For example, if you put a tick on Craftable, then there will be an option to edit the item's crafting table
    • If you are editing items that use other item as ammo (e.g. weapon, etc.), make sure you have added the ammo as an Item with "used as ammo" checkbox ticked
  • To create a personalized page of the item, click the item name on the Items list. You can also access it through the form you used to add the entry.
    • DO NOT edit the content of the template (the ones with <shtml> tags).
    • You can add additional information on how to obtain it, historical information, new section, or move the shtml tags anywhere you want, but do not change its content.
  • Click Save to add the page. The system will automatically populate the item's data

NPC

  • Please check whether the NPC is already added in NPC List.
  • If it is not added yet, click on the + button to add them (or through here)
  • Fill the required fields and click Submit too add the entry
    • In case the NPC you want to add has the same name as NPCs in another area, e.g. Missive Terminal, do set a different name. It can be Missive Terminal followed by the area name, for example.
  • You can check that your entry is already added through the NPC list.
  • To create a personalized page of the NPC, click the npc's name on the NPC list. You can also access it through the form you used to add the entry.
  • If the personalized page is not created yet, click Create button on the top right page of the page.
  • You will be brought to the editing page. Note that the editor page will already be populated with template. This template is used to automatically retrieve and display creature data that you have entered before.
    • DO NOT edit the content of the template (the ones with <shtml> tags).
    • You can add backstory, npc's precise location, new section, or move the shtml tags anywhere you want, but do not change its content.
  • Click Save to add the page. The system will automatically populate the NPC's data

Quests

  • Each Quest can be connected to a certain NPC (The quest giver). Please check if the NPC for this quest is already added through NPC list.
  • Next, check whether the Quest is already added in Quests List.
  • If it is not added yet, click on the + button to add them (or through here)
  • Fill the required fields and click Submit too add the entry
    • If you are creating a missive (by ticking the Is a Missive), do make sure that the NPC selected is the missive terminal located in the correct area.
  • You can check that your entry is already added through the Quests list.
  • To create a personalized page of the Quest, click the quest's name on the Quests list. You can also access it through the form you used to add the entry.
  • If the personalized page is not created yet, click Create button on the top right page of the page.
  • You will be brought to the editing page. Note that the editor page will already be populated with template. This template is used to automatically retrieve and display creature data that you have entered before.
    • DO NOT edit the content of the template (the ones with <shtml> tags).
    • You can add tips to finish the quest, coordinates of important locations, new section, or move the shtml tags anywhere you want, but do not change its content.
  • Click Save to add the page. The system will automatically populate the Quest's data

Area

  • Please check whether the Area is already added in Areas List.
  • If it is not added yet, click on the + button to add them (or through here)
  • Fill the required fields and click Submit too add the entry
  • You can check that your entry is already added through the Areas list.
  • To create a personalized page of the area, click the area's name on the Areas list. You can also access it through the form you used to add the entry.
  • If the personalized page is not created yet, click Create button on the top right page of the page.
  • You will be brought to the editing page. Note that the editor page will already be populated with template. This template is used to automatically retrieve and display creature data that you have entered before.
    • DO NOT edit the content of the template (the ones with <shtml> tags).
    • You can add backstory, new sections, maps, or move the shtml tags anywhere you want, but do not change its content.
  • Click Save to add the page. The system will automatically populate the area's data

Loot Tables

  • Check first if the items / creatures for the loot table already exist.
  • Loot tables can be accessed through links on every row in Items list of Creatures list. The links will either be [Loot] or [Looter]
  • The [Looter] link will show the loot table of the given item against the list of creatures. The [Loot] link will show the given creature's loot against the list of items. The [Looter] link will only be shown if the item is Lootable.
  • In the loot form, add the item/creature on the left list to the right to assign which item/creature loots/is looted by which item/creature. If you are editing loot table for an item, the left list will contain the list of creatures, and vice versa
  • If you want to disable a certain loot entry, put Invalid on the rarity dropdown
  • Click Submit to submit the changes
  • The loot tables can be seen in the personalized pages of the given item / creature

Crafting Ingredients and Outputs

See Recipes and craftable items guide

Quest Relations Table

  • Quest relations table is a table used to define relations between quest, such as predecessors (requires) and successors (unlocks)
  • Make sure that the quests are already added through Quests list
  • Each quest entry on the list will have [Relations] link. Clicking it will bring you to the Quest relations form
  • There will be a list on the left that contains the list of all quests excluding the one you are editing at the moment
  • There will also be 2 boxes on the right, denoting the requirements and unlocked quests
  • Add the quest from the list on the left to the suitable box on the right
  • Click Submit to save the changes
  • Note if you set a relation of 2 quests, you will only need to edit the relation of one of the quests. E.g. if Quest A unlocks B, then in Quest B, Quest A will automatically be set as the predecessor of the quest
  • The quest relations information can be seen in the personalized page of the Quest

Repair Tables

  • Only Weapons, Tools, and Armors that are repairable.
  • There will be a [Repair] link on each weapon/tool/armor data. Clicking it will bring you to the Repair table form
  • The rest of the steps is similar to adding crafting ingredients

Skills

  • Please check whether the Skill is already added in Skills List.
  • If it is not added yet, click on the + button to add them (or through here)
  • Fill the required fields and click Submit too add the entry
  • You can check that your entry is already added through the Skills list.
  • To create an individual page of the skill, click the skill name from the list and create the page
    • There will be a shtml template already inserted. Do NOT change the content of it
    • You can add new information as you wish
  • After creation, the page will automatically retrieve relevant data

Professions

  • Please check whether the Profession is already added in Professions List.
  • If it is not added yet, click on the + button to add them (or through here)
  • Fill the required fields and click Submit too add the entry
  • You can check that your entry is already added through the Professions list.
  • To create an individual page of the Profession, click the profession name from the list and create the page
    • There will be a shtml template already inserted. Do NOT change the content of it
    • You can add new information as you wish, but leave out the shtml template
  • After creation, the page will automatically retrieve relevant data

Abilities

  • Please check whether the Ability is already added in Abilities List.
  • If it is not added yet, click on the + button to add them (or through here)
  • Fill the required fields and click Submit too add the entry
  • You can check that your entry is already added through the Abilities list.
  • To create an individual page of the Ability, click the ability name from the list and create the page
    • There will be a shtml template already inserted. Do NOT change the content of it
    • You can add new information as you wish, but leave out the shtml template
  • After creation, the page will automatically retrieve relevant data

Skill - Professions relation

  • Make sure that the Skills and Professions are already added previously
  • Go to a profession you want to edit the skills for from Professions list and click the [Skills] link
  • In the skill-profession relation form, you can add the skills from the left list to add it to the right one
  • Fill in the necessary fields
  • Click Submit to submit it
  • The result can be seen on the individual page of the said profession

Ability unlock requirements

  • Ability can be unlocked by several abilities or professions. Make sure that the abilities and professions required to unlock it are already added to Abilities and Professions
  • Pick the ability you want to edit its requirements in Abilities list and click [Edit Requirements] link. You can also navigate the individual page of the ability to get to the form
  • In the ability unlock form, add the required abilities / professions from the boxes on the left to the right and fill in the fields
    • If active checkbox is ticked, the added ability / profession will not be shown
    • Do note that only direct requirements are allowed. E.g. If Ability A is unlocked by ability B, which is unlocked by profession C, then for Ability A, only ability B is added (not the profession C as it's an indirect requirement)
  • Click Submit to update it
  • The unlock requirements will be shown on the individual page of the ability.

Additional Notes

Formatting guidelines for MediaWiki: https://www.mediawiki.org/wiki/Help:Formatting

Note that the game itself is not released and is still in development phase. As such, there will be missing parameters / properties that should have been there in the forms. We are updating them as we receive new information from playtest during the game's development phases.

Deletion is not allowed for contributors. If you need to have an entry deleted, please inform the wiki devs through Virtuverse's Discord.