SpongeDocs icon indicating copy to clipboard operation
SpongeDocs copied to clipboard

Network channel API docs wanted

Open Inscrutable opened this issue 10 years ago • 4 comments

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

Inscrutable avatar Jul 11 '15 01:07 Inscrutable

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

simon816 avatar Nov 04 '15 10:11 simon816

@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).

gabizou avatar Nov 04 '15 17:11 gabizou

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.

Tzky avatar Nov 04 '15 21:11 Tzky

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

simon816 avatar Nov 17 '15 19:11 simon816