Difference between revisions of "User:Alleryn"

From Project: Gorgon Wiki
Jump to: navigation, search
(Notes)
(Version History)
 
(77 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
Last updated September 2020
 
Last updated September 2020
 
==Introduction==
 
==Introduction==
I'm alleryn in PG.  Welcome to my user page.  Feel free to contact me in-game, on the [[Discord]], or on my [[User_talk:Alleryn|talk page]].
+
I'm alleryn in PG.  Welcome to my user page.  Feel free to contact me in-game, on the [[Discord]] at alleryn#6872, or on my [[User_talk:Alleryn|talk page]].
  
==Projects==
+
== AllyBot ==
* Currently working on:
+
Maintains:
** Creating a bot to create/maintain sections of each item page.
+
* For item pages:
*** Completed-ish:
+
** Recipes using given item as ingredient and Recipes producing given item
**** Script to generate one table of all recipes in which a given item is an ingredient, and one table of all recipes in which a given item is a product.
+
** Quests that require a given item, and Quests that reward a given item
***** Known bugs / areas for improvement:
+
** Npcs whose Favor is affected by gifting a given item
****** Factor in lookup table from ItemCategory template to make category links more readable
+
** Abilities that consume given item as ammo
**** Script to generate a table of all npcs whose favor is affected by gifting a given item
+
* [[Hardcore_Mode#List_of_Items_Usable_Only_in_Hardcore_Mode]]
***** Known bugs / areas for improvement:
+
* [[Gourmand/Edibles]], [[Gourmand/Meals]], [[Gourmand/Snacks]], [[Gourmand/Instant-Snacks]]
****** Does not get great location data or generate it as a hyperlink
+
* [[Template:Attribute icon]] and [[Template:Attribute label]]
****** TODO: Factor out ItemCategory template to avoid unnecessary transclusion
+
* The Xp tables (the pages in [[:Category:Xptable]])
**** Script to generate information on quests that require a given item, and on quests that reward a given item
+
AllyBot is on GitHub: https://github.com/alleryn/ProjectGorgonWiki-AllyBot
***** Known bugs / areas for improvement:
+
=== Version History ===
****** Does not get great location data or generate it as a hyperlink
+
*119: Updating to v352. Run 10/24/2021 (after a slight delay of a week or so on alleryn's part).
****** Does not correctly find all npc names that it should
+
*118: Updating to v351. Added some NPC location inof.  Run 10/5/2021.
****** TODO: Factor out ItemCategory template to avoid unnecessary transclusion
+
*117: Now maintains xp tables.
*** To do (this list is likely incomplete):
+
*116: Updating to v350. Also fixed bug with whittling recipes and updated some NPC location info. Run 9/29/2021.
**** Incorporate above scripts into a single script to pick out sections of existing item pages and maintain/replace/amend them
+
*115: Updating to v349. Run 9/27/2021.
**** Write a bot to run script on all (or most if there are troublesome cases) item pages
+
*114: Updating to v348. Run 7/4/2021. No changes.
** Updating [[Merchants]].
+
*113: Updating to v347. Run 7/4/2021.
*** Completed:
+
*112: Bugfix: work order council rewards working again after change to quests.json in v345. Run 5/26/2021.
**** Basic restructuring via templates.
+
*111: Updating to v346. Run 5/25/2021. No changes.
**** Added/converted rows for all vendors on [[:Category:Vendor]]
+
*110: Updating to v345. Run 5/25/2021.
**** Prettying it up
+
*109: Updating to v344. Run 4/22/2021. No changes.
***** Left/right/mid alignments
+
*108: Updating to v343. Run 4/22/2021. No changes.
***** Recoloring of region name bars
+
*107: Updating to v342. Run 3/26/2021.
*** To do:
+
*106: Minor bugfix. Run 12/15/2020.
**** Confirmation and data entry (ongoing).  All help is greatly appreciated :)
+
*105: Minor bugfix and added functionality. Run 12/15/2020.:
 +
** add [[Template:Attribute icon]] and [[Template:Attribute label]] to maintained pages.
 +
** Some category ingredients display incorrectly, e.g. [[:Category:Items/CheapMeat]] butchering recipe shows Cheap Meat (stack of 60) x60 (with the x60 displayed redundantly).
 +
** add [[Daisy_(Lute)]] to list of maintained item pages (already manually edited, AllyBot should not have any immediate effect).
 +
*104: Updating to v341. Run 12/11/2020.
 +
*103: Updating to v340. Run 11/7/2020.
 +
*102: Updating to v339. Run 10/15/2020.
 +
*101: Bugfixes run 10/4/2020:
 +
** Add keyword values to Gifting table.
 +
** Recipes for the keyword [[:Category:Items/Crystal|Crystal]] are numerous and clog the readability of some recipe outputs (notably those for [[Vervadium]], [[Glowy Yellow Crystal]], and [[Winterprize]]).  Separate these out. Also separate out the keywords [[:Category:Items/CheapMeat|CheapMeat]], [[:Category:Items/Equipment|Equipment]], and the various keywords for each equipment slot, not counting the belt or racial slot (these two slots do not have analagous keywords, augementation recipes, or shamanic infusion recipes), namely [[:Category:Items/MainHand|MainHand]], [[:Category:Items/OffHand|OffHand]], [[:Category:Items/Head|Head]], [[:Category:Items/Chest|Chest]], [[:Category:Items/Legs|Legs]], [[:Category:Items/Hands|Hands]], [[:Category:Items/Feet|Feet]], [[:Category:Items/Necklace|Necklace]], [[:Category:Items/Ring|Ring]].  Also the keyword [[:Category:Items/Shield|Shield]], due to the many shield-wax recipes should be separated.
 +
** Items with zero value like temporary fairy items should not produce information that they make good gifts.
 +
** Add some more info for some recipe results, including Meditation, Calligraphy, and recipes that produce CraftingEnhanceItem or AddItemTSysPower ResultEffects (will parse the description string and make the most (subjectively, i guess) important parts bold for ease of reading).  Also fix the recipe for Rum-Glazed Shrimp, the only recipe (as of v338) to use the ResultEffects ConsumeItemUses, which should convey that it consumes only 2 doses of the rum barrel (it already says this in the description, but Allybot's recipe output doesn't display that info).
 +
** Recipes that don't behave deterministically, such as those that produce Surveying and Treasure Cartography maps (ResultEffects start with "Create"), as well as those that generate any enchanted item (ResultEffects are TSysCraftedEquipment or GiveTSysItem -- these are exactly those recipes (as of v338) which have "ProtoResults"), do not display properly or at all (the result item is missing). Also applies to ExtractTSysPower (extract augment recipes) which should display the augment type they create, e.g. [[Main-Hand Augment]].
 +
** Guild quests for keyword item (e.g. the prisms in [[Guild:Reclaiming_Lydia_(10-person)]]) should be found now.
 +
** Some work orders being placed in Quest Fulfillment table instead of Work Order section (happens when the work order is for an item with a given keyword instead of a specific item, e.g. the Lead Figurine work order. In addition to displaying incorrectly, this generates broken links. See, e.g. [[Lead_Figurine_of_an_Ogre#Quest_Fulfillment]].)
 +
** With addition of ability pages, ability consumption section can link to abilities.
 +
** Edibles page should display skills correctly now (i.e. [[Ice Conjuration]] instead of (linkless) IceConjuration).
 +
** Meals, Snacks, and Instant-Snacks pages should have <nowiki>{{Item|}}</nowiki> Template replaced, so they can be embedded in the Gourmand page without exceeding the transclusion (node) limit.
 +
** Recipes that produce poisoned foods will no longer have erroneous links to the non-poisoned food pages. Instead in place of a link, there will be text reading 'Poisoned Food (no wiki page)'.
 +
*100: First version run 9/16/2020.
 +
 
 +
=== Scope ===
 +
* Currently handles all item pages, apart from those where two items have the same name (a handful of these are handled by a special case, since they were deemed too important to skip). This functionality can be added in the future.
 +
* Skips items with "EquipSlot:" and with "Lint_NotObtainable" in "Keywords" (because they are numerous, and generally uninteresting since they can't be obtained in game by any normal means). Most of these do not have wiki pages at all, with the exception of a few admin items, the starting underwear, and a few other random uninteresting items (or maybe this is one of those 'only interesting because it would otherwise be uniquely uninteresting in a swath of interesting' type of deals (see https://en.wikipedia.org/wiki/Interesting_number_paradox), but probably not) like [[HumanClothBoots1]].
 +
=== Known Bugs/Potential Improvements ===
 +
* High Priority (will be fixed soon)
 +
* Medium Priority (may be added eventually if i have spare time)
 +
** Wintria and Hirochi don't show their preferences in the Gifting section for textbooks, as they appear to accept only crafted textbooks for favor, and the bot doesn't parse this information as of now.
 +
** Notes about unobtainable (Lint_NotObtainable) items, to avoid confusion (although this info is already present in the item infobox)
 +
** Does not correctly find all npc names that it should (affects Quests section)
 +
** Recipe scroll information can be extracted from sources_recipes.json for any recipe with at least one source having "Type": "Item", in which case that source's "ItemTypeId" will indicate the item teaching the recipe.
 +
* Low Priority (unlikely to be added, unless someone thinks it's important)
 +
** Sometimes the Ability Consumption script will report some misleading data, as the "AmmoDescription" in abilities.json is not always precise.  For example, Basic Shot will report consuming "Beginner's Arrow (or better)", correctly, but Multishot will report consuming "Beginner's Arrow x5" even though it can also use "(or better)" arrows.
 +
** Purchase info for work orders (from w.o. board), i.e. automatically add to Purchasing section which work order board the work order can be purchased from (info is currently available at the page for the item in the Quest Fulfillment section; this would add the info also to Purchasing section at the page for the work order for the item.
 +
 
 +
== Other Projects ==
 +
* Updating [[Merchants]].
 +
** Completed:
 +
*** Basic restructuring via templates.
 +
*** Added/converted rows for all vendors on what was Category:Vendor (now [[:Category:Shopkeeper]]).
 +
*** Prettying it up
 +
**** Left/right/mid alignments
 +
**** Recoloring of region name bars
 +
** To do:
 +
*** Confirmation and data entry (ongoing).  All help is greatly appreciated :)
 +
* Maintaining [[Nature_Appreciation#Bouquets,_Arrangements,_and_Displays]] section. I have a script to generate most of the data.
 
* Future project(s):
 
* Future project(s):
 +
** Sidebar page.  Some info already available: [[User:Alleryn/Sandbox/Sidebar_Abilities]]
 +
** Updates to [[Fairy]] page. Scripts to generate info on FaeMetalArmor and Help the Hive Quests
 
** <s>Update Bartering templates to use <nowiki>{{msg:BASEPAGENAME}}</nowiki></s> (It turns out this was a bad idea, because it didn't play well with dpl).
 
** <s>Update Bartering templates to use <nowiki>{{msg:BASEPAGENAME}}</nowiki></s> (It turns out this was a bad idea, because it didn't play well with dpl).
 
==Scripts==
 
I have scripts stored locally (i.e. on my computer) to create the following sections.  Please contact me if you discover errors or have requests relating to any of these:
 
* [[Hardcore_Mode#List_of_Items_Usable_Only_in_Hardcore_Mode]]
 
* [[Template:Attribute]] and [[Template:Attribute label]]
 
* [[Gourmand/Edibles]], [[Gourmand/Meals]], [[Gourmand/Snacks]], [[Gourmand/Instant-Snacks]]
 
  
 
==Notes==
 
==Notes==
 
Putting this here because i'm not sure where to put it:
 
Putting this here because i'm not sure where to put it:
* There are some idiosyncrasies between various usages of keywords.  One thing to notice is that recipes.json and npcs.json use a keyword of the form "EquipmentSlot:x", e.g., "EquipmentSlot:Ring".  There are even some npcs who like items with the keyword "Ring" and others who like items with the keyword "EquipmentSlot:Ring". However items.json does not have any keywords like "EquipmentSlot:x".  Items instead will usually (or maybe always) have two identical keywords, for example most (or all rings) have "Ring" listed twice in their keywords (and similarly for other slots).  Here on the wiki, there is just one item category for Ring.
+
* There are some idiosyncrasies between various usages of keywords.  One thing to notice is that recipes.json and npcs.json sometimes use a keyword of the form "EquipmentSlot:x", e.g., "EquipmentSlot:Ring".  There are even some npcs who like items with the keyword "Ring" and others who like items with the keyword "EquipmentSlot:Ring". However items.json does not have any keywords like "EquipmentSlot:x".  Items instead will usually (or maybe always) have two identical keywords, for example most (or all rings) have "Ring" listed twice in their keywords (and similarly for other slots).  Here on the wiki, there is just one item category for Ring.
  
 
==Other Info==
 
==Other Info==
 
If you are curious what i'm <s>failing horribly to get working</s> ingeniously figuring out how to do, you can check out my [[/Sandbox]].  (Really this link is mostly here for my own convenience).
 
If you are curious what i'm <s>failing horribly to get working</s> ingeniously figuring out how to do, you can check out my [[/Sandbox]].  (Really this link is mostly here for my own convenience).

Latest revision as of 10:24, 24 October 2021

Last updated September 2020

Introduction

I'm alleryn in PG. Welcome to my user page. Feel free to contact me in-game, on the Discord at alleryn#6872, or on my talk page.

AllyBot

Maintains:

AllyBot is on GitHub: https://github.com/alleryn/ProjectGorgonWiki-AllyBot

Version History

  • 119: Updating to v352. Run 10/24/2021 (after a slight delay of a week or so on alleryn's part).
  • 118: Updating to v351. Added some NPC location inof. Run 10/5/2021.
  • 117: Now maintains xp tables.
  • 116: Updating to v350. Also fixed bug with whittling recipes and updated some NPC location info. Run 9/29/2021.
  • 115: Updating to v349. Run 9/27/2021.
  • 114: Updating to v348. Run 7/4/2021. No changes.
  • 113: Updating to v347. Run 7/4/2021.
  • 112: Bugfix: work order council rewards working again after change to quests.json in v345. Run 5/26/2021.
  • 111: Updating to v346. Run 5/25/2021. No changes.
  • 110: Updating to v345. Run 5/25/2021.
  • 109: Updating to v344. Run 4/22/2021. No changes.
  • 108: Updating to v343. Run 4/22/2021. No changes.
  • 107: Updating to v342. Run 3/26/2021.
  • 106: Minor bugfix. Run 12/15/2020.
  • 105: Minor bugfix and added functionality. Run 12/15/2020.:
  • 104: Updating to v341. Run 12/11/2020.
  • 103: Updating to v340. Run 11/7/2020.
  • 102: Updating to v339. Run 10/15/2020.
  • 101: Bugfixes run 10/4/2020:
    • Add keyword values to Gifting table.
    • Recipes for the keyword Crystal are numerous and clog the readability of some recipe outputs (notably those for Vervadium, Glowy Yellow Crystal, and Winterprize). Separate these out. Also separate out the keywords CheapMeat, Equipment, and the various keywords for each equipment slot, not counting the belt or racial slot (these two slots do not have analagous keywords, augementation recipes, or shamanic infusion recipes), namely MainHand, OffHand, Head, Chest, Legs, Hands, Feet, Necklace, Ring. Also the keyword Shield, due to the many shield-wax recipes should be separated.
    • Items with zero value like temporary fairy items should not produce information that they make good gifts.
    • Add some more info for some recipe results, including Meditation, Calligraphy, and recipes that produce CraftingEnhanceItem or AddItemTSysPower ResultEffects (will parse the description string and make the most (subjectively, i guess) important parts bold for ease of reading). Also fix the recipe for Rum-Glazed Shrimp, the only recipe (as of v338) to use the ResultEffects ConsumeItemUses, which should convey that it consumes only 2 doses of the rum barrel (it already says this in the description, but Allybot's recipe output doesn't display that info).
    • Recipes that don't behave deterministically, such as those that produce Surveying and Treasure Cartography maps (ResultEffects start with "Create"), as well as those that generate any enchanted item (ResultEffects are TSysCraftedEquipment or GiveTSysItem -- these are exactly those recipes (as of v338) which have "ProtoResults"), do not display properly or at all (the result item is missing). Also applies to ExtractTSysPower (extract augment recipes) which should display the augment type they create, e.g. Main-Hand Augment.
    • Guild quests for keyword item (e.g. the prisms in Guild:Reclaiming_Lydia_(10-person)) should be found now.
    • Some work orders being placed in Quest Fulfillment table instead of Work Order section (happens when the work order is for an item with a given keyword instead of a specific item, e.g. the Lead Figurine work order. In addition to displaying incorrectly, this generates broken links. See, e.g. Lead_Figurine_of_an_Ogre#Quest_Fulfillment.)
    • With addition of ability pages, ability consumption section can link to abilities.
    • Edibles page should display skills correctly now (i.e. Ice Conjuration instead of (linkless) IceConjuration).
    • Meals, Snacks, and Instant-Snacks pages should have {{Item|}} Template replaced, so they can be embedded in the Gourmand page without exceeding the transclusion (node) limit.
    • Recipes that produce poisoned foods will no longer have erroneous links to the non-poisoned food pages. Instead in place of a link, there will be text reading 'Poisoned Food (no wiki page)'.
  • 100: First version run 9/16/2020.

Scope

  • Currently handles all item pages, apart from those where two items have the same name (a handful of these are handled by a special case, since they were deemed too important to skip). This functionality can be added in the future.
  • Skips items with "EquipSlot:" and with "Lint_NotObtainable" in "Keywords" (because they are numerous, and generally uninteresting since they can't be obtained in game by any normal means). Most of these do not have wiki pages at all, with the exception of a few admin items, the starting underwear, and a few other random uninteresting items (or maybe this is one of those 'only interesting because it would otherwise be uniquely uninteresting in a swath of interesting' type of deals (see https://en.wikipedia.org/wiki/Interesting_number_paradox), but probably not) like HumanClothBoots1.

Known Bugs/Potential Improvements

  • High Priority (will be fixed soon)
  • Medium Priority (may be added eventually if i have spare time)
    • Wintria and Hirochi don't show their preferences in the Gifting section for textbooks, as they appear to accept only crafted textbooks for favor, and the bot doesn't parse this information as of now.
    • Notes about unobtainable (Lint_NotObtainable) items, to avoid confusion (although this info is already present in the item infobox)
    • Does not correctly find all npc names that it should (affects Quests section)
    • Recipe scroll information can be extracted from sources_recipes.json for any recipe with at least one source having "Type": "Item", in which case that source's "ItemTypeId" will indicate the item teaching the recipe.
  • Low Priority (unlikely to be added, unless someone thinks it's important)
    • Sometimes the Ability Consumption script will report some misleading data, as the "AmmoDescription" in abilities.json is not always precise. For example, Basic Shot will report consuming "Beginner's Arrow (or better)", correctly, but Multishot will report consuming "Beginner's Arrow x5" even though it can also use "(or better)" arrows.
    • Purchase info for work orders (from w.o. board), i.e. automatically add to Purchasing section which work order board the work order can be purchased from (info is currently available at the page for the item in the Quest Fulfillment section; this would add the info also to Purchasing section at the page for the work order for the item.

Other Projects

  • Updating Merchants.
    • Completed:
      • Basic restructuring via templates.
      • Added/converted rows for all vendors on what was Category:Vendor (now Category:Shopkeeper).
      • Prettying it up
        • Left/right/mid alignments
        • Recoloring of region name bars
    • To do:
      • Confirmation and data entry (ongoing). All help is greatly appreciated :)
  • Maintaining Nature_Appreciation#Bouquets,_Arrangements,_and_Displays section. I have a script to generate most of the data.
  • Future project(s):
    • Sidebar page. Some info already available: User:Alleryn/Sandbox/Sidebar_Abilities
    • Updates to Fairy page. Scripts to generate info on FaeMetalArmor and Help the Hive Quests
    • Update Bartering templates to use {{msg:BASEPAGENAME}} (It turns out this was a bad idea, because it didn't play well with dpl).

Notes

Putting this here because i'm not sure where to put it:

  • There are some idiosyncrasies between various usages of keywords. One thing to notice is that recipes.json and npcs.json sometimes use a keyword of the form "EquipmentSlot:x", e.g., "EquipmentSlot:Ring". There are even some npcs who like items with the keyword "Ring" and others who like items with the keyword "EquipmentSlot:Ring". However items.json does not have any keywords like "EquipmentSlot:x". Items instead will usually (or maybe always) have two identical keywords, for example most (or all rings) have "Ring" listed twice in their keywords (and similarly for other slots). Here on the wiki, there is just one item category for Ring.

Other Info

If you are curious what i'm failing horribly to get working ingeniously figuring out how to do, you can check out my /Sandbox. (Really this link is mostly here for my own convenience).