I’ve just completed an I7 extension called “Dynamic Exposition”, and I’m looking for actual programmers who know something about computers to look at it and tell me it sucks. I wrote it as a foundation for quest journals, and essentially it writes strings to entries (called expositions), allowing the player to keep a sort of database that updates itself as the player encounters and sees things. It also can print announcements when updated, generally in the form of “The entry on XYZ has been updated”. It works fairly well on the examples I wrote for it, but that doesn’t mean there aren’t some obvious mistakes.
I thought, since I couldn’t really find an I7 extension that replicates this function, this might be useful to people in some form. Since this is a creative-commons licensed thing anyway, I might as well just paste the code directly into the forum.
[spoiler][code]Version 1/170712 of the Dynamic Exposition by William S Martin begins here.
“Gives players access to a database that updates dynamically during play and announces modifications to the player. This allows easy implementations of journals, quest logs, the internet, and so forth.”
Include Epistemology by Eric Eve.
Chapter 1 - The Exposition List
All things have a list of texts called an exposition-list.
To decide if the exposition-list of (item - a thing) is blank:
let N be the exposition-list of the item;
let X be the number of entries in N;
if X is 0:
decide yes;
else:
decide no.
Definition: A thing is researchable:
if the exposition-list of it is blank, decide no;
decide yes.
Chapter 2 - Printing the Exposition
The display records rules is a rulebook.
Printing the exposition of something is an activity.
Rule for printing the exposition of something (called the item):
say “You look up information on [the item]:[paragraph break]”;
print the exposition of the item.
To print the exposition of (the item - a thing), as one paragraph:
let the current exposition be the exposition-list of the item;
if as one paragraph:
repeat with X running through the current exposition:
say X;
else:
repeat with X running through the current exposition:
say X;
say “[paragraph break]”.
A display records rule:
carry out the printing the exposition activity with the noun.
Chapter 3 - Writing the Exposition
To write (addition - a text) for the topic (current subject - a thing), silently, at the beginning:
let current exposition be the exposition-list of the current subject;
let N be the number of entries in the current exposition;
if at the beginning:
add addition at entry 1 in the exposition-list of the current subject;
else:
add addition to the exposition-list of the current subject;
if silently:
do nothing;
else:
mark current subject for announcement.
Chapter 4 - Researching action
Researching it on is an action applying to one visible thing and one touchable thing.
A thing can be expository. A thing is usually not expository.
Does the player mean researching something on an expository thing: it is very likely.
Rule for deciding the scope of the player while researching:
repeat with X running through known things:
place X in scope.
Understand “read about [something] in [something]” as researching it on when the second noun is an expository thing. Understand “look up [something] in [something]” as researching it on when the second noun is an expository thing. Understand “consult [something] on/about [something]” as researching it on (with nouns reversed) when the second noun is an expository thing. Understand "read [something] in [something]"as researching it on when the second noun is an expository thing. Understand “research [something] on/about [something]” as researching it on (with nouns reversed). Understand “research [something] in [something]” as researching it on.
Understand “research on/about/-- [something]” as researching it on. Understand “read on/about/-- [something]” as researching it on. Understand “look up [something]” as researching it on. Understand “r [something]” as researching it on.
Check researching it on (this is the only can research on an expository thing rule):
if the second noun is not an expository thing:
say “You can’t use [the second noun] like that.” instead.
Check researching it on (this is the only can research researchable objects rule):
if the noun is not researchable:
say “There is no entry about that.” instead.
Report researching it on:
follow the display records rulebook.
The default-expository is a thing that varies.
Rule for supplying a missing second noun while researching:
let N be the default-expository;
now the second noun is N.
Chapter 5 - Reporting Additions to the Expository
The announcement queue is a list of objects that varies.
To mark (item - a thing) for announcement:
if the item is not listed in the announcement queue:
add item to the announcement queue.
Carry out looking (this is the mark items to expository announce when looking rule):
unless in darkness:
repeat with item running through things that are enclosed by the location:
if the item is not enclosed by an opaque closed container:
if the item is unseen and the item is researchable:
mark item for announcement.
The mark items to expository announce when looking rule is listed before the mark items as seen when looking rule in the carry out looking rules.
Carry out opening a container (this is the mark items to expository announce on opening a container rule):
repeat with item running through things that are enclosed by the noun:
if the item is unseen and the item is visible:
if the item is researchable:
mark item for announcement.
The mark items to expository announce on opening a container rule is listed before the mark items as seen on opening a container rule in the carry out opening rules.
Toggle expoannouncements is a truth state that varies. Toggle expoannouncements is usually false.
Printing the expository announcement of something is an activity.
Rule for printing the expository announcement of something (called the subject announced):
say “[italic type]New information on '”;
carry out the printing the name activity with subject announced;
say “’ has been added to the records.[roman type]”
This is the notify expository changes rule:
if the toggle expoannouncements is true:
repeat with current subject running through announcement queue:
carry out the printing the expository announcement activity with the current subject;
repeat with current subject running through announcement queue:
remove current subject from announcement queue;
rule succeeds.
The notify expository changes rule is listed after the note object acquisitions rule in the turn sequence rules.
Version 1/120715 of Dynamic Exposition ends here.
---- DOCUMENTATION ----
Dynamic Exposition adds a dynamic database system that can be used as the basis to implement a variety of things. For example:
A) Journals, notebooks and so forth that records the player character’s thoughts and observations during play.
B) The internet, magical enyclopedias, crystal balls, Akashic records or any other device with access to a highly dynamic source of information.
C) The player’s thoughts and memories that change over time.
D) A quest log, that keeps track of things that a character needs to do. The example, the Adventures of Glubby, provides a basic framework for a quest log.
Some of these can be implemented with almost no work. For others, some assembly is required.
KNOWN ISSUE - When a researchable object is in the first room on the first turn, the game tends to print an announcement of it the turn afterward. The workaround for this is to mark the object as “seen” before the game starts, which will suppress the announcement.
Chapter: Setting up Dynamic Expositions
Dynamic journaling requires a bit of work to get full use out of it. In most circumstances, it will be better just to use the consult command to get what we need.
First, we need an expository thing. The expository thing is needed by the player to access the database. Keep in mind all expository things have access to the same database, no matter what. So it would make sense for an iPad, a computer and a smart phone to all be expository things, but it would make no sense at all for Jack’s diary and Bill’s notebook to both be expository things.
The audio recorder is here. It is expository.
Everything will now also have a list of texts called a exposition-list. This is what is printed when the researching action is finished.
The salmon is a thing. The exposition-list is {"Salmon are a sort of fish that like to swim upriver."}
The exposition-list by default is blank. The extension defines anything with a non-empty exposition-list as researchable, allowing us to make lists of researchable objects.
The index is a subject. The exposition-list is {"[list of researchable things]"}.
This allows the player to write something like LOOK UP INDEX IN BOOK and get everything the book expounds upon.
Also, it is recommended that we make at least one expository thing the default-expository. When a player doesn’t provide a second noun by default it will pick the default-expository.
This allows the player to write things like RESEARCH CHUPACABRA or even R CHUPACABRA without needing to type in something like RESEARCH DIARY ABOUT CHUPACABRA every time.
Chapter: Accessing and Writing to the Exposition
The exposition-list is “read” by using the a new researching action.
Instead of consulting the necronomicon about death, try researching the necronomicon about death.
What might the output of the above be?
You look up information on death. It reads:
"Death is a beginning and not an end"
The first part, “You look up information on death. It reads:” is not part of the exposition-list entry of the second noun. It is a text that is printed whenever the exposition is accessed and allows the us to introduce the text. This can be customized later.
The second part is the actual exposition-list entry of the second noun.
We may also make dynamic additions to any recordall text with the phrase “write (a text) for the topic (thing)”
Let’s say that the player discovers some terrible secret about death:
After consulting the encyclopedia about death for the first time, write "Legal death is when your heart stops." for the topic death.
This adds a new paragraph to your exposition for death. In general, it is a good idea to make this phrase a one-off. Doing it repeatedly for the same action is a recipe for disaster.
Before going somewhere, write "Enough of these and you'll have a massive, unreadable mess." for the topic recipe for disaster.
We do not want the above.
This phrase also has a number of options.
write "Drink to your health." for the topic beer, silently.
The “silently” option suppresses the modification announcement cause by the use of the “write” phrase. More is written about this in Chapter 4 - Announcement of Entries.
write "Drink to your health." for the topic beer, at the beginning.
By default, the phrase puts the new addition at the end of the exposition-list. This instead tacks it in the beginning.
NOTE: While the consulting and researching action use the same commands, the extension attempts to understand when you want to use the researching action and the consulting action. This extension by no means replaces the consulting action.
You can use the consulting action to simulate more static databases, like a mundane, papery encyclopedia, and still have the function of the expository.
The magic encyclopedia an expository thing.
The mundane encyclopedia is a thing.
So long as either one or the other is in scope, the game will generally understand which action to use with CONSULT THE ENCYCLOPEDIA ABOUT DRAGONS. If they are both in scope, you might want to clarify with some contextual understand commands.
Chapter: Customizing the Output
The way which expositions are displayed can be very heavily customized. The Mysteries of Mars example shows you how you can customize messages depending on what object is being expositioned about.
Rule for printing the exposition of a planet (called the current planet):
say "Classification: [classification of current planet][paragraph break]Diameter: [diameter of the current planet][paragraph break]Gravity: [gravitation pull of current planet][pargraph break]Average Temperature: [temp of current planet][paragraph break]Current records of planet:[paragraph break]";
print the exposition of the current planet;
say "END TRANSMISSION".
Whenever a new rule is written for the exposition of something, it should include the phrase “print the exposition of…”
By default, each new entry is printed as a seperate paragraph. We can, however, choose to group it in just a single paragraph by using the “as one paragraph” option with the “print exposition of” phrase.
Rule for printing the exposition of a hastily scribbled thing (called the item):
print the exposition of the item, as one paragraph.
Chapter: Announcements of Entries
Dynamic Exposition has the capacity to print an announcement every time something is written to it. By default, it is turned off, so if the feature doesn’t appeal to us, we don’t need to worry about this section at all.
If, however, we do want to play around with it, we can write in our code:
*:
The toggle expoannouncements is true.
This activates the announcement system. Every time a player sees a researchable thing for the first time, or a new entry is written to the announcement system, the game will print an announcement declaring new information is available on that subject.
If we only want certain items to be announced, we can make a new rule for items we don’t want announced and leave them blank.
Rule for printing the expository announcement of an unimportant thing:
do nothing.
The second way we can suppress a expository announcement is to use the “silently” option on the “write (text) for the topic (thing).”
We can use the same rule to play around with announcements for different things:
Rule for printing the expository announcement of an unfortunate thing:
say "As you're writing the entry in the journal, you prick your finger with the nib of your pen.";
now the player is bleeding.
This will replace the standard expository announcement and replace it with this text, in addition to making the unfortunate player bleed.
Example: ** Mysteries of Mars - Implements a very simple dynamic journal system where scanning an object writes a text to the exposition of an object. Also, demonstrates how you can vary exposition outputs and announcements depending on the object.
*: “Mysteries of Mars”
[First we craft Mars, with the magic of interactive fiction.]
The rocky hills are a room. South of the rocky hills is the martian base. North of the rocky hills is the martian desert. North of the martian desert are the craggy cliffs. North of the craggy cliffs are the ice caps.
The player is in the martian base. The player is carrying a scanotron.
The player is carrying an info-display. The info-display is an expository thing.
The default-expository is the info-display.
The toggle expoannouncements is true.
The hab-tech is a thing. It is in the martian base. It is fixed in place. It is seen. The exposition-list is {"You live in a hab-tech. They are quite plain on the inside."}. The scanned information is "Your scanotron tells you that the hab-tech is mostly made of titanium.".
Some fascinating rocks are a thing. It is in the rocky hills. The exposition-list is {"The rocks have fascinating flecks of color in them. You must investigate them."}. The scanned information is "Scans indicate high levels of crystal formations that are causing the flecks of color."
The petrified plant is a thing. It is in the martian desert. The exposition-list is {"Embedded in a rock you can see what you believe to be are ancient fronds."}. The scanned information is "Scans indicate amino acids in the rock. Your hunch about them being fossils is correct."
The massive crystal is a thing. It is fixed in place. It is in the craggy cliffs. The exposition-list is {"You discovered this fascinating blue crystal in the rocky hills."}. The scanned information is "You detected carbon within the crystals."
The alien artifact is a thing. It is fixed in place. It is in the ice caps. The exposition-list is {"The ancient (presumably Martian) baton-looking object is just a featureless metal tube."}. The scanned information is "When you scanned the object, it produced what looks like an alien script. Fascinating."
[The scanotron is our expository device here. We can create the illusion that the player is accessing an amazing hi-tech device with some rules]
Rule for printing the exposition of something when the second noun is an info-display:
say "[italic type]You search for '[the noun]' in the info-display. It prints:[roman type][paragraph break]";
print the exposition of the noun;
say "END TRANSMISSION".
[To be especially dramatic, we can use a rule for a particular artifact the player finds.]
Rule for printing the exposition of the alien artifact when the second noun is an info-display:
say "Your info-display is nearly smoking as you access information on the alien artifact.... [paragraph break]";
print the exposition of the alien artifact;
say "END TRANSMISSION".
Rule for printing the expository announcement of something (called the item) when the player carries an info-display:
say "[italic type]Your info-display beeps with new information on [the item][roman type]."
Rule for printing the expository announcement of something (called the item) while scanning and the player carries an info-display:
say "[italic type]New information on [the item] has been uploaded from the scanotron[roman type]."
Rule for printing the expository announcement of the alien artifact while the player carries an info-display:
say "BZZT! Your info-display suddenly goes haywire! It calms after a moment."
Section: Scanning
[Next we define scanning. Scanning is action that adds a string to the expository-list.]
Scanning is an action applying to one visible thing.
Understand "scan [something]" as scanning.
Check scanning:
if the actor is not carrying a scanotron:
say "You can't scan without a scanotron." instead.
Check scanning:
if the noun is scanned:
say "Your scanner detects nothing new." instead.
Check scanning:
if the noun is not researchable:
say "That object isn't interesting to scan." instead.
Carry out scanning:
let N be the scanned information of the noun;
write N for the topic noun;
now the noun is scanned.
A thing has a text called scanned information.
A thing can be scanned or unscanned. A thing is usually not scanned.
Test me with "r hab-tech / scan hab-tech / r hab-tech / n / n / n / n / r artifact / scan artifact / r artifact"
Example: *** The Adventures of Glubby - Uses the dynamic journal system as the basis for a very simple quest log, like what is found in other games. This takes record of tasks that need to be done.
*: “The Adventures of Glubby”
Section: Rules
[First, we have to turn on expository announcements]
The toggle expoannouncements is true.
[Next, we define a quest, and a number of phrases to help use manage quests]
A quest is a kind of subject. A quest can be inactive, newly started, started or finished. A quest is usually inactive.
To update (current quest - a quest) with (addition - a text):
if the current quest is not started:
do nothing;
else:
write addition for the topic current quest.
To complete (current quest - a quest) with (addition - a text):
if the current quest is not started:
do nothing;
else:
write addition for the topic current quest;
now the current quest is finished.
To start (current quest - a quest) with (addition - a text):
if the current quest is not inactive:
do nothing;
else:
write addition for the topic current quest;
now the current quest is newly started.
[To give the player encouragement, everything he does will be announced with much fan-fare.]
Rule for printing the exposition of a quest (called the current quest):
say "DUM-dee-dee-DUM! The epic [current quest] is [if current quest is started]underway[else]completed[end if]! Here is a list of your mighty achievements thus far...[paragraph break]";
print the exposition of current quest.
Rule for printing the expository announcement of a newly started quest (called the current quest):
say "DUM-dee-dee-DUM! You have a new quest... [the current quest]!";
now the current quest is started.
Rule for printing the expository announcement of a started quest (called the current quest):
say "DERP-dee-dee-DOO! You have exquisitely advanced [the current quest]!"
Rule for printing the expository announcement of a finished quest (called the current quest):
say "DERP-dee-dum-DOO-dee-dum-DEE! You have completed [the current quest]!"
[But how will the player learn of their mighty deeds? A quest journal, of course.]
The quest log is a subject.
Instead of researching the quest log on something:
say "Current quests: [list of started quests]";
say "[paragraph break]";
say "Completed quests: [list of finished quests]".
Section: The Scenario
[Now let's build this world]
The forest is a room. East of the forest is the mill. Inside of the mill is the mill interior.
The quest journal is a thing. It is expository. The player is carrying the quest journal.
The default-expository is the quest journal.
The apple is a thing.
The barrel is a container. It is open. It is in the forest.
The player is in the forest.
After going to the mill for the first time:
Update Visit the Mill with "You have strode through the forest toward the mill. All that is left is to go inside the mill."
After going to the mill interior for the first time:
complete visit the mill with "Bravely, you have entered the mill, and even assigned to a new, even more glorious task!";
say "You enter the mill, screaming with triumph. Suddenly the miller appears out of nowhere, saying breathlessly, 'Good sir! I need an apple placed in a barrel in the forest! This is an important task... do you think you can do it for me?'[paragraph break]Before you have a chance to respond, he tosses you a glossy, red apple, and then leaves immediately.[paragraph break]You're about to undertake the task, you hear his voice: 'Whatever you do, don't drop the apple!'";
start put-apple-in-barrel with "The miller has given you the mighty task to put an apple inside a barrel. He specifically asked you not to drop the apple.";
now apple is in the player.
When play begins:
say "You have a valiant quest... to visit the mill east of the river!"
[Let's defint our quests. In the beginning, the only active quest is to visit the mill. Thus, we define it as "started".]
There is a quest called Visit the Mill. The printed name is "the quest to visit the mill". The exposition-list is {"You bequeathed upon yourself the quest to visit the mill."}. It is started.
Understand "quest to visit the mill" as visit the mill.
There is a quest called Put-Apple-in-Barrel. The printed name is "the quest to put the apple in the barrel".
Understand "put apple in barrel" as put-apple-in-barrel.
After going to the mill while the player is carrying an apple for the first time:
update put-apple-in-barrel with "You have strode with alacrity across with the apple."
After going to the forest while the player is carrying an apple for the first time:
update put-apple-in-barrel with "Amazing! You are almost there! Now just put the apple in the barrel."
After inserting the apple into the barrel for the first time:
complete put-apple-in-barrel with "You put the apple in the barrel! You put the apple in the barrel! You put the apple in the barrel! You put the apple in the barrel! You put the apple in the barrel! The miller will be so happy!"
After dropping the apple for the first time:
say "Nooooo! you dropped the apple!"
complete put-apple-in-barrel with "You insolent worm! You dropped the apple! Now the miller will be in despair!"
test me with "r quest log / e / r visit the mill / go inside / r visit the mill / r quest log / go outside / drop apple / take apple / w / insert apple into barrel / r quest log / r put apple in barrel"[/code][/spoiler]