Discussion Commanders log manual and data sample

The latest version of the manual has been uploaded to the fileserver:

http://hosting.zaonce.net/community/journal/v3/Journal_Manual.doc

Quite a few of your suggestions over the last few weeks have been implemented (and I'm currently adding some more detail for passenger missions)

change log:

• Include ShipID in Module outfitting events
• Change some bool values from 1/0 to true/false
o Resurrect/Bankrupt
o Scan/TidalLock,Landable
o Interdicted/Submitted
o LaunchFighter/PlayerControlled
o EjectCargo/Abandoned
o CollectCargo/Stolen
o ShieldState/ShieldsUp
• Include Major faction “Alliegance” in Location/FSDjump/Docked events
• Include surface gravity, pressure, temperature for a planet
• Include more info about rings when scanning star or planet
• Add events for NPC Crew interaction
• Localised text is in UTF8 encoding
• Added events DatalinkVoucher and DataScanned
• Added events JetConeBoost and JetConeDamage
• Added BrokerPercentage value to PayFines and RedeemVoucher
• Added ModuleStore and ModuleRetrieve
• Added the PVPKill event
• File saved in SavedGames folder
• Added “Continued” event
• Added MissionID parameter in mission events

Thanks, looking into that.
 
The latest version of the manual has been uploaded to the fileserver:

http://hosting.zaonce.net/community/journal/v3/Journal_Manual.doc

Quite a few of your suggestions over the last few weeks have been implemented (and I'm currently adding some more detail for passenger missions)

change log:

• Include ShipID in Module outfitting events
• Change some bool values from 1/0 to true/false
o Resurrect/Bankrupt
o Scan/TidalLock,Landable
o Interdicted/Submitted
o LaunchFighter/PlayerControlled
o EjectCargo/Abandoned
o CollectCargo/Stolen
o ShieldState/ShieldsUp
• Include Major faction “Alliegance” in Location/FSDjump/Docked events
• Include surface gravity, pressure, temperature for a planet
• Include more info about rings when scanning star or planet
• Add events for NPC Crew interaction
• Localised text is in UTF8 encoding
• Added events DatalinkVoucher and DataScanned
• Added events JetConeBoost and JetConeDamage
• Added BrokerPercentage value to PayFines and RedeemVoucher
• Added ModuleStore and ModuleRetrieve
• Added the PVPKill event
• File saved in SavedGames folder
• Added “Continued” event
• Added MissionID parameter in mission events

Thank you for the update! I still would like to have some stuff here mentioned earlier (for precise credits/assets/cargo/materials tracking, which is not possible to do currently in many cases), but in overall - great work!
 

Thanks for the update, lots of good thing in there. And as you're still working on it any chance of a few extras?

  • Add age to the results of the scan for stellar bodies
  • Add an 'Atmosphere restored' event for when the atmosphere for a cockpit is restored (e.g. when entering a station)
  • Add an equivalent 'Atmosphere lost' event when the player leaves an atmosphere area with a broken cockpit
 
Awesome, thanks!

A couple of comments:

* Keys: just to avoid any parsing issue, could they be all lowercase?


* Para 2.2: "If the play session goes on a long time, and the journal gets very large, the file will be closed and a new file started with an increased part number" Add: "The heading entry is added at the beginning of every file"

Question: Would it be possible to get current state info in these additional files, such as material counts, ship state, and so on?

EDIT: And as an added feature, could route information be included when it changes? Such as destination, systems in path, bookmarks?
 
Last edited:
Thanks for the update. I see some helpful additions there.

Question: why IsPlayer looks like boolean, but is in quotes? "true"

As for further ideas – some events helping with inventory management (materials, cargo) could be helpful – like dumping commander data at the start of the session maybe?

Also, a combat scan event would be nice – like getting detailed info about NPC/CMDR ship we scanned.

PS: I extracted all the examples and put them into one formatted JSON file if someone would like to have that – pastebin.com/gixXBisn
 
Is there any mention of safe to disengage when approaching a station , ? And if not can it be included. Would be very handy for Voice attack when using the 'Jump' to Hyperspace , as the 'Third event' thus allowing a one JUMP command for hyperspace jumping. Jump to a system 1st, keep Jumping to another system 2nd etc...., then , JUMP when safe to disengage appears.
And , also , an event for when Docking fails/successful . Anything that allows Voice attack to sync with cockpit functions, and/or outside events would be great.
 
Last edited:
Great update. A couple of additions I'd love to see if there's another iteration:

- SupercruiseExit parameter indicating the target exited at. Examples: station name, RES type, USS, Mission Target etc. This could replace the miscellaneous USSDrop event.
- Mining prospecting result: type of ore and quantity.
 
Thanks for the update! Almost there I would say.

As mentioned a few times before, a dump at the beginning of the file of the currently held materials and cargo hold contents would be a great addition.
 
As mentioned a few times before, a dump at the beginning of the file of the currently held materials and cargo hold contents would be a great addition.
Alternatively, if you don't want to add a cargo and material status dump to the Journal, please add materials to the Companion API output.
 
The latest version of the manual has been uploaded to the fileserver:

http://hosting.zaonce.net/community/journal/v3/Journal_Manual.doc

Quite a few of your suggestions over the last few weeks have been implemented (and I'm currently adding some more detail for passenger missions)

change log:

• Include ShipID in Module outfitting events
• Change some bool values from 1/0 to true/false
o Resurrect/Bankrupt
o Scan/TidalLock,Landable
o Interdicted/Submitted
o LaunchFighter/PlayerControlled
o EjectCargo/Abandoned
o CollectCargo/Stolen
o ShieldState/ShieldsUp
• Include Major faction “Alliegance” in Location/FSDjump/Docked events
• Include surface gravity, pressure, temperature for a planet
• Include more info about rings when scanning star or planet
• Add events for NPC Crew interaction
• Localised text is in UTF8 encoding
• Added events DatalinkVoucher and DataScanned
• Added events JetConeBoost and JetConeDamage
• Added BrokerPercentage value to PayFines and RedeemVoucher
• Added ModuleStore and ModuleRetrieve
• Added the PVPKill event
• File saved in SavedGames folder
• Added “Continued” event
• Added MissionID parameter in mission events

Thank you!
Some thoughts upon reading:
8.22 RedeemVoucher - are DatalinkVouchers also counts? As in document, only combat bonds and bounties are mentioned (I have strong impression that while being a good source of income those datavoucvhers are not counted at all nor in in-game "statistic", nor affect controlling faction relation, nor any rank progression - only credit balance).




Also I want to outline for all commanders once again, that while we have events like USSDrop, so far there are no any traces of player's approach/visit to a particular planetary settlement.
The only indirect signs that this kind of visit - maybe - takes place are events like 10.4-10.6 ("DatalinkScan", "DatalinkVoucher" and "DataScanned"), but those events provide zero info about settlement itself (if this really happens in a settlement).
Here, in post #218, I've already explained what I mean by full settlement info. Sa far looks like that my idea with settlement's "proximity zone" has not been approved.
Is there kind of principal "No" about providing this information from the side of official developers? Or this just technically difficult to associate and implement appropriate kind of event trigger?
One of not the best possible solutions can be to attach settlement description to the above mentioned events (10.4,10.5,10.6) as an optional parameter.
As a side note, some other events that can be generated in some settlements - restricted zone trespassing (srv/ship, enter/exit) and "defence systems activated" event (valid for surface POI's also).

As I've said for me absence of any traces of however "global" event as visiting/attacking a settlement looks a bit strange taking into account all other already provided events.
I perfectly understand that to some extent most commanders don't bother about this information (at least up to the moment when they discover that some types of the engineer's upgrades requires microresources efficiently "harvestable" only from some particular layouts of planetary settlements - like "modified embedded firmware", etc)
May be it's better to think about it in advance?
 
Alternatively, if you don't want to add a cargo and material status dump to the Journal, please add materials to the Companion API output.

I would prefer to has it in the journal logs as well (together with ship listing, etc. you mentioned earlier). Otherwise it is just complicated for users on websites and it is just a chaos (they must import journals for some stuff and use EDMC exports for another stuff). If they will forgot to do one thing or the other, it may cause inconsistencies in some cases, too...
 
Last edited:

hchalkley

Senior Programmer
Frontier
Is this folder name localized, or is it what's returned by SHGetKnownFolderPath(FOLDERID_SavedGames) on Windows?
What's the folder path on Mac?

Yes, the path is derived from SHGetKnownFolderPath. I haven't done a Mac build, we'll have that info in time for the Beta.
I think currently on OSX it's querying [[NSFileManager defaultManager] URLsForDirectory:ApplicationSupportDirectory inDomains:NSUserDomainMask]

... Add: "The heading entry is added at the beginning of every file"...

Added.

...Question: why IsPlayer looks like boolean, but is in quotes? "true"

I have fixed this so all the Interdiction/IsPlayer values are correctly boolean.

I have also edited the doc to clean up Word's conversion of the doublequote characters.

We'll release an update when the 2.2 Beta is released.
 
Yes, the path is derived from SHGetKnownFolderPath.
Thanks.

I haven't done a Mac build, we'll have that info in time for the Beta.
I think currently on OSX it's querying [[NSFileManager defaultManager] URLsForDirectory:ApplicationSupportDirectory inDomains:NSUserDomainMask]
The netLogs are currently stored under ApplicationSupportDirectory. Since NSFileManager (and OSX in general) doesn't have a standard "SavedGames" folder, ApplicationSupportDirectory is probably as good a place as any for the Journal too.
 

hchalkley

Senior Programmer
Frontier
... so far there are no any traces of player's approach/visit to a particular planetary settlement...
I'll add an "ApproachSettlement" event that gives the Name of the settlement, but the game designers have asked that I do not include anything else (such as settlement type) because spoilers.
 

Robert Maynard

Volunteer Moderator
I'll add an "ApproachSettlement" event that gives the Name of the settlement, but the game designers have asked that I do not include anything else (such as settlement type) because spoilers.

:D Nice!

Is there any plan to offer ship equipment state information - to allow MFD equivalents to be made possible?
 
The latest version of the manual has been uploaded to the fileserver:

http://hosting.zaonce.net/community/journal/v3/Journal_Manual.doc

Quite a few of your suggestions over the last few weeks have been implemented (and I'm currently adding some more detail for passenger missions)

Awesome; thank you so much for your hard work on this. Consequently this will really raise the bar for companion apps.

The latest version of the manual has been uploaded to the fileserver:
change log:
...
• Change some bool values from 1/0 to true/false
o Scan/TidalLock,Landable
...

This is still shown in the Doc as "TidalLock: 1 if tidally locked" - typo?
 
Back
Top Bottom