PorygonA Updates

[Sharlikran]

@PorygonA Okay lets just discuss in an issue rather then the comments section now that you are set up.

So the px and pyare the LibGps coordinates for the x, y location of the book. The tagpm` is the primary map ID for the pin. This means it is where you are standing when you get the information and the location the book is to be displayed primarily.

[7114] = { ["e"] = { [1] = { ["px"] = 0.0815220019, ["py"] = 0.5830836017, ["pm"] = 2114, }, }, }, { ["pnx"] = 0.7893669605, ["pny"] = 0.4129191339 }, -- Green Serpent Bounty, systres/u34_systreszone_base_0

The reason for the [7114] = { ["e"] = { and the rest is if it's a new book I have not entered yet. So what you really want is basically this part.

[1] = { ["px"] = 0.0815220019, ["py"] = 0.5830836017, ["pm"] = 2114, },

So essentially that is all you are adding. Then comes the hard part. We will use the book you want to update.

  [7114] = {
    ["cn"] = "Systres Tomes and Scrolls",
    ["n"] = "Green Serpent Bounty",
    ["e"] = {
    },
    ["c"] = false,
  },

The above is what you start with. Then you paste in the line I mentioned.

Step one

  [7114] = {
    ["cn"] = "Systres Tomes and Scrolls",
    ["n"] = "Green Serpent Bounty",
    ["e"] = {
      [1] = { ["px"] = 0.0815220019, ["py"] = 0.5830836017, ["pm"] = 2114, },
    },
    ["c"] = false,
  },

Add the line for the book.

Step two

  [7114] = {
    ["cn"] = "Systres Tomes and Scrolls",
    ["n"] = "Green Serpent Bounty",
    ["e"] = {
      [1] = { ["px"] = 0.0815220019, ["py"] = 0.5830836017, ["pm"] = 2114, },
    },
    ["c"] = true,
  },

Change ["c"] to true this means it has data in it.

Then you have to be a human. Is this on an overland map? If it is only an overland book you are done. If not now you have to ask are you in a city?

For the city remember you are in it at the time you get the book. So your map ID might be 2114 for example for that city. The fake pin slash command could return 10 as an example. I don't know what High Isle is but we will use 9999 to avoid confusion for what it really is. So with that pretend ID number this is how a pin looks when you are entering a pin for a city.

Step three, add the parent zone map ID

  [7114] = {
    ["cn"] = "Systres Tomes and Scrolls",
    ["n"] = "Green Serpent Bounty",
    ["e"] = {
      [1] = { ["px"] = 0.0815220019, ["py"] = 0.5830836017, ["pm"] = 2114, ["zm"] = 9999, },
    },
    ["c"] = true,
  },

Now with that it is complete. You have the pin location while you are standing in the city px, py, and pm and you have told Lorbooks that the parent zone is 9999 by adding that with ["zm"] = 9999,. When you are looking at the entire zone Lorebooks will know how to draw the book in both places.

Dungeon example

  [2011] = {
    ["c"] = true,
    ["cn"] = "Lore and Culture",
    ["n"] = "Mastery of Discipline",
    ["q"] = 4959,
    ["e"] = {
      [1] = { ["px"] = 0.2941044142, ["py"] = 0.3928760078, ["pm"] = 420, ["zx"] = 0.2927644048, ["zy"] = 0.3921875965, ["zm"] = 20, ["d"] = true, },
    },
  },

So this example is a dungeon pin. px, py and pm are the same. It is where you are when you are underground in the dungeon. So what is new is the ["d"] because that means you are in the dungeon since it is set to true. That prevents the pin from being drawn on the overland map off in some weird location you can not walk to.

What makes it draw on the overland map correctly is the zx, zy, and zm. They are the x and y locations of the pin where you are when you get the fake pin information. Which you normally get at the entrance to the delve. Dungeon usually means anything not a city or the overland map like a delve or undercroft.

So that is why the dungeon pin has two sets of coordinates. One set for where you are in the dungeon and one set for the overland map so people see a pin at about the entrance to the Delve.

[Sharlikran]

Now commit: 46eb008 is the first change as long as it is just an overland book. Now add the ["zm"] if it is in a city, or the other data if it is in a Delve. Then update the commit on your end to your branch rather then master

[PorygonA]

So the one I'm working on

  [7033] = {
    ["cn"] = "Systres Tomes and Scrolls",
    ["n"] = "Report for the Head Jailer",
    ["e"] = {
      [1] = {
        ["px"] = 0.0763844033, ["py"] = 0.5852776124, ["pm"] = 2114, ["zm"] = , },
    },
    ["c"] = true,
  },

2114 is the High Isle zone number. How exactly do I find the zm for Amenos Station, the name of the city this is found in?

[Sharlikran]

Okay so this is one that may or may not need an extra note. I'm going to say it doesn't but I'm still going to show you anyway. The notes however are not complete sentences so they can fit on the tooltip. For example you don't say, "Go around the corner up the stairs to the Green Plant by the sleeping cat." That would be too long.

First when you get the coordinates there are three slash commands

• /lbpos : LBPOS for Lorebooks Position
• /lbfake : for a fake Eidetic Memory location icon when the Lorebook is not on the main zone and you have to enter a delve or public dungeon
• /lbfakebook : for a fake Shalidor's Library location icon when the Lorebook is not on the main zone and you have to enter a delve or public dungeon

For this one it is /lbpos and /lbfake

That is the Lorebook to be recorded

I will refer to this later but notice how I am not really in the building. Your player Arrow is outside the building, sorta. You are underground when you are in the Jailers' Keep. This is a weird concept but something you need to be familiar with as you need to comprehend that as you make fake pins for places where it is more complicated.

This is where I am currently. The primary location for the book. It is always where you are standing. It could be that you are in a Zone, Dungeon, Delve, Undercroft, etc. but try to remember it is where you are physically standing.

When you use /lbpos there is a special command that forces the game to update its internal map information to where you are standing to make sure the location information is accurate. If I didn't do that then because the developers really don't need that there could be information from another location you were at recently.

Knowing that technical stuff isn't needed but I hope it helps you understand why /lbpos behaves the way it does. It can change the map you have selected and if you don't know why then it could be confusing.

Then we type the command to get the information with the book open. If not I could not get the information for the book.

Then you see the text in chat which would end up being this.

[7033] = { ["e"] = { [1] = { ["px"] = 0.0763696033, ["py"] = 0.5852916124, ["pm"] = 2214, }, }, }, { ["pnx"] = 0.5842999220, ["pny"] = 0.3729238212 }, -- Report for the Head Jailer, systres/u34_amenosstation_city_base_0

There is several things there but what we want for now is the [1] part and we know the book ID is 7033.

  [7033] = {
    ["cn"] = "Systres Tomes and Scrolls",
    ["n"] = "Report for the Head Jailer",
    ["e"] = {
      [1] = { ["px"] = 0.0763696033, ["py"] = 0.5852916124, ["pm"] = 2214, },
    },
    ["c"] = true,
  },

So where you are now is map ID 2214.

You don't need that extra window to do this. It's all done for you with the slash command.

Now you need the fake pin information. If it were a Dungeon you enter it differently but for a city where you are standing works for both the city map and the overland map. That's why for a city you only need the other map ID from the parent map. Call it what you want but it's a Map ID. There are other things like a ZoneId or mapIndex but those are different.

To get that you have to zoom the map out first.

When you use /lbfake it won't zoom the map into where you are standing so it will get the information for where you are standing in relation to the map you the player have selected. This would be required for a City like Vvardenfel where you have the Map ID for the Zone itself, the map ID for the city, and the map ID for where you are inside the buildings. For example the Fighters Guild. Those need three or sometimes 4 map pins.

That is why /lbfake gives you the information where you are for the map you selected because once entered it will put the book's Map Pin where you feel it should go to direct the user to it.

[fake] = { ["e"] = { [1] = { ["px"] = 0.0763696035, ["py"] = 0.5852916015, ["pm"] = 2114, ["fp"] = true, }, }, }, { ["pnx"] = 0.6805444360, ["pny"] = 0.4595537484 }, -- fake Eidetic Memory location, systres/u34_systreszone_base_0

Now notice the few differences. First it says [fake] and the map texture is at the end. Most of that is there so I know where the player is from what they copy paste into the comments. The part you want, which will initially be confusing is the ["pm"] because that is where you are standing for the map you selected. So the mapID for the overland map is 2114. But I have to have a unique letter for the data files so it's ["zm"] for the zone's map.

  [7033] = {
    ["cn"] = "Systres Tomes and Scrolls",
    ["n"] = "Report for the Head Jailer",
    ["e"] = {
      [1] = { ["px"] = 0.0763696033, ["py"] = 0.5852916124, ["pm"] = 2214, ["zm"] = 2114, },
    },
    ["c"] = true,
  },

The numbers are similar so that can add to the confusion however, that is the correct way to get the pin entered for the City.

Extra Locations Details

Just know this is an option but something I don't feel you need to do on a regular basis and we don't for this book. It's an option for things that are super complicated to find.

This information is under the Language folder and then the respective language like EN. You have to enter the English value for all Languages regardless of whether or not it is translated or there will be an error.

--[[These are added as Location Details or ["ld"]
]]--
LoreBooks.locationDetails = {
  [1] = "Guest Room",
  [2] = "Attic Room",
  [3] = "Hidden Basement",
}

So what would have to happen is another new note would be added and you might make a comment. I haven't because I would normally be the only person.

LoreBooks.locationDetails = {
  [1] = "Guest Room",
  [2] = "Attic Room",
  [3] = "Hidden Basement",
  [4] = "Jailers' Keep",
}

Then the complete pin information for the extra details

  [7033] = {
    ["cn"] = "Systres Tomes and Scrolls",
    ["n"] = "Report for the Head Jailer",
    ["e"] = {
      [1] = { ["px"] = 0.0763696033, ["py"] = 0.5852916124, ["pm"] = 2214, ["zm"] = 2114, ["ld"] = 4, },
    },
    ["c"] = true,
  },

Then you have the additional note so you aren't trying to look in the bushes or on a large rock for the book. The reason being there is no small map for the Jailers' Keep yet you will sorta zone under the world in the city into the Jailers' Keep so that's why your player Arrow is off outside the building where you could never really walk to.

I still wouldn't add the extra details but that would be how you get the City pin, how you enter it, how to get the fake pin and use that for the ["zm"] portion, and if it is really needed an extra note to help the user find the book. I prefer we talk about the notes first though.

[Sharlikran]

    ["e"] = {
      [1] = { ["px"] = 0.0763696033, ["py"] = 0.5852916124, ["pm"] = 2214, ["zm"] = 2114, },
    },

I know it's nit-picky but enter all the information on one line. I ask that because when you have say 4 pin locations for a complicated book then I want it that way so that a year form now it's easier to remember which lines belong together for a book. Because you can enter comments at the end like -- Book Name and then everyone would know the 4 lines are for the same book.

[Sharlikran]

@PorygonA After the holidays keep in touch and I can answer any questions. In the forums I can be a bit abrupt but for learning something when I know it is new to you I'm happy to help. Especially if you have trouble with Git For Windows and making updates.

[PorygonA]

Will do.

I've been starting with the books that I've entered the data for, and auditing to make sure they show up on the map. What is the ["zt"]?

An example:

[5450] = { ["c"] = true, ["e"] = { [1] = { ["d"] = true, ["py"] = 0.6902691936, ["zt"] = 1121, ["px"] = 0.5083984238, ["pm"] = 1655, }, }, ["n"] = "Letter to Bakul", ["cn"] = "Anequina Archives", },

[Sharlikran]

That is more or less unused. It is for special cases where I could not convert the old data with the information provided.

If you have a book, if the old data has that but you have all the new data, only enter the new data please.

[Sharlikran]

Not accusing anyone but I do want to mention this to each of you because there are a few books this way. I just don't remember if there was support for the Reach in v23 or not. Plus I have been the only person entering data so far. So I don't see how this got this way.

The data from what is copy pasted into chat is all you need except you may need to rename ["pm"] to ["zm"] for fake pins.

This is incorrect

  [6447] = {
    ["c"] = true,
    ["e"] = {
      [1] = {
        ["py"] = 0.2792400000,
        ["px"] = 0.3814500000,
        ["pm"] = 1814,
        ["mn"] = 42,
        ["d"] = false,
        ["r"] = false,
        ["i"] = 12,
      },
    },
    ["n"] = "Namira's Dance",
    ["cn"] = "The Reach Reader",
  },

This is all that is needed

  [6447] = {
    ["c"] = true,
    ["e"] = {
      [1] = { ["px"] = 0.3814180048, ["py"] = 0.2793443956, ["pm"] = 1814, },
    },
    ["n"] = "Namira's Dance",
    ["cn"] = "The Reach Reader",
  },

[Sharlikran]

@PorygonA and use your branch dev-porygona. Switch to it in Git For Windows. I may rebase and if I do just clone the repo again. You might wan to work on your book entries in the .\live\Addons folder so you see the changes. Then use any free program or a program like BeyondCompare known as a diff program. That way you copy your changes into whatever is current.

I'm not sure how to keep your branch up to date with you being new to Git so not sure how to handle things the best.

Another thing we could do is let me know when you have something to submit and I can rebase the branch first and then you can copy your changes using a diff program so you don't revert other changes. Then I can look at the changes on your branch.

It might take some trial and error to get a good workflow.

Again enjoy the Holidays this can wait.

[PorygonA]

I've only touched High Isle, Rockgrove, and Sunspire. No clue about the Reach thing.

I've been working on my book entries in the \Live\Addons folder, no worries there. I gotta make sure everything actually shows up properly.

I'll have the High Isle + Ascending Tide up soon.

[Sharlikran]

Okay I'll get your branch ready. I appreciate you understanding about what I said. There was no tonality in it or accusation. I'm typing in a browser and no way to position myself to be sure you know it's just for clarification. Thanks.

[Sharlikran]

Because I'm updating the routines to draw the pins and I found this.

  [6395] = {
    ["c"] = true,
    ["e"] = {
      [1] = {
        ["px"] = 0.3426200000,
        ["py"] = 0.2874700000,
        ["pm"] = 1858,
        ["mn"] = 42,
        ["d"] = false,
        ["r"] = false,
        ["i"] = 12,
        ["zm"] = 1814,
      },
    },
    ["n"] = "An Imperial in Markarth",
    ["cn"] = "The Reach Reader",
  },

And I'm like, how? If I did that in the beginning and that was a long time ago when I didn't understand how things worked.

[Sharlikran]

  [5899] = {
    ["c"] = true,
    ["q"] = 6480,
    ["e"] = {
      [1] = { ["px"] = 0.7014312166, ["py"] = 1.5382663980, ["pm"] = 1809, ["zx"] = 0.7014312222, ["zy"] = 1.5382664378, ["zm"] = 1747, ["d"] = true, ["qp"] = true, },
    },
    ["n"] = "Miner's Journal",
    ["cn"] = "Solitude Soliloquies",
  },

["q"] = QuestID to be used for the name and whether or not you are actively doing the quest or whether or not you completed the quest.
["qp"] = true, Quest In Progress. Means you have to have the quest is your Journal for the book to be shown.
["qc"] = true, = Quest Completed. Means you have to have completed the quest for the book to be shown.

["i"] and ["l"] have been depreciated.

[Sharlikran]

@PorygonA The current syntax should be updated for the Readme.

[PorygonA]

Gotcha, looks great!

Question: What exactly should I be doing right now? Yachoor seems to have uploaded all of the data that I posted in the thread, so what exactly needs to be done still?