RobCoIndustries / pipboylib

:thumbsup: Companion pip boy library for Fallout 4
Apache License 2.0
128 stars 10 forks source link

Update Docs #46

Open luckydonald opened 8 years ago

luckydonald commented 8 years ago

The communication should be almost completely known by now.

luckydonald commented 8 years ago

Schema of DataUpdate content: fallout4

From gist.github.com/luckydonald/d128fe05acdfff76d8be

rgbkrk commented 8 years ago

slick diagram!

rgbkrk commented 8 years ago

Big fan of including that in our docs

kitten commented 8 years ago

nice! :+1:

luckydonald commented 8 years ago

How should we include it? add the .png to the repo? (also I have .pdf and .key [apple keynote presentation file])

rgbkrk commented 8 years ago

I'd use the PNG URL from this GitHub issue, referenced within a Markdown document in /docs.

luckydonald commented 8 years ago

the Png is part of the documentation, also GitHub can go down, so I'd like a static png in git. Can I link that in Markdown?

Currently trying to implement a server (aka the game part) in Java, to have a minecraft plugin displaying stuff.

Because using the companion app in completely different games is just pure swag.

rgbkrk commented 8 years ago

It's fine if you upload it to imgur. Alternatively, we can stick it in git if we make a separate repo for the protocol docs.

luckydonald commented 8 years ago

I'll just leave this here: my take on PROTOCOL.md (version at time of writing)