Illy Text Markup Language (ITML) explained |
Post Reply ![]() |
Author | |
GM Stormcrow ![]() Moderator Group ![]() ![]() GM Joined: 23 Feb 2010 Location: Illyria Status: Offline Points: 3926 |
![]() ![]() ![]() ![]() ![]() Posted: 28 Apr 2016 at 00:28 |
As per Dal Rath's request for a breakdown of what the parameters mean in (eg) a parsed notification XML.
INTRODUCTION TO THE ILLY TEXT MARKUP LANGUAGE (ITML?) We have marked-up data that we present to the front end of Illyriad. To all users, this data doesn't appear visibly, as the front end UI parses it and turns it into something human-legible. This is markup data that looks something like this: [@ps=GM Stormcrow|1|DEVS|18|1|0|740-746-755-0-0-0-0-0-0-0-0-0-0|Illyriad Dev Team|Game Master|10-456-294-72] Spearsmith L3 completed at [@t=Stormont|1|383|-1815|12944|1|1|1|51|1|GM Stormcrow|DEVS|1|5-4 wall]. Your building queue is empty. If you have never seen this, and this has never troubled your thoughts in any way, you do not need to read on. It's not important. WHY ON EARTH DO YOU HAVE YOUR OWN MARKUP FORMAT? The reason these artifacts exist at the front end is pretty simple. We wanted to provide a single front-end interface where pop-ups did not have to go back and talk to the server. We already have to display player information onscreen, so why go back and ask the server for new information when someone clicks a popup? Simply put, the way we've structured the extraordinarily database-driven Illy infrastructure means that it's far more efficient for us to present mostly redundant information to the front end up-front... than it is for us to ask multiple questions of the data on player demand. Each descriptor of (eg) a player, town or location would contain, hidden in the UI, everything that the pop-up window needs onclick to display further information. GOSH, THIS ALL MAKES AMAZING SENSE. WHAT ARE THE DIFFERENT DESCRIPTORS? I'm glad you asked. There are a number of different formats used, depending on purpose. The most common ones (and probably the only ones that need explanation) are:
p=player, t=town. Pretty straightforward, huh? TOTES AMAZEBALLS INNIT. DOES U HAZ GRAMMAR? There's a difference on the demarcator for 'owning' objects such as player and town. You may get [@ps=] or [@ts=]. The additional 's' marks a grammatical possessive that, when displayed, marks the content as being used in the context of a genitive rather than a nominative, locative or accusative case. So: [@p=GM Stormcrow|1|DEVS|18|1|0|740-746-755-0-0-0-0-0-0-0-0-0-0|Illyriad Dev Team|Game Master|10-456-294-72] will return on ingame display: GM Stormcrow [DEVS] But: [@ps=GM Stormcrow|1|DEVS|18|1|0|740-746-755-0-0-0-0-0-0-0-0-0-0|Illyriad Dev Team|Game Master|10-456-294-72] will return on ingame display: GM Stormcrow's [DEVS] ... indicating that this specific grammatical usage of my playername is contextually genitive. So, from the example at the top: [@ps=GM Stormcrow|1|DEVS|18|1|0|740-746-755-0-0-0-0-0-0-0-0-0-0|Illyriad Dev Team|Game Master|10-456-294-72] Spearsmith L3 completed at[@t=Stormont|1|383|-1815|12944|1|1|1|51|1|GM Stormcrow|DEVS|1|5-4 wall]. Your building queue is empty. Because it's using the -s genitive indicator, will return on display: GM Stormcrow's [DEVS] Spearsmith L3 completed at Stormont. Your building queue is empty. GOSH, THIS IS AMAZING. RUN ME THROUGH THE PLAYER MARKUP! They're all pretty simple, and - as said - are focused on what appears in the popup window if you click on the link associated with the markup. All the markup formats are pipe-delimited for the different categories, and hyphen delimited for the sub-elements. Example: [@p=GM Stormcrow|1|DEVS|18|1|0|740-746-755-0-0-0-0-0-0-0-0-0-0|Illyriad Dev Team|Game Master|10-456-294-72] This breaks down into PURPOSE (DATATYPE): EXAMPLE as follows:
WOW SC, YOU'RE THE BEST! BUT YOU'D BE EVEN BETTER IF YOU RAN THROUGH TOWNS! Well, you're very kind indeed. But sure, here's the [@t=] breakdown: [@t=Stormont|1|383|-1815|12944|1|1|1|51|1|GM Stormcrow|DEVS|1|5-4 wall] This breaks down as follows:
TLDR; There's some stuff that does some shizzle somewhere in the game that's hidden from view for most all players. It doesn't have anything earth-shattering in it; though my understanding of what some players think about handling "sensitive" data has been somewhat astonishingly amended as of late ![]() ![]() If you skipped to this tldr; then you *really* didn't need to know. Regards, SC Edited by GM Stormcrow - 28 Apr 2016 at 03:45 |
|
![]() |
|
Tensmoor ![]() Postmaster General ![]() ![]() Joined: 07 Apr 2015 Location: Scotland Status: Offline Points: 1830 |
![]() ![]() ![]() ![]() ![]() |
Thanks for that SC. I'd managed to work most of that out but confirmation is always good
![]() |
|
![]() |
|
Rill ![]() Postmaster General ![]() ![]() Player Council - Geographer Joined: 17 Jun 2011 Location: California Status: Offline Points: 7078 |
![]() ![]() ![]() ![]() ![]() |
/me switches out medals and looks around suspiciously
Thanks for the info, Stormcrow.
|
|
![]() |
|
kurim ![]() New Poster ![]() ![]() Joined: 07 Jan 2018 Location: VietNam Status: Offline Points: 1 |
![]() ![]() ![]() ![]() ![]() |
Thanks you, this is what i was looking for ^^
|
|
![]() |
Post Reply ![]() |
|
Tweet
|
Forum Jump | Forum Permissions ![]() You cannot post new topics in this forum You cannot reply to topics in this forum You cannot delete your posts in this forum You cannot edit your posts in this forum You cannot create polls in this forum You cannot vote in polls in this forum |