Guild of Writers

by **D'Lanor** » Thu Mar 13, 2008 1:51 pm

Here is a version 3.0 of my book template. It can be used for both linking books and journals. The first version of this template was included in my test age Prad which was released for a short period through UAM in 2005. Since then I have been adding bits to it from time to time.

Since this is a template all you have to do is define your variables and it will automagically generate the pages of the book. You can mix and match multiple linking pages and journals into the same book in any order you like. There is also support for multiple books (clickable objects). If you set up your variables correctly the template will make sure that the links point to the right age.

New in version 3.0

Notebook GUI implemented
Book size implemented
Linking panels or other clickable journal images can also be used for other actions than linking
Easier customizing: *YourAge*PageDefs only needs to be replaced once now

For each Python file you have to replace *YourAge* in the filename and in the code with the actual name of your age. I left comments in the code to explain why I did things the way I did.

*YourAge*BookGUI.py
This is the python file that the Alcscript of your clickable object points to. The variables to adapt here are: modPageDefs, ageBooks, bookPages and optionally the IConvertAgeInstanceName and IDoSpecialAction functions (see comments).

Code: Select all: ########################################### # # # Dynamic Book Template v3.0 by D'Lanor # # # ########################################### # For each occurance of *YourAge* you have to replace this with the actual name of your age. from Plasma import * from PlasmaTypes import * from PlasmaKITypes import * from PlasmaNetConstants import * import xLinkingBookDefs actClickableObject = ptAttribActivator(1, 'Act: Clickable Object') ObjectMsg = ptAttribString(2, 'Object String') ### DO NOT CHANGE THESE 2 VARIABLES ### ourBook = None bkLinks = [] ### CHANGE THE GLOBAL CONSTANTS BELOW TO FIT YOUR AGE ###################################### # # # modPageDefs: Replace *YourAge*PageDefs with the name of the module that contains your # # page definitions. Do not remove the quotes! # # ageBooks: These are your clickable objects. They must be defined in *YourAge*PageDefs # # in the AgeBooks Dictionary Section by the same name(s). # # bookPages: Names in bookPages must be defined in the *YourAge*PageDefs file under # # BookPages. An ageBook can have multiple bookPages as long as they are # # enclosed together between the same square brackets. # # Please keep the nesting structure [square brackets] intact! # # # # If there are multiple books in an age the code will find the right one automagically. # # You can add as many books as you like. Just define them in the global variables ageBooks # # and bookPages. The order is important here. The first book will be matched to the first # # page list, the second book to the second page list etc. # ############################################################################################ modPageDefs = __import__('*YourAge*PageDefs') ageBooks = ['Journal01', 'Journal02'] bookPages = [['PradJournal', 'CleftSpecial'], ['FontTest']] class *YourAge*BookGUI(ptModifier,): def __init__(self): ptModifier.__init__(self) self.version = '3.0' print ('__init__%s v.%s' % (self.__class__.__name__, self.version)) def OnNotify(self, state, id, events): print ('%s: OnNotify called' % self.__class__.__name__) if ((id == actClickableObject.id) and state): print ('Someone clicked on object %s' % ObjectMsg.value) if PtWasLocallyNotified(self.key): print 'It was you' for (a, b,) in zip(ageBooks, bookPages): print ('Trying book %s with page(s) %s' % (a, b)) if (ObjectMsg.value == a): print 'Match found! Start opening book...' self.IOpenBook(a, b) break else: print 'No match' else: for event in events: if ((event[0] == PtEventType.kBook) and PtWasLocallyNotified(self.key)): #print('BookNotify: event=%d, id=%d' % (event[1], event[2])) if (event[1] == PtBookEventTypes.kNotifyImageLink): print ('BookNotify: Linking panel id=%d, event=%d' % (event[2], event[1])) ourBook.hide() if (event[2] == 0): print 'Warning: No link id, define proper link destination or use non-clickable image' elif (event[2] >= xLinkingBookDefs.kFirstLinkPanelID): for i in range(0, len(bkLinks)): if (event[2] == bkLinks[i][0]): try: self.IlinkToAge(bkLinks[i][1], bkLinks[i][2], bkLinks[i][3], bkLinks[i][4], bkLinks[i][5]) except Exception, detail: print ('ERROR: Unable to initialize link - %s' % detail) break elif (event[1] == PtBookEventTypes.kNotifyShow): print ('BookNotify: Show book, event=%d' % event[1]) PtToggleAvatarClickability(0) elif (event[1] == PtBookEventTypes.kNotifyHide): print ('BookNotify: Hide book, event=%d' % event[1]) PtToggleAvatarClickability(1) elif (event[1] == PtBookEventTypes.kNotifyNextPage): print ('BookNotify: To next page %d, event=%d' % (ourBook.getCurrentPage(), event[1])) elif (event[1] == PtBookEventTypes.kNotifyPreviousPage): print ('BookNotify: To previous page %d, event=%d' % (ourBook.getCurrentPage(), event[1])) elif (event[1] == PtBookEventTypes.kNotifyCheckUnchecked): print ('BookNotify: Relto page toggle, event=%d' % event[1]) elif (event[1] == PtBookEventTypes.kNotifyClose): print ('BookNotify: Close book, event=%d' % event[1]) def IOpenBook(self, ageBook, bkPages = None): global ourBook global bkLinks print ('%s: IOpenBook: Page(s) requested %s' % (self.__class__.__name__, bkPages)) if (type(bkPages) == type(None)): print 'ERROR: no pages defined' return if (not (ageBook in modPageDefs.AgeBooks)): print ('ERROR: Definition %s does not exist in AgeBooks' % ageBook) return bkParams = modPageDefs.AgeBooks[ageBook] (bkCover, bkFont, startOpen, forceOwned, bookGUI, width, height,) = bkParams PageDef = (bkCover + bkFont) if (not startOpen): if (not self.IsThereACover(PageDef)): print 'Warning: Missing cover, forcing book open' startOpen = 1 PageCount = xLinkingBookDefs.kFirstLinkPanelID bkLinks = [] for bkPage in bkPages: if (not (bkPage in modPageDefs.LinkDestinations)): print ('Warning: %s skipped, definition does not exist in LinkDestinations' % bkPage) continue pgParams = modPageDefs.LinkDestinations[bkPage] (bkAge, spawnPoint, spTitle, linkRule,) = pgParams alink = 1 if ((type(bkAge) != type(None)) and forceOwned): print ('Ownership check for %s book' % bkAge) vault = ptVault() ainfo = ptAgeInfoStruct() ainfo.setAgeFilename(bkAge) alink = vault.getOwnedAgeLink(ainfo) if alink: print ('Showing %s, link destination %s' % (bkPage, bkAge)) if (type(bkAge) != type(None)): t = (PageCount, bkPage, bkAge, spawnPoint, spTitle, linkRule) bkLinks.append(t) PageDef = ((PageDef + (modPageDefs.BookPages[bkPage] % PageCount)) + '<pb>') else: PageDef = ((PageDef + modPageDefs.BookPages[bkPage]) + '<pb>') PageCount = (PageCount + 1) else: print ('No owner of age %s so we are not showing %s' % (bkAge, bkPage)) if (PageCount == xLinkingBookDefs.kFirstLinkPanelID): print 'No pages created...' return else: TotalCount = (PageCount - xLinkingBookDefs.kFirstLinkPanelID) print ('%d item(s) created, linking page(s): %d' % (TotalCount, len(bkLinks))) PageDef = PageDef[:-4] ourBook = ptBook(PageDef, self.key) ourBook.setSize(width, height) ourBook.setGUI(bookGUI) ourBook.show(startOpen) def IsThereACover(self, bookHtml): idx = bookHtml.find('<cover') if (idx >= 0): return 1 return 0 def IlinkToAge(self, bookPage, ageName, spawnPoint, spTitle, linkRule = PtLinkingRules.kBasicLink): print ('%s: ILinkToAge: Link request from page %s to age %s' % (self.__class__.__name__, bookPage, ageName)) if ((type(ageName) == type(None)) or (len(ageName) == 0)): print 'ERROR: Cannot link to age without name' return if ((type(spawnPoint) == type(None)) or (len(spawnPoint) == 0)): print 'No spawnpoint defined, checking special actions...' self.IDoSpecialAction(bookPage) return als = ptAgeLinkStruct() ainfo = ptAgeInfoStruct() ainfo.setAgeFilename(ageName) ainfo.setAgeInstanceName(self.IConvertAgeInstanceName(ageName)) als.setAgeInfo(ainfo) if ((type(spTitle) == type(None)) or (len(spTitle) == 0)): if ((linkRule == PtLinkingRules.kOriginalBook) or PtIsSinglePlayerMode()): ################################################################################# # Linkingrule kOriginalBook writes spawnpoint and title to the agelink node, # # so we must make absolutely sure that a proper title is given! # # In singleplayer mode all linkingrules behave like kOriginalBook, no matter # # which linkingrule is set in the definition. # ################################################################################# if (spawnPoint == 'LinkInPointDefault'): spTitle = 'Default' ################################################################################# # We did not define a spawnpoint title, but since the spawnpoint is the default # # it is safe to continue and write it to the agelink node with default title. # ################################################################################# else: print 'Warning: Empty spawnpoint title not allowed, check your link destinations!' return else: print 'Empty spawnpoint title allowed, continue linking' spTitle = '' als.setLinkingRules(linkRule) spPoint = ptSpawnPointInfo(spTitle, spawnPoint) als.setSpawnPoint(spPoint) linkMgr = ptNetLinkingMgr() linkMgr.linkToAge(als) print ('Linking to age %s, spawnpoint %s with title %s, using linkingrule %d' % (ageName, spawnPoint, spTitle, linkRule)) def IConvertAgeInstanceName(self, ageName): ######################################################################################################################### # Optional: You can add a friendly name to this list for the age you link to. This is the name that shows up in the KI. # # Ahra Pahts and Relto are used here only as examples. # # Some Cyan age names are converted to friendly names in the KI but we cannot expect the KI to do that for user ages. # # Beware: Age instance names are written to the vault if the kOriginalBook rule is used. That will happen whether you # # set a name here or not. And it would happen regardless of this function. # # By default the age instance name is the same as the age name. # # btw, if you plan to link to Cyan ages you should set the correct age instance name here. Correct? You figure it out! # ######################################################################################################################### if (ageName == 'Personal'): return 'Relto' if (ageName == 'Pahts'): return 'Ahra Pahts' return ageName def IDoSpecialAction(self, bookPage): ####################################################### # Replace *YourPage* with the bookPage that contains # # the clickable image triggering the special action. # ####################################################### if (bookPage == '*YourPage*'): print ('Special action found for %s' % bookPage) # Do some special action here else: print 'No special actions found' # Insert the standard GLUE section for your Uru version here. You can copy this from another Python file.

*YourAge*PageDefs.py
This is the file that contains the definitions for your books and pages. You will do most of your editing here. *YourAge*PageDefs.py is imported into *YourAge*BookGUI.py. There are 4 sections: General layout elements, AgeBooks, BookPages and LinkDestinations. Replace the examples with your own definitions.

Code: Select all: # For each occurance of *YourAge* and *YourTexture* you have to replace this with # the actual name of your age and your textures. from Plasma import * from PlasmaNetConstants import * # Due to their length journal texts are usually stored in external Python files. # The line below imports them. Remove this line if you do not use external journals. from *YourAge*Journals import * # General layout elements that can be used in BookPages: PageStart = '<pb>' ImgStart = '<img src="' TransImgStart = '<img opacity=0.7 src="' ImgEnd = '" align=center link=%d blend=alpha>' ImgEndNoLink = '" align=center blend=alpha>' AlignCenter = '' AlignLeft = '' AlignRight = '' # Retrieve local player name in case you want to fake a "personal" note plyrName = PtGetLocalPlayer().getPlayerName() ############################################################################### # AgeBooks Dictionary Section: # # 1 = same names as the clickable book objects! # # 2 = book cover and margin # # 3 = main font # # 4 = start book open or closed. 0 closed book, 1 open book # # 5 = force owned setting. 0 off, 1 on # # 6 = book GUI. 'BkBook' or 'bkNotebook' # # 7 = width # # 8 - height # # # # Notes: - The cover can have the same texture as the book object itself. # # - The main font can be changed later in the BookPages definition. # # If you don't need a main font (because you are changing it later), # # you can set an empty string. # # - force owned: If set to 1 the code checks if the original book has # # been found. A player who does not own the age will not see the # # linking panel. If you need this restriction set force owned to 1. # # - the 'bkBahroRockBook' GUI should work as well but it may not be a # # good idea to use it with this multi-page template. # ############################################################################### AgeBooks = {'Journal01': ('<cover src="*YourTexture*"><margin right=32 left=32>', '', 0, 0, 'BkBook', 0.8, 1.0), 'Journal02': ('', '', 1, 0, 'bkNotebook', 1.0, 1.0)} ############################################################################################### # BookPages Dictionary Section: # # 1 = Same names as link destinations! # # 2 = The page layout: for linking books insert the name of your linking panel image here. # # This can be a seperate texture in your age prp file on a hidden Blender object. # # (or use PRP Explorer to add a plain texture to the prp without modeling an object) # # Once you get the hang of this you can mix and match layouts into your pages. # # # # Notes: - AlignCenter is used to center text, for example to place below a linking panel. # # - Use ImgEndNoLink to add images without a hotspot. # ############################################################################################### BookPages = {'BevinBalcony01': (PageStart + ImgStart + 'xLinkPanelBevinBalc01*1#0.hsm' + ImgEnd + AlignCenter), 'CleftDefault': (PageStart + ImgStart + 'xLinkPanelCleftDesert*1#0.hsm' + ImgEnd + AlignCenter), 'CleftFissureDrop': (PageStart + ImgStart + 'xLinkPanelCleftDesert*1#0.hsm' + ImgEnd + AlignCenter), 'CleftSpecial': (PageStart + ImgStart + 'xLinkPanelTomahnaDesert*1#0.hsm' + ImgEnd + '' + AlignCenter + 'Don\'t even think about it'), 'KadishPyramid': (PageStart + ImgStart + 'xLinkPanelKadishGlowBalc*1#0.hsm' + ImgEnd + AlignCenter), 'FontTest': (PageStart + DefFontTest), 'PradJournal': (PageStart + (DefPradJournal % plyrName))} ############################################################################### # LinkDestinations Dictionary Section: # # 1 = Same names as book pages! # # 2 = age name # # 3 = spawnpoint # # 4 = spawnpoint title # # 5 = linkingrule # # # # Notes: - Variables for journals are dummies and must be set to None. # # - Spawnpoint title None is only allowed for LinkInPointDefault # # (although it would be better to set it to 'Default') # # CleftFissureDrop in this example will fail due to a missing title # # (the correct title is 'FissureDrop') # # - You can tie special actions to linking panels or other journal # # images by defining only the age name. The other definitions must # # be set to None (see 'CleftSpecial') # ############################################################################### LinkDestinations = {'BevinBalcony01': ('Neighborhood', 'LinkInPointBevinBalcony01', 'nb01BevinBalcony01', PtLinkingRules.kOriginalBook), 'CleftDefault': ('Cleft', 'LinkInPointDefault', None, PtLinkingRules.kOriginalBook), 'CleftFissureDrop': ('Cleft', 'LinkInPointFissureDrop', None, PtLinkingRules.kOriginalBook), 'CleftSpecial': ('Dummy', None, None, None), 'KadishPyramid': ('Kadish', 'LinkInPointGlowRmBalcony', 'kdshGlowRmBalcony', PtLinkingRules.kOwnedBook), 'FontTest': (None, None, None, None), 'PradJournal': (None, None, None, None)}

*YourAge*Journals.py
Optional. A file that contains journal texts. Journal texts are written in PBML. Since journal texts are usually rather long we can store them in one or more external files which are imported into *YourAge*PageDefs.py. Replace the examples with your own texts.

Note: The entire book content must be placed on a single line. Or you can use triple quotes to extend your string assignment over multiple lines (thanks Nadnerb).

Code: Select all: # Examples of journals. DefFontTest shows the fonts available in the offline version. DefFontTest = 'Journal Test\n\nATRUS\nThe quick brown fox jumped over the lazy dog.\n0 1 2 3 4 5 6 7 8 9\n\nURU\nThe quick brown fox jumped over the lazy dog.\n0 1 2 3 4 5 6 7 8 9\n\nNICK\nThe quick brown fox jumped over the lazy dog.\n0 1 2 3 4 5 6 7 8 9\n\nSAM\nThe quick brown fox jumped over the lazy dog.\n0 1 2 3 4 5 6 7 8 9\n\nTRICIA\nThe quick brown fox jumped over the lazy dog.\n0 1 2 3 4 5 6 7 8 9\n\nMICHELLE\nThe quick brown fox jumped over the lazy dog.\n0 1 2 3 4 5 6 7 8 9\n\nDNI HAND\nThe quick brown fox jumped over the lazy dog.\n0 1 2 3 4 5 6 7 8 9\n\nYEESHA\nThe quick brown fox jumped over the lazy dog.\n0 1 2 3 4 5 6 7 8 9' DefPradJournal = 'Shorah %s,\n\nAn example which shows how to address players by their own names in a journal.'

dynamic_books_source_3.zip

by **andylegate** » Thu Mar 13, 2008 1:53 pm

Cool! Can't wait to try it out with a future Age! Thanks D'Lanor!

by **Grogyan** » Thu Mar 13, 2008 8:38 pm

D'Lanor, I had a thought today and just like to run it by you, with V3 of the template is it possible to, say touch a bowl of liquid and link, without or with a GUI (eg a swirling image of the liquid where the book would be)?

by **D'Lanor** » Fri Mar 14, 2008 2:27 am

No, that is not possible. I agree that it would be cool. However, this is a book template so I don't want to skip the GUI.

I can program cutscenes for playing bik movies though. I could turn that into a template.

by **Whilyam** » Tue Apr 22, 2008 6:18 pm

Completely clueless here, but, I've done everything the template told me to but I don't know how to get it to work. I assume it's not as simple as "stick the .py files in the python subdirectory.

by **andylegate** » Tue Apr 22, 2008 7:16 pm

You have to make a pak file and compile your journal python into it. The pak file will sit in the Python directory of your Uru install.
Then in your Age, you have to make the book, make it a clickable, put a logic property that says: clickfileX and then the name of the GUI python file you made, and put in a click region around the book.

You have to do that for each journal and linking book you have.

by **Whilyam** » Tue Apr 22, 2008 7:20 pm

How do I make a pak file?

How do I make a click region too?

by **Grogyan** » Tue Apr 22, 2008 10:02 pm

I use PlasmaShop by Zrax, link is in the wiki of free tools

by **D'Lanor** » Tue Apr 22, 2008 11:21 pm

I prefer the GUI version of UruPython since it does not require the installation of Python 2.2. UruPython copies over 2 files from the Uru CC installation the first time you run it and that is all it needs.

by **Whilyam** » Wed Apr 23, 2008 5:26 am

Great! One problem during compliation with the template, though. The line:

Code: Select all: class *YourAge*BookGUI(ptModifier,):

I changed that with my age name (without the asterisks if that's important). And it says there is a syntax error. Is there something I forgot?

Guild of Writers

Dynamic Book Template (version 3.0)

Dynamic Book Template (version 3.0)

Re: Dynamic Book Template (version 3.0)

Re: Dynamic Book Template (version 3.0)

Re: Dynamic Book Template (version 3.0)

Re: Dynamic Book Template (version 3.0)

Re: Dynamic Book Template (version 3.0)

Re: Dynamic Book Template (version 3.0)

Re: Dynamic Book Template (version 3.0)

Re: Dynamic Book Template (version 3.0)

Re: Dynamic Book Template (version 3.0)

Who is online