chimchooree
/
blessfrey-bottle
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

documentation; started inspect, tangible

Browse Source
master
chimchooree 2 years ago
parent c4acf39f80
commit ca5f0f984e
7 changed files with 103 additions and 115 deletions
Show Stats Download Patch File Download Diff File

15
src/blessfrey-gdd/docs/docs
Unescape Escape View File

@ -0,0 +1,15 @@
<p>documenting Blessfrey objects, variables, and methods <br></p>
<br>
<p>The <a href="/blessfrey-gdd">GDD</a> is more about design, while the docs is more about the data and logic. (I fix a lot of problems just trying to explain what I wrote.) <br></p>
<br>
<h2>entity</h2>
<p><ul>
<li><a href="/blessfrey-gdd/docs/tangible-body">tangible-body</a> </li>
</ul> <br></p>
<br>
<h2>UI</h2>
<p><ul>
<li><a href="/blessfrey-gdd/docs/highlight">highlight</a> </li>
<li><a href="/blessfrey-gdd/docs/inspect-menu">inspect menu</a> </li>
<li><a href="/blessfrey-gdd/docs/ui">ui</a> </li>
</ul> <br></p>

31
src/blessfrey-gdd/docs/inspect-menu
Unescape Escape View File

@ -0,0 +1,31 @@
<p>The inspect menu is a PopupMenu that gives options for interaction with its subject. It rests at res://UI/InspectMenu/InspectMenu.tscn. <br></p>
<br>
<h3>flow </h3>
<p>The inspect method is the entry point. Inspect > set_subject > _about_to_show > make_label<br></p>
<br>
<h3>signals </h3>
<p><ul>
<li>•&nbsp;<b>id_pressed</b>: connects the InspectMenu's signal to the subject's id_pressed method. Used to execute the associated method via pressing an inspect option. </li>
<li>•&nbsp;<b>about_to_show</b>: connects the InspectMenu's signal to its own '_about_to_show' method. </li>
</ul><br>
<br>
<h3>variables </h3>
<p><ul>
<li>•&nbsp;<b>subject</b>: the <a href="/blessfrey-gdd/docs/tangible">tangible entity</a> being inspected. Inspect options will be enacted on it. </li>
<li>•&nbsp;<b>is_connected</b>: ensures 'about_to_show' is properly connected. </li>
<li>•&nbsp;<b>label</b>: Label. Holds the subject's display name. </li>
</ul><br></p>
<br>
<h3>methods </h3>
<p>void set_subject (Object new_subject) <br></p>
<p>tear down old subject + set up new subject <br></p>
<br>
<p>void inspect (Object new_subject) <br></p>
<p>set up inspect menu <br></p>
<br>
<p>Object make_label () <br></p>
<p>returns a label with the name set. (Subject requires write_name()) <br></p>
<br>
<p>void _about_to_show () <br></p>
<p>resets the inspect menu, adds a label, and adds inspect options from the subject. <br></p>
<br>

43
src/blessfrey-gdd/docs/tangible
Unescape Escape View File

@ -0,0 +1,43 @@
<p>A tangible entity is a Node that inherits from <a href="/blessfrey-gdd/docs/tangible">mobile entities</a>. It is characterized by its physical presence in the world and possibility for interaction. It rests at res://addons/character_system/tangible.gd. <br></p>
<br>
<h3>flow </h3>
<p>Groups and default <a href="/blessfrey-gdd/docs/inspect-menu">inspect options</a> are added at ready. <br></p>
<br>Inspect: Inspect is the entry point. Inspect > (wait for user to press an inspect option) > id_pressed >
<br>
<h3>groups </h3>
<p><ul>
<li>•&nbsp;<b>can_highlight</b>: can target or hover mouse over entity for some information </li>
<li>•&nbsp;<b>can_interact</b>: can become the subject of an inspection menu. </li>
<li>•&nbsp;<b>can_skill_target</b>: can become the target of spells. </li>
<li>•&nbsp;<b>can_target</b>: can be targetted. </li>
</ul></p><br>
<br>
<h3>signals </h3>
<p><ul>
<li>•&nbsp;<b>-</b>: - </li>
</ul><br>
<br>
<h3>variables </h3>
<p><ul>
<li>•&nbsp;<b>inspect_options</b>: Dictionary. the options available on this entity's <a href="/blessfrey-gdd/docs/inspect-menu">inspect menu</a>. </li>
<li>•&nbsp;<b>applied_keywords</b>: Array[Objects]. all keywords currently active on this entity. </li>
</ul><br></p>
<br>
<h3>methods </h3>
<p>void _ready () <br></p>
<p>adds groups and default examine options. <br></p>
<br>
<p>void examine () <br></p>
<p>placeholder; prints display name. <br></p>
<br>
<p>void highlight () <br></p>
<p>calls entry point on this entity's <a href="/blessfrey-gdd/docs/highlight">highlight node</a>. <br></p>
<br>
<p>void id_pressed (new_id) <br></p>
<p>calls associated method from inspect_options. <br></p>
<br>
<p>void inspect () <br></p>
<p>triggers <a href="/blessfrey-gdd/docs/ui">UI</a>'s inspect method. <br></p>
<p>void unhighlight () <br></p>
<p>triggers <a href="/blessfrey-gdd/docs/tangible-body">tangible entity's body</a>'s unhighlight method. <br></p>
<br>

21
src/blessfrey-gdd/inspect-menu
Unescape Escape View File

@ -1,21 +0,0 @@
<p>The inspect menu is a PopupMenu that gives options for interaction with its subject. It rests at res://UI/InspectMenu/InspectMenu.tscn. <br></p>
<h3>variables </h3>
<p><ul>
<li><b>subject</b>: the entity being inspected. Options will be enacted on it. </li>
<li><b>is_connected</b>: ensures 'about_to_show' is properly connected. </li>
<li><b>label</b>: Label. Holds the subject's display name. </li>
</ul><br></p>
<br>
<h3>methods </h3>
<p>void set_subject (Object new_subject) <br></p>
<p>setter + subject setup <br></p>
<br>
<p>void inspect () <br></p>
<p>set up inspect menu <br></p>
<br>
<p>Object make_label () <br></p>
<p>returns a label with the name set. (Subject requires write_name()) <br></p>
<br>
<p>void _about_to_show () <br></p>
<p>resets the inspect menu, adds a label, <br></p>
<br>

104
src/index.py
Unescape Escape View File

@ -31,9 +31,6 @@ def find_gallery(name):
if name == "Abbey": if name == "Abbey":
gal.append("FlightRising") gal.append("FlightRising")
gal.append([["dragon.png","lazy Abbey"], ["FlightRising.png","Abbey's sprite in FlightRising"],["BlackReshiram_Artfight.png","2022 Artfight attack by BlackReshiram"]]) gal.append([["dragon.png","lazy Abbey"], ["FlightRising.png","Abbey's sprite in FlightRising"],["BlackReshiram_Artfight.png","2022 Artfight attack by BlackReshiram"]])
if name == "Aloin":
gal.append("Sims")
gal.append([["alchemy.png","Morning alchemy before work"],["dream.jpg","Stupid dream bubbles"]])
if name == "Angel": if name == "Angel":
gal.append("Blessfrey") gal.append("Blessfrey")
gal.append([["Chibipixel.png","One of Angel's sprites. I prefer taller, less cartoony sprites, but this style is so popular it was worth trying."],["girls.png","Angel, Chloe, and Tessa"],["AngelHeadshot.png","Headshot of Angel and all her hair"]]) gal.append([["Chibipixel.png","One of Angel's sprites. I prefer taller, less cartoony sprites, but this style is so popular it was worth trying."],["girls.png","Angel, Chloe, and Tessa"],["AngelHeadshot.png","Headshot of Angel and all her hair"]])
@ -43,123 +40,42 @@ def find_gallery(name):
if name == "Aristen": if name == "Aristen":
gal.append("Black Desert Online") gal.append("Black Desert Online")
gal.append([["menu.jpg","Aristen's fancy set"], ["scarf.jpg", "Newbie Aristen"], ["marine.jpg","Aristen in the Epheria Marine Classic Set"]]) gal.append([["menu.jpg","Aristen's fancy set"], ["scarf.jpg", "Newbie Aristen"], ["marine.jpg","Aristen in the Epheria Marine Classic Set"]])
if name == "Belfry":
gal.append("City of Heroes")
gal.append([["name.png","desc"]])
if name == "Bless": if name == "Bless":
gal.append("Blessfrey") gal.append("Blessfrey")
gal.append([["name.png","desc"]]) gal.append([["name.png","desc"]])
if name == "Bijoux":
gal.append("Sims")
gal.append([["alchemy.png","Morning alchemy before work"],["dream.jpg","Stupid dream bubbles"]])
if name == "Calder": if name == "Calder":
gal.append("FlightRising") gal.append("FlightRising")
gal.append([["pixelheadshot.png", "Calder's human form"], ["FlightRising.png","Calder\'s sprite in FlightRising"]]) gal.append([["pixelheadshot.png", "Calder's human form"], ["FlightRising.png","Calder\'s sprite in FlightRising"]])
if name == "Cass":
gal.append("Beloved of the Moon")
gal.append([["name.png","desc"]])
if name == "CatMan":
gal.append("City of Heroes")
gal.append([["name.png","desc"]])
if name == "Chandra":
gal.append("Hello Traveler")
gal.append([["name.png","desc"]])
if name == "Chimchooree": if name == "Chimchooree":
gal.append("Aion") gal.append("Aion")
gal.append([["couture.jpg","Chimchooree in her oyster pink tiered couture dress"],["Headshot.jpg","Her closeup."]]) gal.append([["couture.jpg","Chimchooree in her oyster pink tiered couture dress"],["Headshot.jpg","Her closeup."]])
if name == "Chloe": if name == "Chloe":
gal.append("Blessfrey") gal.append("Blessfrey")
gal.append([["girls.png","Angel, Chloe, and Tessa"]]) gal.append([["girls.png","Angel, Chloe, and Tessa"]])
if name == "Colt":
gal.append("Hello Traveler")
gal.append([["name.png","desc"]])
if name == "Coye":
gal.append("Verpets")
gal.append([["name.png","desc"]])
if name == "Dia": if name == "Dia":
gal.append("Blessfrey") gal.append("Blessfrey")
gal.append([["name.png","desc"]]) gal.append([["name.png","desc"]])
if name == "Dymn":
gal.append("Dymn")
gal.append([["name.png","desc"]])
if name == "Eden": if name == "Eden":
gal.append("Blessfrey") gal.append("Blessfrey")
gal.append([["name.png","desc"]]) gal.append([["name.png","desc"]])
if name == "Faber":
gal.append("Sims")
gal.append([["alchemy.png","Morning alchemy before work"],["dream.jpg","Stupid dream bubbles"]])
if name == "Fifi":
gal.append("Sims")
gal.append([["mirrorofvenus.jpg","Fifi debating herself in the mirror"],["guitarpractice.jpg","Fifi seeing how her old guitar sounds"]])
if name == "Freefall":
gal.append("13th")
gal.append([["name.png","desc"]])
if name == "Freya":
gal.append("Guild Wars")
gal.append([])
if name == "Funwa":
gal.append("Beloved of the Moon")
gal.append([["name.png","desc"]])
if name == "Helba":
gal.append("Verpets")
gal.append([["name.png","desc"]])
if name == "Helia": if name == "Helia":
gal.append("Blessfrey") gal.append("Blessfrey")
gal.append([["AnimeEnding.png","A still from an attempt to emulate the Little Busters ending animation. Man, animating is hard."],["wm.png","wip lol"],["Girls.png","Helia and Tessa"],["Headshot.png","emulating the art style of Battle Girl High School"]]) gal.append([["AnimeEnding.png","A still from an attempt to emulate the Little Busters ending animation. Man, animating is hard."],["wm.png","wip lol"],["Girls.png","Helia and Tessa"],["Headshot.png","emulating the art style of Battle Girl High School"]])
if name == "Helmut":
gal.append("Sims")
gal.append([["alchemy.png","Morning alchemy before work"],["dream.jpg","Stupid dream bubbles"]])
if name == "HOME":
gal.append("HOME")
gal.append([["name.png","desc"]])
if name == "Leslie":
gal.append("Guild Wars")
gal.append([["name.png","desc"]])
if name == "Lisbet":
gal.append("Hello Traveler")
gal.append([["name.png","desc"]])
if name == "Lune": if name == "Lune":
gal.append("Persona") gal.append("Persona")
gal.append([["RingOfFire.jpg","Lune in the Ring of Fire in her Vabbian"],["HallOfMonuments.png","My Guild Wars Necromancer showing off her Hall of Monuments"],["PhariseeFlying.jpg","My Aion Elysian Spiritmaster with really pretty hair"],["LuneMarine.png","Lune Marine, my gold side resistance Water Controller in City of Heroes"],["ArcheageGuild.jpg","My ArcheAge dwarf ghost girl with gold-dipped hair and a frilly gown, plus her guildmates"],["Pixelmon.png","Customs Officer Lune and her sidekick Lilligant in Pixelmon"],["tinypool.png","Bikini Lune in a tiny pool with her kitty in Minecraft"]]) gal.append([["RingOfFire.jpg","Lune in the Ring of Fire in her Vabbian"],["HallOfMonuments.png","My Guild Wars Necromancer showing off her Hall of Monuments"],["PhariseeFlying.jpg","My Aion Elysian Spiritmaster with really pretty hair"],["LuneMarine.png","Lune Marine, my gold side resistance Water Controller in City of Heroes"],["ArcheageGuild.jpg","My ArcheAge dwarf ghost girl with gold-dipped hair and a frilly gown, plus her guildmates"],["Pixelmon.png","Customs Officer Lune and her sidekick Lilligant in Pixelmon"],["tinypool.png","Bikini Lune in a tiny pool with her kitty in Minecraft"]])
if name == "Nephele":
gal.append("Verpets")
gal.append([["name.png","desc"]])
if name == "Newcomer":
gal.append("Newcomer")
gal.append([["name.png","desc"]])
if name == "Night": if name == "Night":
gal.append("Blessfrey") gal.append("Blessfrey")
gal.append([]) gal.append([])
if name == "Pixie":
gal.append("City of Heroes")
gal.append([["alchemy.png","Morning alchemy before work"],["dream.jpg","Stupid dream bubbles"]])
if name == "Rodolphe":
gal.append("Sims")
gal.append([["alchemy.png","Morning alchemy before work"],["dream.jpg","Stupid dream bubbles"]])
if name == "Rune": if name == "Rune":
gal.append("Blessfrey") gal.append("Blessfrey")
gal.append([["AnimeEnding.png","A still from an attempt to emulate the Little Busters ending animation. Man, animating is hard."],["Bless+Rune.png","Rune and his dinosaur mother"],["Blessfrey.png","Emulating old RPG coverart like Elden Gate in mixed media. Don't feel like working on it anymore."],["FlightRising.png","his oc dragon form in FlightRising"],["RuneHeadshot.png","emulating the art style of Battle Girl High School"],["CawfeeCakes_Artfight.png","2022 Artfight attack by CawfeeCakes"],["Teriuuuu_Artfight.png","2020 Artfight attack by Teriuuuu"]]) gal.append([["AnimeEnding.png","A still from an attempt to emulate the Little Busters ending animation. Man, animating is hard."],["Bless+Rune.png","Rune and his dinosaur mother"],["Blessfrey.png","Emulating old RPG coverart like Elden Gate in mixed media. Don't feel like working on it anymore."],["FlightRising.png","his oc dragon form in FlightRising"],["RuneHeadshot.png","emulating the art style of Battle Girl High School"],["CawfeeCakes_Artfight.png","2022 Artfight attack by CawfeeCakes"],["Teriuuuu_Artfight.png","2020 Artfight attack by Teriuuuu"]])
if name == "Ryada":
gal.append("Guild Wars")
gal.append([[]])
if name == "Silke": if name == "Silke":
gal.append("Verpets") gal.append("Verpets")
gal.append([["Silke.png","emulating the art style of Yuu Watase in pixelart"],["Verpets.png","Silke's sprite in Verpets"]]) gal.append([["Silke.png","emulating the art style of Yuu Watase in pixelart"],["Verpets.png","Silke's sprite in Verpets"]])
if name == "Tessa": if name == "Tessa":
gal.append("Blessfrey") gal.append("Blessfrey")
gal.append([["Tessa.png","Pixelart of Tessa in athletic wear"],["picrew.png","made in あの子がこっちを見ている on Picrew"],["FlightRising.png","her oc dragon form in FlightRising"],["RamblingRoses_Artfight.png","2020 Artfight attack by RamblingRoses"],["Lune_Archon_Artfight.jpeg","2022 Artfight attack by Lune_Archon"],["ElissaKarminakria_Artfight.png","2020 Artfight attack by ElissaKarminakria"],["gemhue_Artfight.png","2020 Artfight attack by gemhue"],["Cyan_moo_Artfight.png","2020 Artfight attack by Cyan_moo"]]) gal.append([["Tessa.png","Pixelart of Tessa in athletic wear"],["picrew.png","made in あの子がこっちを見ている on Picrew"],["FlightRising.png","her oc dragon form in FlightRising"],["RamblingRoses_Artfight.png","2020 Artfight attack by RamblingRoses"],["Lune_Archon_Artfight.jpeg","2022 Artfight attack by Lune_Archon"],["ElissaKarminakria_Artfight.png","2020 Artfight attack by ElissaKarminakria"],["gemhue_Artfight.png","2020 Artfight attack by gemhue"],["Cyan_moo_Artfight.png","2020 Artfight attack by Cyan_moo"]])
if name == "Tilhar":
gal.append("Beloved of the Moon")
gal.append([["name.png","desc"]])
if name == "Tilly":
gal.append("Sims")
gal.append([["alchemy.png","Morning alchemy before work"],["dream.jpg","Stupid dream bubbles"]])
if name == "Trace":
gal.append("13th")
gal.append([["name.png","desc"]])
if name == "Window":
gal.append("Dymn")
gal.append([["name.png","desc"]])
if name == "WISE": if name == "WISE":
gal.append("Blessfrey") gal.append("Blessfrey")
gal.append([["WISE.png","WISE processing a query"],["CityOfHeroes.png","I made WISE in City of Heroes, too. She's an Electric/Empathy Controller."]]) gal.append([["WISE.png","WISE processing a query"],["CityOfHeroes.png","I made WISE in City of Heroes, too. She's an Electric/Empathy Controller."]])
@ -442,7 +358,7 @@ def download(filename):
# Error Page # Error Page
@error(404) @error(404)
def error404(error): def error404(error):
return "unfortunately, a 404 error. the page you're searching for doesn't exist. (or is it just in hiding?) try another page! " return "unfortunately, a 404 error. the page you're searching for doesn't exist. (or is it just in hiding?) try another page! <a href=/>return to blessfrey.me.</a> "
@error(500) @error(500)
def error500(error): def error500(error):
return "unfortunately, a 500 error. something is wrong with the page you're trying to find, if it exists at all. try another page! <a href=/>return to blessfrey.me.</a>" return "unfortunately, a 500 error. something is wrong with the page you're trying to find, if it exists at all. try another page! <a href=/>return to blessfrey.me.</a>"
@ -530,13 +446,6 @@ def entry(page):
TEMPLATE_PATH.insert(0, abs_views_path ) TEMPLATE_PATH.insert(0, abs_views_path )
return template(os.path.join(abs_views_path,'entry.tpl'), info) return template(os.path.join(abs_views_path,'entry.tpl'), info)
# Fashion Page
#@route('/fashion')
#def fashion():
# """fashion"""
# info = {'css': 'fashion', 'title': 'blessfrey fashion', 'year': find_year()}
# return template('fashion.tpl', info)
# Blessfrey Game Design Document Page # Blessfrey Game Design Document Page
@route('/blessfrey-gdd') @route('/blessfrey-gdd')
def gddbf(): def gddbf():
@ -565,6 +474,17 @@ def page(page):
loc = 'blessfrey-gdd/' loc = 'blessfrey-gdd/'
info = {'css': 'doc', 'title': 'blessfrey gdd - ' + page, 'year': find_year(), 'topic': page.lower(), 'writeup': prepare_gdd_page(page, loc)} info = {'css': 'doc', 'title': 'blessfrey gdd - ' + page, 'year': find_year(), 'topic': page.lower(), 'writeup': prepare_gdd_page(page, loc)}
return template('page.tpl', info) return template('page.tpl', info)
# Blessfrey Docs (Objects, Variables, & Methods)
@route('/blessfrey-gdd/docs')
def docs():
"""docs"""
info = {'css': 'doc', 'title': 'blessfrey gdd - docs', 'year': find_year(), 'topic': 'docs', 'writeup': prepare_gdd_page('docs', 'blessfrey-gdd/docs/')}
return template('page.tpl', info)
@route('/blessfrey-gdd/docs/<page>')
def docpage(page):
loc = 'blessfrey-gdd/docs/'
info = {'css': 'doc', 'title': 'blessfrey gdd - ' + page, 'year': find_year(), 'topic': '<a href="/blessfrey-gdd/docs">docs</a> ~ ' + page.lower(), 'writeup': prepare_gdd_page(page, loc)}
return template('page.tpl', info)
# Blessfrey Mechanics # Blessfrey Mechanics
@route('/blessfrey-gdd/mechanics') @route('/blessfrey-gdd/mechanics')
def mech(): def mech():

2
src/views/bf-gdd.tpl
Unescape Escape View File

@ -5,7 +5,7 @@
<p>The vision for Blessfrey <br></p> <p>The vision for Blessfrey <br></p>
<br> <br>
<ul> <ul>
% for i in ["achievements","cast","controls","credits","dialogue","highlight","ID","inspect menu", "inventory","item","job","keyword","mechanics","Mercur","milestones","pathfinding","proxemics","setting","skill","story","style guide","terms","vibe","website"]: % for i in ["achievements", "cast", "controls", "credits", "dialogue", "docs", "highlight", "ID", "inspect menu", "inventory", "item", "job", "keyword", "mechanics", "Mercur", "milestones", "pathfinding", "proxemics", "setting", "skill", "story", "style guide", "terms", "vibe", "website"]:
<li class="list">{{random.choice(['.','•','☆','★'])}}&#9;<a href=/blessfrey-gdd/{{i}}>{{i}}</a></li> <li class="list">{{random.choice(['.','•','☆','★'])}}&#9;<a href=/blessfrey-gdd/{{i}}>{{i}}</a></li>
% end % end
</ul> </ul>

2
src/views/footer.tpl
Unescape Escape View File

@ -30,6 +30,6 @@
</div> </div>
</div><div class="star"></div></div> </div><div class="star"></div></div>
<div class="links"> <div class="links">
.      •        . <a href=/milestones>milestones</a> {{random.choice(['.','•','☆','★'])}} <a href=/gdd>gdd</a> {{random.choice(['.','•','☆','★'])}} <a href=/blessfrey-presskit>presskit</a> {{random.choice(['.','•','☆','★'])}}<!-- &#169; chimchooree 2020-{{year}}--> ☆            ..   . <br> .      •        . <a href=/milestones>milestones</a> {{random.choice(['.','•','☆','★'])}} <a href=/blessfrey-gdd>gdd</a> {{random.choice(['.','•','☆','★'])}} <a href=/blessfrey-presskit>presskit</a> {{random.choice(['.','•','☆','★'])}}<!-- &#169; chimchooree 2020-{{year}}--> ☆            ..   . <br>
</div> </div>
</div></footer> </div></footer>

Write Preview
Loading…
Cancel
Save