Vana'diel Clock

[nebula]

I was bored, i really have no use for this but it seems the clock thingy in ffassist is popular. feel free to use the code and pretty it up with moon phase pics or what-not, jes give credit where credit is due

oh, and btw, this is prolly buggier than hell, if times are way off, post your timezone, your clock time, and the time the script said it should be and i'll look more at it

oh a note about FixTime, its vanadiel minutes, so 15*60 would actually be 15 minutes ingame VD time, differences in clock values are prolly from this value being different for people




Clock.lua
-- Vana'diel Clock by Nebula
-- Copyright (C) 2006 Kyle Buller
--
-- Code adapted from FFXI Time Information by Pyogenes (http://www.pyogenes.com/ffxi/timer/)
-- (and by adapted, i mean changed, mangled, and forced to work)
--
-- Note: All times are translated from YOUR SYSTEM clock, not magically pulled from the ffxi servers
--       if the times are wrong *cough*its very likely i screwed something up*cough* sync your clock
--

GMTOffset = -6 --your timezone rel to GMT
FixTime = 15*60 --number of seconds to add if your clock is off (subjective)
showSeconds = 1 --0 = off, 1 = show seconds on moon timers, 2 = show vana'diel (milli)seconds

-- Don't touch --

-- dates used to convert real time to game time
BasisDate = os.time{year=2002, month=6, day=23, hour=16+GMTOffset, min=0, sec=0}
MoonDate = os.time{year=2004, month=1, day=25, hour=2+GMTOffset, min=31, sec=12}

VanaDayList = {"Earthsday", "Watersday", "Windsday", "Iceday", "Lightningsday", "Lightsday", "Darksday","Firesday"}
PhaseNameList = {"Full Moon","Waning Gibbous","Last Quarter Moon","Waning Crescent","New Moon","Waxing Crescent","First Quarter Moon","Waxing Gibbous"}

msGameDay = (24 * 60 * 60 * 1000 / 25)  --milliseconds in a game day
msRealDay = (24 * 60 * 60 * 1000)       --milliseconds in a real day

--returns a string if no 'formating string', returns a table if passed "*t"
function getVanadielTime(f)
 local now = os.time()
 local vTime = ((898 * 360 + 30 + 32) * msRealDay + FixTime*1000) + (now * 1000 - BasisDate * 1000) * 25
 
 local vYear = math.floor(vTime / (360 * msRealDay))
 local vMon  = math.floor(math.mod(vTime, 360 * msRealDay) / (30 * msRealDay)) --+ 1
 local vDate = math.floor(math.mod(vTime, 30 * msRealDay) / (msRealDay)) --+ 2
 local vHour = math.floor(math.mod(vTime, msRealDay) / (60 * 60 * 1000)) --+ 1
 local vMin  = math.floor(math.mod(vTime, 60 * 60 * 1000) / (60 * 1000))
 local vSec  = math.floor(math.mod(vTime, 60 * 1000) / 1000)
 local vDay  = math.floor(math.mod(vTime, 8 * msRealDay) / msRealDay) + 1
 
 local VanaTimeTable = {year=vYear, month=vMon, day=vDate, hour=vHour, min=vMin, sec=vSec, wday=vDay}
 local VanaTime = string.format("%02d/%02d/%d, %s, %02d:%02d",vMon,vDate,vYear,VanaDayList[vDay],vHour,vMin)
 if showSeconds == 2 then
   VanaTime = VanaTime .. string.format(":%02d",vSec)
 end
 
 if f == nil then
   return VanaTime
 elseif f == "*t" then
   return VanaTimeTable
 end
end

function getMoonPhase()
 --new moon starts on day 38 (-10%)
 --full moon starts at 80 (90%)
 --Moon cycle lasts 84 game days
 local now = os.time()
 local moonDays = math.mod(math.floor((now * 1000 - MoonDate * 1000) / msGameDay),84)
 local mnElapsedTime = math.mod(now * 1000 - MoonDate * 1000,msGameDay)
 local mnPhase, optPhase, toNextPhase, toOptimalPhase
 
 -- determine phase percentage
 local moonpercent = math.floor(((moonDays - 42) / 42 * 100) + 0.5)
 
 if (moonpercent <= -94)  then
   mnPhase = 1
   optPhase = 5
   toNextPhase = (3 - moonDays) * msGameDay - mnElapsedTime
   toOptimalPhase = (38 - moonDays) * msGameDay - mnElapsedTime
 elseif (moonpercent >= 90) then
   mnPhase = 1
   optPhase = 5
   toNextPhase = (87 - moonDays) * msGameDay - mnElapsedTime
   toOptimalPhase = (38 + 84 - moonDays) * msGameDay - mnElapsedTime
 elseif (moonpercent >= -93 and moonpercent <= -62)  then
   mnPhase = 2
   optPhase = 5
   toNextPhase = (17 - moonDays) * msGameDay - mnElapsedTime
   toOptimalPhase = (38 - moonDays) * msGameDay - mnElapsedTime
 elseif (moonpercent >= -61 and moonpercent <= -41) then
   mnPhase = 4
   optPhase = 5
   toNextPhase = (25 - moonDays) * msGameDay - mnElapsedTime
   toOptimalPhase = (38 - moonDays) * msGameDay - mnElapsedTime
 elseif (moonpercent >= -40 and moonpercent <= -11) then
   mnPhase = 4
   optPhase = 5
   toNextPhase = (38 - moonDays) * msGameDay - mnElapsedTime
   toOptimalPhase = (38 - moonDays) * msGameDay - mnElapsedTime
 elseif (moonpercent >= -10 and moonpercent <= 6) then
   mnPhase = 5
   optPhase = 1
   toNextPhase = (45 - moonDays) * msGameDay - mnElapsedTime
   toOptimalPhase = (80 - moonDays) * msGameDay - mnElapsedTime
 elseif (moonpercent >= 7 and moonpercent <= 36) then
   mnPhase = 6
   optPhase = 1
   toNextPhase = (58 - moonDays) * msGameDay - mnElapsedTime
   toOptimalPhase = (80 - moonDays) * msGameDay - mnElapsedTime
 elseif (moonpercent >= 37 and moonpercent <= 56) then
   mnPhase = 7
   optPhase = 1
   toNextPhase = (66 - moonDays) * msGameDay - mnElapsedTime
   toOptimalPhase = (80 - moonDays) * msGameDay - mnElapsedTime
 elseif (moonpercent >= 57 and moonpercent <= 89) then
   mnPhase = 8
   optPhase = 1
   toNextPhase = (60 - moonDays) * msGameDay - mnElapsedTime
   toOptimalPhase = (80 - moonDays) * msGameDay - mnElapsedTime
 end
 
 local currentPhase = string.format("%s (%d%%)",PhaseNameList[mnPhase],math.abs(moonpercent))
 local nextPhase = string.format("Next phase (%s): %s",PhaseNameList[math.mod(mnPhase,8)+1],formatTime(toNextPhase))
 local nextOptPhase = string.format("Next %s: %s",PhaseNameList[optPhase],formatTime(toOptimalPhase))
 
 return currentPhase, nextPhase, nextOptPhase
end

function formatTime(t)
 local dayLeft = t / msRealDay
 local hourLeft = (dayLeft - math.floor(dayLeft)) * 24
 local minLeft = (hourLeft - math.floor(hourLeft)) * 60
 local secLeft = (minLeft - math.floor(minLeft)) * 60
 local formattedTime = ""
 
 dayLeft = math.floor(dayLeft)
 hourLeft = math.floor(hourLeft)
 minLeft = math.floor(minLeft)  
 
 if dayLeft > 0 then formattedTime = formattedTime .. string.format("%d:",dayLeft) end
 if hourLeft > 0 then formattedTime = formattedTime .. string.format("%02d:",hourLeft) end
 formattedTime = formattedTime .. string.format("%02d",minLeft)
 if showSeconds then formattedTime = formattedTime .. string.format(":%02d",secLeft)  end
 return formattedTime
end

Text = Graphics.text_CreateObject()
Graphics.text_SetPosition(600,50,Text)
Graphics.text_SetColor(255,255,255,255,Text)
Graphics.text_SetFont("Arial Bold",11,Text)
Graphics.text_SetBold(true,Text)

while true do
 local Output = ""
 --Output = Output .. os.date("%a. %d, %Y %I:%M%p") .. "\n"
 Output = Output .. string.format("%s\n",getVanadielTime())
 Output = Output .. string.format("%s\n%s\n%s\n",getMoonPhase())
 Graphics.text_SetText(Output,Text)
 
 Windower.script_Sleep(900)
end


Airship schedule (added 1/1/06)






Airship.lua
-- Vana'diel Clock: Airship Schedule by Nebula
-- Copyright (C) 2006 Kyle Buller
--
-- Code adapted from FFXI Time Information by Pyogenes (http://www.pyogenes.com/ffxi/timer/)
-- (and by adapted, i mean changed, mangled, and forced to work)
--
-- Note: All times are translated from YOUR SYSTEM clock, not magically pulled from the ffxi servers
--       if the times are wrong *cough*its very likely i screwed something up*cough* sync your clock

GMTOffset = -6
FixTime = 15*60

-- Be careful --

Text = Graphics.text_CreateObject()
Graphics.text_SetPosition(400,100,Text)
Graphics.text_SetColor(255,255,255,255,Text)
Graphics.text_SetFont("Courier New",11,Text) --pick a fixed width font or it won't look pretty
Graphics.text_SetBold(true,Text)

-- Don't touch --

Graphics.text_SetText("Loading...",Text)

BasisDate = os.time{year=2002, month=6, day=23, hour=16+GMTOffset, min=0, sec=0}
MoonDate = os.time{year=2004, month=1, day=25, hour=2+GMTOffset, min=31, sec=12}

VanaDayList = {"Earthsday", "Watersday", "Windsday", "Iceday", "Lightningday", "Lightsday", "Darksday","Firesday"}

msGameDay = (24 * 60 * 60 * 1000 / 25)  --milliseconds in a game day
msRealDay = (24 * 60 * 60 * 1000)       --milliseconds in a real day

function getAirSchedule()
 local now = os.time()
 local elapsedTime = math.mod(now * 1000 - BasisDate * 1000, msGameDay) + 144000
 
 local vTime = ((898 * 360 + 30) * msRealDay + FixTime*1000) + (now * 1000 - BasisDate * 1000) * 25
 local vDay  = math.floor(math.mod(vTime, 8 * msRealDay) / msRealDay) + 1
 
 local offset1 = ((1 * 60) + 10) * 60 * 1000 / 25 -- 1:10 offset used by B->J J->S
 local offset2 = ((2 * 60) + 40) * 60 * 1000 / 25 -- 2:40 offset used by J->W K-J
 local offset3 = ((4 * 60) + 10) * 60 * 1000 / 25 -- 4:10 offset used by J->B S->J
 local offset4 = ((5 * 60) + 35) * 60 * 1000 / 25 -- 5:35 offset used by J->K
 local offset5 = ((5 * 60) + 45) * 60 * 1000 / 25 -- 5:45 offset used by W->J

 local outAir = string.format("%s %s %s %s\n",
   padstring("Airship Route",20),
   padstring("Day",14),
   padstring("Arrive",8),
   padstring("Depart",8)
 )  
 outAir = outAir .. ASHelper(elapsedTime, offset3, vDay, "Jeuno To Bastok")
 outAir = outAir .. ASHelper(elapsedTime, offset4, vDay, "Jeuno To Kazham")
 outAir = outAir .. ASHelper(elapsedTime, offset1, vDay, "Jeuno To San d'Oria")
 outAir = outAir .. ASHelper(elapsedTime, offset2, vDay, "Jeuno To Windurst")
 outAir = outAir .. "\n"
 outAir = outAir .. ASHelper(elapsedTime, offset1, vDay, "Bastok To Jeuno")
 outAir = outAir .. ASHelper(elapsedTime, offset2, vDay, "Kazham To Jeuno")
 outAir = outAir .. ASHelper(elapsedTime, offset3, vDay, "San d'Oria To Jeuno")
 outAir = outAir .. ASHelper(elapsedTime, offset5, vDay, "Windurst To Jeuno")
 
 return outAir
end

function ASHelper(Elapsed, Offset, Day, City)
  local newOffset = Offset;
  local count = 0
  while (newOffset < Elapsed) do
     count = count + 1
     newOffset = newOffset + (msGameDay / 4)
  end
  if (count >= 4) then
     Day = math.mod(Day + 1, 8)
  end
 
  local arrivalTime = newOffset - Elapsed - 144000
  if (arrivalTime < 0)  then
     arrivalTime = 0
  end
 
  local s = string.format("%s %s %s %s\n",
    padstring(City,20),
    padstring(VanaDayList[Day],14),
    padstring(formatTime(arrivalTime),8),
    padstring(formatTime(newOffset-Elapsed),8)
  )
 
  return s
end

function padstring(s,len)
 if string.len(s) > len then return s end
 
 s = s .. string.rep(" ",len-string.len(s))
 return s
end
 
function formatTime(t)
 local hourLeft = (t / msRealDay - math.floor(t / msRealDay)) * 24
 local minLeft = (hourLeft - math.floor(hourLeft)) * 60
 local secLeft = (minLeft - math.floor(minLeft)) * 60
 
 return string.format("%02d:%02d",math.floor(minLeft),secLeft)
end
 
while true do
 Output = string.format("\n%s\n",getAirSchedule())
 Graphics.text_SetText(Output,Text)
 
 Windower.script_Sleep(1000)
end


[X-Drop]

Great job, Nebula. I've never seen the original code, but this is some cool stuff.

Me being new to scripting, I can easily see that you have been doing this for a while now. I don't know what your background is, but this makes 2 solid scripts you've posted so far (this one and ExpMon). I love to see new material posted, especially when I get to study good programming. For instance, this Vana'diel Clock provides good examples of defining "local" varibales and I now understand the use of "return". I couldn't understand what "return" did (never read about it actually), but now I can see how it can return values for a function called within a string.format statement. I can definetely take advantage of that.

Clock worked great until Firesday.
VanaDayList = {"Firesday", "Earthsday", "Watersday", "Windsday", "Iceday", "Lightningsday", "Lightsday", "Darksday"}

...

vDay = math.floor(math.mod(vTime, 8 * msRealDay) / msRealDay) + 2

...

VanaTime = string.format("%02d/%02d/%d (%s) %02d:%02d",vMon,vDate,vYear,VanaDayList[vDay],vHour,vMin)
vDay I believe isn't equating to 1 to call "Firedays" out of the VanaDayList table. Easy enough to fix.

[nebula]

there, i reordered the daylist (its like the week starts on monday, not sunday >.> and added a time difference to the base vTime equation (it jes kinda seemed to work) added var for your timezone, added a var to try and sync your time manually, fixed the countdown formatting function, and it almost looks like it works now >.>

as for my background, i've been programming for awhile

[deathravin]

This is really cool - is there any way you can put a "Airship Arrival", and maybe RSE data that can all be turned on and off... That'd be cool...

I'll maybe try to make my own that combines the clock and exp monitor.

[nebula]

combine? you can jes run both at once, like i have shown in that ss, lol, and yea...you could do airship arrivals and rse stuff

[cartman]

Hi Nebula,

I manage to get it to work but my FFXI show Earthday but the Clock show Firesday. did i do anything worng i copy the script and save using notepad with name Clock.lua

I am sorry i forgot to change the time zone i got it to work but i am still off by 1min game time my FFXI clock showing 22.40 but the Lua clock show 23.40 what do i need to change to sync it

I use Atomic clock to sync my system clock but still off by a min or so .

Btw Nice work

[sdphantom]

cartman said:

I use Atomic clock to sync my system clock but still off by a min or so .

Ya, there's a problem with taking time from the local sysyem is the local system loses sync within a few mins. When amplified 25 times, that can become a huge gap really quick.

That and syncing time online is unreliable when considered with such precision, you'd only get the time sync'd with the error range of a few seconds. This kind of thing is expected due to the variance of delay between you and the time server.

[nebula]

play with the FixTime var to get your clock right i've ran around testing it for a long period of time and i didn't lose sync *shrug*

[cartman]

Hi All,

Thank for the clarification.

As for the FixTime = 15*60 --number of seconds to add if your clock is off (subjective)

how do i change it as i dont know what 15*60 represent ? is it 15 * 60's or 15's * 60 ?

Thankie
Cartman

[sdphantom]

cartman said:

Hi All,

Thank for the clarification.

As for the FixTime = 15*60 --number of seconds to add if your clock is off (subjective)

how do i change it as i dont know what 15*60 represent ? is it 15 * 60's or 15's * 60 ?

Thankie
Cartman

It looks like the value is adjusting for 15 minutes (15*60 seconds).

[phr33k]

Great work! Just a couple things worth mentioning, the script doesn't take into account Daylight saving time. For example i am in eastern canada, GMT-5 , but the clock is off by a real time hour. So until we have to wind the clock back up an hour, i have to use GMT-6 , even though that isn't my time zone.

Don't know how much effort is needed to implement that, but either way, just pointing it out

Also, is there any possibilty that you could make a Boat (ship) clock? Selbina > Mhaura , Mhuara > Selbina, Manaclipper etc...

That would be an awesome addition, either way, thanks alot!

[DarkAquaus]

Suggestion... base script off of GMT time 0 or PST time >.>

[sdphantom]

darkaquaus said:

Suggestion... base script off of GMT time 0 or PST time >.>

I'm working on debugging the script to find why time localization is becoming such a problem. The tests that I've run on the os.time() function (without any arguements) reports that the value returned is in fact, GMT time. I've noticed that when passed a custom time, it may determine the time passed as local time instead of GMT time. The script comes at this at a wrong approach, trying to dynamically determine the offset instead of having a static formula.

I'm currently writing a much more simple script with a single formula to convert the value returned by os.time() (seconds since epoch, Jan 1, 1980 12:00am) into a value of game seconds since 0:00 1/1/000.

Several notes are being considered:
(all times are refered to as game time unless specified)
1 real second = 25 game seconds
1 week = 8 days
1 month = 30 days
1 year = 360 days (12 months)
1 moon cycle = 84 days

All I need to write this formula is right here, the ratio of real time to game time and the offset determined from the time differences. So far, I've already gotten the offset far enough to determine the time of day (hours, minutes, and even seconds) with the error ratio of a real second due to the local time not always being in sync and/or delays in the FFXI client.

[sdphantom]

phr33k said:

Also, is there any possibilty that you could make a Boat (ship) clock? Selbina > Mhaura , Mhuara > Selbina, Manaclipper etc...

After I get the primary formula finnished to return the game time in seconds, it should be easy to determine and write additional offsets to lay on top for airship, manaclipper, Selbina-Mhaura, and just about anything else that happens regularly.

[sdphantom]

The new script I have running now runs with half the lines of code than this and runs at zero-config, meaning supposedly there is no need to configure for whatever timezone you're in.

It's still in the testing phase to determine long-time accuracy. The code in its current condition displays actual game seconds as well and uses a little offset code using os.clock() to make os.time() more precise with the game time formula.

The code also features an active percent display for the moon phase. as well as the day of week and game date.