From 21dee0039eab8fe62f85d7da68072391288db10c Mon Sep 17 00:00:00 2001 From: Bill Niblock Date: Wed, 21 May 2025 14:19:17 -0400 Subject: [PATCH] Upload some documentation --- Docs/DESIGN.md | 15 + Docs/Dialog/Inventory.md | 293 ++++++++++++++++-- Docs/Journal/VBND_OTC_ClerksFavor1.md | 32 ++ Docs/Journal/VBND_OTC_ClerksFavor2.md | 3 + Docs/Journal/VBND_OTC_ClerksFavor3.md | 3 + Docs/Objects/vbnd_AdvancementLetter_Member.md | 18 ++ .../Objects/vbnd_AdvancementLetter_Partner.md | 18 ++ Docs/Objects/vbnd_OtherworldlyLedger.md | 13 + Docs/todo.md | 21 +- 9 files changed, 385 insertions(+), 31 deletions(-) create mode 100644 Docs/Journal/VBND_OTC_ClerksFavor1.md create mode 100644 Docs/Journal/VBND_OTC_ClerksFavor2.md create mode 100644 Docs/Journal/VBND_OTC_ClerksFavor3.md create mode 100644 Docs/Objects/vbnd_AdvancementLetter_Member.md create mode 100644 Docs/Objects/vbnd_AdvancementLetter_Partner.md create mode 100644 Docs/Objects/vbnd_OtherworldlyLedger.md diff --git a/Docs/DESIGN.md b/Docs/DESIGN.md index 964b2d0..50caa25 100644 --- a/Docs/DESIGN.md +++ b/Docs/DESIGN.md @@ -103,6 +103,21 @@ money the NPC has can also increase as the player's rank increases. At every rank increase, the NPC gold increases (it's like a credit limit!), and at every "title change" (Customer -> Partner -> Member) the quality of gear improves. +--- + +The implementation is to increase the player's "credit limit" (ie., the NPC gold +available to buy things) increases Ranks 1-6, maxing out at 700gp. Upon the +"title" changes (Customer -> Partner -> Member), the Clerk's inventory improves +in quality. Initially, the Clerk's inventory is extremely limited, and is +expanded through Trade Contracts, one of the quest types offered. The other +quest types offered are delivery quests and fetch quests. + +1. **Trade Contracts:** Contracts expand the Clerk's inventory. + +2. **Package Delivery:** Bring a package to a merchant, get paid, earn rep. + +3. **Fetch Package:** Receive a package from a merchant for the Clerk, earn rep. + ### Book - Quests ### Merchant - Inventory diff --git a/Docs/Dialog/Inventory.md b/Docs/Dialog/Inventory.md index a6845e1..f47a7e0 100644 --- a/Docs/Dialog/Inventory.md +++ b/Docs/Dialog/Inventory.md @@ -1,6 +1,6 @@ -# Otherworldly Inventory Dialog +# Otherworldly Clerk -The "Otherworldly Inventory" (`vbnd_OtherworldlyInventory`) is the basic and +The "Otherworldly Clerk" (`vbnd_OtherworldlyClerk_{1-6}`) is the basic and unfair summonable store. Initially only a dialog box, when the player gets access to the Trade House, they can speak with the actual NPC behind the words. @@ -11,38 +11,287 @@ access to the Trade House, they can speak with the actual NPC behind the words. organization. - `^PCRank` the PC's faction rank in the speaker's faction -## Greetings +## Greeting 0 -### Basic +These greetings are used for notifying the player when the Clerk improves. With +every rank up, the actual NPC is swapped out for a new one, allowing the dialog +checks to make use of the "TalkedToPC" value being 0 again. Every first-time +dialog will either be notification that the player's "credit rating" has +improved (ie., the clerk has more gold for buying items), or that the clerk's +inventory has improved. -- "Welcome ^PCRank ^VBND_MerchantNumber, how may we assist you today?" +### TalkedToPC = 0 -### Rank > 3 +Congratulations ^PCRank ^VBND_MerchantNumber, due to your continued patronage I +am excited to share that your credit rating with the Otherworldly Trade Caravan +has improved! -- "A pleasure as always, ^PCRank ^VBND_MerchantNumber! How may we assist you - today?" +### vbnd_OtherworldlyClerk_1 && TalkedToPC = 0 -### Rank > 6 +Welcome to the Otherworldly Trade Caravan, ^PCRank ^VBND_MerchantNumber. I am +Clerk 119, and have been assigned to assist you with our basic trade services. +If you have any questions, they are likely answered within your ledger, but I +may be able to offer additional assistance with some Caravan details. -- "It is truly an honor, ^PCRank ^VBND_MerchantNumber. How may I assist you - today?" +### vbnd_OtherworldlyClerk_3 && TalkedToPC = 0 -### In-Person +Congratulations, ^PCRank ^VBND_MerchantNumber. Your loyalty once again increases +your credit limit with us, and I am also pleased to offer you higher quality and +expanded stock! -**On First Interaction:** +### vbnd_OtherworldlyClerk_6 && TalkedToPC = 0 -- "Yes, I am an actual person. This surprises many, and alarms even a few. Our - professionalism is second-to-none, rest assured. How may I assist you, ^PCRank - ^PCName?"o +It is a great honor, ^PCRank ^VBND_MerchantNumber. In recognition of your +loyalty, the Otherworldly Trade Caravan has improved your credit limit to the +maximum allowable through our basic trade services. In addition, I have improved +the quality of my stock yet again. I also have been permitted to work with any +trade contracts you may establish. I am happy to answer any questions you have +regarding trade contracts, and your ledger will have information as well. -**On Following Interactions:** +## Greeting 1 -- "Welcome back, ^PCRank. How may I assist you today?" +These are the general greetings, used for all normal greetings that do not +include asking for favors or informing the player of improvements of service. -## About Me +### Rank 1-2 -- "I am clerk 119 of the Otherworldly Trade Caravan." +Welcome ^PCRank ^VBND_MerchantNumber, how may we assist you today? -## About the Otherworldly Trade Caravan +### Rank 3-5 -- "We are an organization promoting trade and commerce throughout the realms." +A pleasure as always, ^PCRank ^VBND_MerchantNumber! How may we assist you today? + +### Rank 6-9 + +It is truly an honor, ^PCRank ^VBND_MerchantNumber. How may I assist you today? + +### In-Person - First Time + +Yes, I am an actual person. This surprises many, and alarms even a few. Our +professionalism is second-to-none, rest assured. How may I assist you, ^PCRank +^PCName? + +### In-Person - Generic + +Welcome back, ^PCRank. How may I assist you today? + +## Topics + +### Clerk + +Yes, clerks are the primary means by which our customers interact with the +Caravan, responsible for the day-to-day business in the Trade Houses and through +remote ledgers. We clerks prefer to remain anonymous, referring to each other by +our numbers, so as to keep things professional and impersonal. The Otherworldly +Trade Caravan prides itself on quality interactions, and that begins with us +clerks! + +### Favor + +^PCRank ^VBND_MerchantNumber, would you be interested in assisting me with a +favor? + +> This updates the journal with ClerksFavor1 entry 10 + +### Another Favor + +This is dialog that initializes the second delivery quest. + +> This updates the journal with ClerksFavor2 entry 10 + +## Favors (Quests) + +Favors are quests given by the clerk. For the early ranks, there are two ways to +improve rank: trading, and favors. Each favor involves delivering a package to +an existing merchant on Vvardenfell, receiving cash-on-delivery, naturally. + +The first three favors will rank the player up to unlocking the personalized +merchant, who also offers quests. However, the clerk will continue to offer some +additional delivery quests, based on rank. + +### Favor - First (Rank 2) + +#### Favor && Journal ClerksFavor1 10 + +The Otherworldly Trade Caravan has received a delivery request for the merchant +MERCHANT at MERCHANT_LOCATION. Assisting the Otherworldly Trade Caravan in this +matter will reflect well on your standing. + +Choice: "Of course, how can I help out?" 1 "Sorry, I am unable to help out right +now." 2 + +> choice 1: this updates the journal with clerksfavor1 entry 20 + +please bring this package to them at your +earliest convenience. you will be paid cash upon delivery, and the otherworldly +trade caravan will recognize your assistance with gratitude. + +> choice 2: this updates the journal with clerksfavor1 entry 90 + +i understand, ^pcrank ^vbnd_merchantnumber. if you change your mind, just let me +know. + +#### Favor && Journal ClerksFavor1 20 + +Do you have an update on the delivery for MERCHANT? + +Choice: "The delivery is complete" 3 "I have not completed the delivery yet" 4 + +> Choice 3: This updates the journal with ClerksFavor1 entry 40 + +[ Player no longer has package ] + +Thank you, ^PCRank ^VBND_MerchantNumber. The Otherworldly Trade Caravan, and +this humble clerk, appreciates your assistance with this matter. + +[ Player still has package ] + +Pardon me, ^PCRank ^VBND_MerchantNumber, but it appears the package for delivery +is still in your possession. Please notify me once the package has been +delivered to MERCHANT. + +> Choice 4: This does not modify the journal entry + +Very well, how else may I assist you, ^PCRank ^VBND_MerchantNumber? + +#### Favor && Journal ClerksFavor1 90 + +Have you reconsidered assisting the Otherworldly Trade Caravan with a favor? + +Choice: "Yes" 1 "Sorry, I still am unable to assist" 4 + +### Another Favor - Second (Rank 2) + +#### Another Favor && Journal ClerksFavor2 10 + +Would you be willing to do a another favor for me, ^PCRank ^VBND_MerchantNumber? +Assisting the Otherworldly Trade Caravan in this matter will reflect well on +your standing. + +Choice: "Of course, how can I help out?" 1 "Sorry, I am unable to help out right +now." 2 + +> Choice 1: This updates the journal with ClerksFavor2 entry 20 + +The Otherworldly Trade Caravan has received a delivery request for the merchant +MERCHANT at MERCHANT_LOCATION. Please bring this package to them at your +earliest convenience. You will be paid cash upon delivery, and the Otherworldly +Trade Caravan will recognize your assistance with gratitude. + +> Choice 2: This updates the journal with ClerksFavor2 entry 90 + +I understand, ^PCRank ^VBND_MerchantNumber. If you change your mind, just let me +know. + +#### Another Favor && Journal ClerksFavor2 20 + +Do you have an update on the delivery for MERCHANT? + +Choice: "The delivery is complete" 3 "I have not completed the delivery yet" 4 + +> Choice 3: This updates the journal with ClerksFavor2 entry 30 + +[ Player no longer has package ] + +Thank you, ^PCRank ^VBND_MerchantNumber. The Otherworldly Trade Caravan, and +this humble clerk, appreciates your assistance with this matter. + +[ Player still has package ] + +Pardon me, ^PCRank ^VBND_MerchantNumber, but it appears the package for delivery +is still in your possession. Please notify me once the package has been +delivered to MERCHANT. + +> Choice 4: This does not modify the journal entry + +Very well, how else may I assist you, ^PCRank ^VBND_MerchantNumber? + +#### Another Favor && Journal ClerksFavor2 90 + +Have you reconsidered assisting the Otherworldly Trade Caravan with another +favor? + +Choice: "Yes" 5 "Sorry, I still am unable to assist" 6 + +> Choice 5: This updates the journal with ClerksFavor2 entry 20 + +The Otherworldly Trade Caravan has received a delivery request for the merchant +MERCHANT at MERCHANT_LOCATION. Please bring this package to them at your +earliest convenience. You will be paid cash upon delivery, and the Otherworldly +Trade Caravan will recognize your assistance with gratitude. + +> Choice 6: This does not change the journal entry + +Very well, how else may I assist you, ^PCRank ^VBND_MerchantNumber? + +### A Third Favor - Third (Rank 2) + +#### A Third Favor && Journal ClerksFavor3 10 + +I have a third favor you can assist with, ^PCRank ^VBND_MerchantNumber? +Assisting the Otherworldly Trade Caravan in this matter will reflect well on +your standing. + +Choice: "Of course, how can I help out?" 1 "Sorry, I am unable to help out right +now." 2 + +> Choice 1: This updates the journal with ClerksFavor3 entry 20 + +The Otherworldly Trade Caravan has received a delivery request for the merchant +MERCHANT at MERCHANT_LOCATION. Please bring this package to them at your +earliest convenience. You will be paid cash upon delivery, and the Otherworldly +Trade Caravan will recognize your assistance with gratitude. + +> Choice 2: This updates the journal with ClerksFavor3 entry 90 + +I understand, ^PCRank ^VBND_MerchantNumber. If you change your mind, just let me +know. + +#### A Third Favor && Journal ClerksFavor3 20 + +Do you have an update on the delivery for MERCHANT? + +Choice: "The delivery is complete" 3 "I have not completed the delivery yet" 4 + +> Choice 3: This updates the journal with ClerksFavor3 entry 30 + +[ Player no longer has package ] + +Thank you, ^PCRank ^VBND_MerchantNumber. The Otherworldly Trade Caravan, and +this humble clerk, appreciates your assistance with this matter. + +[ Player still has package ] + +Pardon me, ^PCRank ^VBND_MerchantNumber, but it appears the package for delivery +is still in your possession. Please notify me once the package has been +delivered to MERCHANT. + +> Choice 4: This does not modify the journal entry + +Very well, how else may I assist you, ^PCRank ^VBND_MerchantNumber? + +#### A Third Favor && Journal ClerksFavor3 90 + +Have you reconsidered assisting the Otherworldly Trade Caravan with another +favor? + +Choice: "Yes" 5 "Sorry, I still am unable to assist" 6 + +> Choice 5: This updates the journal with ClerksFavor3 entry 20 + +The Otherworldly Trade Caravan has received a delivery request for the merchant +MERCHANT at MERCHANT_LOCATION. Please bring this package to them at your +earliest convenience. You will be paid cash upon delivery, and the Otherworldly +Trade Caravan will recognize your assistance with gratitude. + +> Choice 6: This does not change the journal entry + +Very well, how else may I assist you, ^PCRank ^VBND_MerchantNumber? + +### Favor - Fourth (Rank 4) + +### Favor - Fifth (Rank 7) + +### Favor - Sixth (Rank 8) + +### Favor - Seventh (Rank 9) diff --git a/Docs/Journal/VBND_OTC_ClerksFavor1.md b/Docs/Journal/VBND_OTC_ClerksFavor1.md new file mode 100644 index 0000000..ccda136 --- /dev/null +++ b/Docs/Journal/VBND_OTC_ClerksFavor1.md @@ -0,0 +1,32 @@ +# A Clerk's Favor + +The first delivery quest for the clerk. + +## Entry 0 + +[Name] + +A Clerk's Favor + +## Entry 10 + +Clerk 119 has asked a favor of me. + +## Entry 20 + +I've offered to help Clerk 119 with a favor, and deliver a package to MERCHANT +at MERCHANT_LOCATION. I will be paid by MERCHANT upon delivery. + +## Entry 30 + +I've delivered the package to MERCHANT. I should let Clerk 119 know. + +## Entry 40 + +[Finished] + +I've notified Clerk 119 that I've completed the delivery. + +## Entry 90 + +Clerk 119 asked a favor of me, but I have declined to help them at this time. diff --git a/Docs/Journal/VBND_OTC_ClerksFavor2.md b/Docs/Journal/VBND_OTC_ClerksFavor2.md new file mode 100644 index 0000000..eb0be67 --- /dev/null +++ b/Docs/Journal/VBND_OTC_ClerksFavor2.md @@ -0,0 +1,3 @@ +# Another Favor for a Clerk + +The second delivery quest. diff --git a/Docs/Journal/VBND_OTC_ClerksFavor3.md b/Docs/Journal/VBND_OTC_ClerksFavor3.md new file mode 100644 index 0000000..73d498b --- /dev/null +++ b/Docs/Journal/VBND_OTC_ClerksFavor3.md @@ -0,0 +1,3 @@ +# A Third Favor for a Clerk + +Third delivery quest. diff --git a/Docs/Objects/vbnd_AdvancementLetter_Member.md b/Docs/Objects/vbnd_AdvancementLetter_Member.md new file mode 100644 index 0000000..3c2ed24 --- /dev/null +++ b/Docs/Objects/vbnd_AdvancementLetter_Member.md @@ -0,0 +1,18 @@ +
+The Otherworldly Trade Caravan is pleased to inform you that we recognize you as +a Member of the Trade Caravan.
+
+
+
+Your significant use of our services, as well as positive, and impressive, +feedback from your personalized merchant, has impressed us. We have established +a small Trade House within our dimensional spaces for use by you, your Clerk +(herein recognized as Clerk 119), and your personalized merchant (herein +recognized as SOME COOL SOUNDING NAME). We entrust this Trade House to you, and +look forward to your continued investment in our services. You can access your +Trade House by using your Ledger, as you have accessed our basic trade services +and personalized merchant services.
+
+We look forward to providing you with our quality services. Please reference +your Ledger, or reach out to your assigned Clerk, if you have any questions, +comments, or concerns.
diff --git a/Docs/Objects/vbnd_AdvancementLetter_Partner.md b/Docs/Objects/vbnd_AdvancementLetter_Partner.md new file mode 100644 index 0000000..89775ca --- /dev/null +++ b/Docs/Objects/vbnd_AdvancementLetter_Partner.md @@ -0,0 +1,18 @@ +
+The Otherworldly Trade Caravan is pleased to inform you that we recognize you as +a Partner of the Trade Caravan.
+
+
+
+Your continued use of our services will be enhanced by the assignment of one of +our personalized merchants to your account. You can access them by using your +Ledger, as you have accessed our basic trade services. Our personalized +merchants go above-and-beyond our basic services, offering more specialized and +unique items, with a higher credit limit. Our personalized merchants are some of +the most talented and capable traders in all the realms, and often facilitate +additional trade deals between our Partners and Members to the benefit of all +parties involved.
+
+We look forward to providing you with our quality services. Please reference +your Ledger, or reach out to your assigned Clerk, if you have any questions, +comments, or concerns.
diff --git a/Docs/Objects/vbnd_OtherworldlyLedger.md b/Docs/Objects/vbnd_OtherworldlyLedger.md new file mode 100644 index 0000000..924fa58 --- /dev/null +++ b/Docs/Objects/vbnd_OtherworldlyLedger.md @@ -0,0 +1,13 @@ +# The Ledger + +The main source of information on The Otherworldly Trade Caravan. + +## Text + +

+A Strange Ledger +


+This is a ledger, scribed in a script that you've never seen before. Someone has +penned some notes in the margins...
+

+Summons a merchant! Wow!
diff --git a/Docs/todo.md b/Docs/todo.md index 4604dcc..765ce81 100644 --- a/Docs/todo.md +++ b/Docs/todo.md @@ -14,17 +14,20 @@ - [ ] Add logic for enabling/disabling on rank-up - [ ] Setup counter at Trade House - BLOCKED: Awaiting Trade House implementation + - [ ] Inventories + - [ ] Add initial inventory for Clerks 1, 3, and 6 + - Should have some remnants from previous tier (for 3 and 6) + - [ ] Add logic to move the clerk items: + - [ ] from 1 to 2 + - [ ] from 3 to 4 + - [ ] from 4 to 5 + - [ ] Update dialog/information to reflect how this all works - [ ] Quests and Rank Mechanics - - [ ] Some way to track barter interactions - - Tracking how much gold the player exchanges (in either direction) - with the Clerk goes to a counter. After a certain amount, it ranks - up the player. Like an alternate way to level up, through pure - money, instead of doing quests? - - [ ] Fetch/Delivery Quests + - [X] Trade Contracts + - [ ] Delivery Quests - The Clerk asks the player, on behalf of the Otherworldly Trade - Caravan, to fetch/deliver items from existing merchants around - Tamriel. Could be neat to somehow randomize the merchant? - - Need more quest ideas!! + Caravan, to deliver items from existing merchants around + Tamriel. - [ ] Merchant - [ ] Merchant Quests