search

SpongePowered / SpongeDocs

Documentation for Sponge and its Implementations
Creative Commons Attribution Share Alike 4.0 International
110 stars 116 forks source link

Network channel API docs wanted #290

Open Inscrutable opened 9 years ago

Inscrutable commented 9 years ago

I believe this is the most relevant SpongeAPI PR: https://github.com/SpongePowered/SpongeAPI/pull/363

simon816 commented 8 years ago

Relevant commit https://github.com/SpongePowered/SpongeAPI/commit/59941a6f05f6f4689b772d6c6637ef82998d4fc7 -- network message API and several more network API changes

gabizou commented 8 years ago

@simon816 I've found it often helpful that giving the doc guys a brain dump of how something works generally helps them get a leg over the hurdle to writing docs (I've done that a lot with data to get the docs to where they are, for data that is).

Tzky commented 8 years ago

And it worked out great! It helps a lot when a Dev braindumps his general idea of the API. This gets us in the position to actually write something up, which then can get improved further.

This saves you (the devs) most of the work you'd waste on writing it up beautifully and us (the docs guys) the time we'd waste understanding what you've done on the API.

simon816 commented 8 years ago

For the most-part Sponge's API is very similar to Forge's API. The forge documentation for networking is here: http://mcforge.readthedocs.org/en/latest/networking/simpleimpl/ If I have time and the docs people need more Sponge-specific information I can write more about it