Journal Documentation for v3.0

[hchalkley]

The beta release of Elite Dangerous: Beyond will be available later today,
here's the documentation for the latest version of the player journal:

Edited updated to v18 for v3.0.4:

Doc: http://hosting.zaonce.net/community/...Manual_v18.doc
Pdf: http://hosting.zaonce.net/community/...Manual_v18.pdf

[Cmdr Eagleboy]

Awesome!

Any short notes what's added/changed?

[wstephenson]

1.1 ChangeLogVersion 14 – for v3.0 (25/Jan/2018)

• Commodity names and Material names are now localised
• Added NpcCrewRank and NpcCrewPaidWages events
• Added ShipTargetted event
• Added Commander at startup before other loadgame events
• Added Shutdown event
• Fixed station name in "Docking Denied" event
• Added solid composition data when scanning a planet
• Include community goal ID in events: CommunityGoalJoin, CommunityGoalReward,CommunityGoalDiscard
• Added some info about the name of a community goal's top tier, and the global bonus info (ifavailable)
• Added Reputation event, to provide info on player's rep with superpowers
• Include fines in MissionFailed and MissionAbandoned events, where appropriate
• Add Statistics event at startup
• Include StationType info in DockingRequested, DockingGranted, DockingDenied,DockingCancelled, DockingTimeout
• Include UnderAttack event
• Include SystemAddress 64bit id value in FSDJump, Location, Docked, StartJump, NavBeaconScan
• Add StoredModules, and StoredShips
• Added Missions list at startup
• Added info to Cargo/Inventory to show whether cargo is stolen
• Report results of DiscoveryScan to the journal
• Include ScanType in Scan event
• Add FighterDestroyed and FighterRebuilt events
• Add LaunchDrone event
• Add Shipyard Pricelist, and Outfitting pricelist, Market pricelist, written to separate files
• Include BodyID in Location, SupercruiseExit, Scan, ApproachBody, LeaveBody
• Include MarketID in many events where relevant
• Include ship's HullValue, ModulesValue, and Rebuy price in Loadout event
• Fix an error in the ShipyardNew event description
• Note EngineerApply event is no longer generated
• Added "Quality" and "BlueprintID" properties and "Modifiers" array to EngineerCraft
• Added "EngineerLegacyConvert" event
• Added "EngineerID" property to EngineerContribution, EngineerCraft, EngineerProgress events
• Include Engineering data for modified modules in the Loadout event
• Include list of possible modifiable module attributes in appendix
• Added MaterialTrade and TechnologyBroker events
• Added info on the real-time Status.Json file
• Include TotalEarnings in SellExplorationData
• Added ModuleInfo event
• Note Loadout event after using outfitting
• Note Altitude and Heading in Screenshot event
• Added SystemsShutdown event
• Added SRVDestroyed event
• Added Wanted flag in Docked event

[Robert Maynard]

Many thanks, Howard!

[rootsrat]

Excellent, thank you! Passed to our devs

[dobbo]

Add Shipyard Pricelist, and Outfitting pricelist, Market pricelist, written to separate files

It looks like this will be the end to the old Apple app API.

[Robert Maynard]

Howard,

Reading the specification for the Status File, it seems to be just the thing I was looking for to provide data for the yet-to-be-started programming project I've been putting off to change the state of the images in the middle of the Thrustmaster Cougar MFDs (2x mounted on the front of a 11.6" 16:9 monitor) that I use as game controllers (in addition to KB/M & stick).

With that in mind, would it be possible to add a couple more flags?

27 134,217,728 0800 0000 FSD Charging (HyperJump)
28 268,435,456 1000 0000 HyperJumping (currently shows "Flags":0)
29 536,870,912 2000 0000 Ship Shutdown (by Thargoids)
30 1,073,741,824 4000 0000 Hyperdiction
31 2,147,483,648 8000 0000 Game Client Closed

Nice to haves would be other numeric values:

"Throttle":[throttle setting in range -100 to 100 (%)]
"Speed":[in relevant unit for current space]
"Temperature":[percentage]

.... and a little more precision on heading would be great, recognising that it does not need to change on the HUD and that position data precision already exceeds that of the HUD....

[Becky]

Hi hchalkley,

Thanks for adding in the changes from the bucket list.

if you have time can you add some more things? thanks.

399406-Requested-Journal-Changes

[Becky]

Status.json -- how will this work if you have multiple versions of elite running at the same time?

Can it be renamed to Status-CMDRName.json please

thanks

[Robert Maynard]

Slightly different from "multiple versions of Elite running at the same time" but similar, I flip between four CMDRs periodically (using the same game install - I just log out on the current CMDR and in on another CMDR) and would really like it if the CMDR name was included in the title of the journal log file.

[Becky]

Slightly different from "multiple versions of Elite running at the same time" but similar, I flip between four CMDRs periodically (using the same game install - I just log out on the current CMDR and in on another CMDR) and would really like it if the CMDR name was included in the title of the journal log file.

• Added Commander at startup before other loadgame events

in theory that's what this is - they can't add it to the filename because, in the case of a "clean save" option, they wont know what the commander name is. and thinking about it; they may have the same problem with status.json, depending on when they start writing it; but in theory you should be in the cockpit before they start writing status.json to disk but the journal is started as soon as the client opens.

[LeKeno]

Really looking forward to the ShipTargeted event!
Exactly what I needed for EDR.

[Several]

Great stuff! Thank you!

Any chance we get a journal entry with the Minor Faction influences values and states when opening the system map for a specific system?

[Becky]

• Added Commander at startup before other loadgame events

Please make this when the friends list loads, not when you select what game mode you want.

Thanks.

[dobbo]

Hi Howard,

Many thanks for your work on the Journal, it is very much appreciated.

I've done a little testing with the new live beta, and very much like what you've and your team have done. The status updates contain everything I
was hoping for when you broached the subject in our little discussion at the Expo. I would, however, still council that these be available via a a network
interface as writing this data to an SSD might life the device rather quickly.

However, this post is to point out that there is a little bug/feature of the current implementation that I would like to bring to your attention. I have
raised a bug report, but the format for those doesn't really lend itself to what I getting the information over that I want.

The current implementation where the status update is only written when there is something worth reporting works very well (as I said above) and is
very much better than the heartbeat update cycle we talked over at the Expo (IIRC). However, the status is not being update if there is only a change
to the location. I found it quite easy to maintain a constant heading in the SRV which results in no status updates as I drive for kilometres.

I wouldn't want to see changes with very minor location deltas as this would flood the journal output, and I noted that the altitude does have some kind
of delta limiter. Something similar for the lat and long values would be appropriate. While driving around in an SRV I felt an update on a change to 3
decimal places was about right. In a fighter or ship that should be lower as the ground speed will be higher, and my guess would be some function of
altitude and/or speed would work best.

Hope this helps, and once again many thanks
Steve