From ca5f0f984ef14a1b43532816e01542a4d4ff43e6 Mon Sep 17 00:00:00 2001 From: chimchooree Date: Thu, 24 Nov 2022 10:12:36 -0600 Subject: [PATCH] documentation; started inspect, tangible --- src/blessfrey-gdd/docs/docs | 15 ++++ src/blessfrey-gdd/docs/inspect-menu | 31 +++++++++ src/blessfrey-gdd/docs/tangible | 43 ++++++++++++ src/blessfrey-gdd/inspect-menu | 21 ------ src/index.py | 104 ++++------------------------ src/views/bf-gdd.tpl | 2 +- src/views/footer.tpl | 2 +- 7 files changed, 103 insertions(+), 115 deletions(-) create mode 100644 src/blessfrey-gdd/docs/docs create mode 100644 src/blessfrey-gdd/docs/inspect-menu create mode 100644 src/blessfrey-gdd/docs/tangible delete mode 100644 src/blessfrey-gdd/inspect-menu diff --git a/src/blessfrey-gdd/docs/docs b/src/blessfrey-gdd/docs/docs new file mode 100644 index 0000000..c179471 --- /dev/null +++ b/src/blessfrey-gdd/docs/docs @@ -0,0 +1,15 @@ +

documenting Blessfrey objects, variables, and methods

+
+

The GDD 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.)

+
+

entity

+


+
+

UI

+


diff --git a/src/blessfrey-gdd/docs/inspect-menu b/src/blessfrey-gdd/docs/inspect-menu new file mode 100644 index 0000000..912c421 --- /dev/null +++ b/src/blessfrey-gdd/docs/inspect-menu @@ -0,0 +1,31 @@ +

The inspect menu is a PopupMenu that gives options for interaction with its subject. It rests at res://UI/InspectMenu/InspectMenu.tscn.

+
+

flow

+

The inspect method is the entry point. Inspect > set_subject > _about_to_show > make_label

+
+

signals

+


+
+

variables

+


+
+

methods

+

void set_subject (Object new_subject)

+

tear down old subject + set up new subject

+
+

void inspect (Object new_subject)

+

set up inspect menu

+
+

Object make_label ()

+

returns a label with the name set. (Subject requires write_name())

+
+

void _about_to_show ()

+

resets the inspect menu, adds a label, and adds inspect options from the subject.

+
diff --git a/src/blessfrey-gdd/docs/tangible b/src/blessfrey-gdd/docs/tangible new file mode 100644 index 0000000..23cebfe --- /dev/null +++ b/src/blessfrey-gdd/docs/tangible @@ -0,0 +1,43 @@ +

A tangible entity is a Node that inherits from mobile entities. It is characterized by its physical presence in the world and possibility for interaction. It rests at res://addons/character_system/tangible.gd.

+
+

flow

+

Groups and default inspect options are added at ready.

+
Inspect: Inspect is the entry point. Inspect > (wait for user to press an inspect option) > id_pressed > +
+

groups

+


+
+

signals

+


+
+

variables

+


+
+

methods

+

void _ready ()

+

adds groups and default examine options.

+
+

void examine ()

+

placeholder; prints display name.

+
+

void highlight ()

+

calls entry point on this entity's highlight node.

+
+

void id_pressed (new_id)

+

calls associated method from inspect_options.

+
+

void inspect ()

+

triggers UI's inspect method.

+

void unhighlight ()

+

triggers tangible entity's body's unhighlight method.

+
diff --git a/src/blessfrey-gdd/inspect-menu b/src/blessfrey-gdd/inspect-menu deleted file mode 100644 index 9b24507..0000000 --- a/src/blessfrey-gdd/inspect-menu +++ /dev/null @@ -1,21 +0,0 @@ -

The inspect menu is a PopupMenu that gives options for interaction with its subject. It rests at res://UI/InspectMenu/InspectMenu.tscn.

-

variables

-


-
-

methods

-

void set_subject (Object new_subject)

-

setter + subject setup

-
-

void inspect ()

-

set up inspect menu

-
-

Object make_label ()

-

returns a label with the name set. (Subject requires write_name())

-
-

void _about_to_show ()

-

resets the inspect menu, adds a label,

-
diff --git a/src/index.py b/src/index.py index ea493d3..1a12399 100644 --- a/src/index.py +++ b/src/index.py @@ -31,9 +31,6 @@ def find_gallery(name): if name == "Abbey": gal.append("FlightRising") 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": 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"]]) @@ -43,123 +40,42 @@ def find_gallery(name): if name == "Aristen": 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"]]) - if name == "Belfry": - gal.append("City of Heroes") - gal.append([["name.png","desc"]]) if name == "Bless": gal.append("Blessfrey") 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": gal.append("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": gal.append("Aion") gal.append([["couture.jpg","Chimchooree in her oyster pink tiered couture dress"],["Headshot.jpg","Her closeup."]]) if name == "Chloe": gal.append("Blessfrey") 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": gal.append("Blessfrey") gal.append([["name.png","desc"]]) - if name == "Dymn": - gal.append("Dymn") - gal.append([["name.png","desc"]]) if name == "Eden": gal.append("Blessfrey") 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": 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"]]) - 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": 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"]]) - 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": gal.append("Blessfrey") 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": 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"]]) - if name == "Ryada": - gal.append("Guild Wars") - gal.append([[]]) if name == "Silke": gal.append("Verpets") gal.append([["Silke.png","emulating the art style of Yuu Watase in pixelart"],["Verpets.png","Silke's sprite in Verpets"]]) if name == "Tessa": 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"]]) - 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": 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."]]) @@ -442,7 +358,7 @@ def download(filename): # Error Page @error(404) 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! return to blessfrey.me. " @error(500) 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! return to blessfrey.me." @@ -530,13 +446,6 @@ def entry(page): TEMPLATE_PATH.insert(0, abs_views_path ) 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 @route('/blessfrey-gdd') def gddbf(): @@ -565,6 +474,17 @@ def page(page): loc = 'blessfrey-gdd/' info = {'css': 'doc', 'title': 'blessfrey gdd - ' + page, 'year': find_year(), 'topic': page.lower(), 'writeup': prepare_gdd_page(page, loc)} 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/') +def docpage(page): + loc = 'blessfrey-gdd/docs/' + info = {'css': 'doc', 'title': 'blessfrey gdd - ' + page, 'year': find_year(), 'topic': 'docs ~ ' + page.lower(), 'writeup': prepare_gdd_page(page, loc)} + return template('page.tpl', info) # Blessfrey Mechanics @route('/blessfrey-gdd/mechanics') def mech(): diff --git a/src/views/bf-gdd.tpl b/src/views/bf-gdd.tpl index c5bc880..e3e00c3 100644 --- a/src/views/bf-gdd.tpl +++ b/src/views/bf-gdd.tpl @@ -5,7 +5,7 @@

The vision for Blessfrey


diff --git a/src/views/footer.tpl b/src/views/footer.tpl index 940d2f5..08c9ea5 100644 --- a/src/views/footer.tpl +++ b/src/views/footer.tpl @@ -30,6 +30,6 @@
- .      •        . milestones {{random.choice(['.','•','☆','★'])}} gdd {{random.choice(['.','•','☆','★'])}} presskit {{random.choice(['.','•','☆','★'])}} ☆            ..   .
+ .      •        . milestones {{random.choice(['.','•','☆','★'])}} gdd {{random.choice(['.','•','☆','★'])}} presskit {{random.choice(['.','•','☆','★'])}} ☆            ..   .