Search Unity

Feedback Please update the documentation

Discussion in 'NetCode for ECS' started by Krooq, Aug 23, 2021.

  1. Krooq

    Krooq

    Joined:
    Jan 30, 2013
    Posts:
    196
    The current version of Netcode is quite capable however it is really lacking in the documentation area.
    It really is just a collection of notes from the devs.
    I've read the manual probably 20 times but still don't quite understand "How to use" netcode.

    As an example:
    The section on "Value Types" is trying to say:
    WARNING!!!
    "Even with a [GhostField] attribute, only primitives and some built in Unity types will be replicated, i.e. (insert list of types). To support replication of user defined types you must blah blah IGhostDefaultOverridesModifier etc."

    This point is so very very important to note and yet its basically a footnote in the docs.
    Note that the codegen doesn't give an error either, it just "doesn't work".

    Similarly I saw mentioned on the forum that runtime added/removed components are not supported by Netcode, which makes sense if you think about it for a bit but really this is a super important piece of information that helps the user understand how Netcode works. It needs a big ol "IMPORTANT" note.

    I know documentation is hard to keep up to date but I hope that some more effort can be put towards updating the docs because honestly they add so much value. Netcode has so much potential but the learning curve is super steep only (I believe) for the lack of time spent on the docs.
     
    bb8_1 and ChrisPie like this.
  2. NikiWalker

    NikiWalker

    Unity Technologies

    Joined:
    May 18, 2021
    Posts:
    316
    Thanks for the feedback krooq! We 100% agree. I joined Unity recently, and one of my priorities is to ensure documentation is fit for purpose. Wish I could be more specific than "we're working on it", but we absolutely are.
     
    Dan-Foster, Occuros, Kmsxkuse and 3 others like this.
  3. Krooq

    Krooq

    Joined:
    Jan 30, 2013
    Posts:
    196
    Thanks Niki. I wish you luck, its not easy to convince senior developers to spend time writing documentation but it makes all the difference!
     
    NikiWalker likes this.