thorium-nova icon indicating copy to clipboard operation
thorium-nova copied to clipboard

Write docs for the current Thorium Nova API

Open alexanderson1993 opened this issue 3 years ago • 0 comments

Is your feature request related to a problem? Please describe. There are no docs for the existing API yet, just examples you can look at in the code.

Describe the solution you'd like Write up some docs in the built-in docs system about the current API for building Thorium Nova.

  • [x] The interplay between the Client, Server, and Electron stuff
  • [ ] How to build cards and cores
  • [x] How useCardData works
  • [x] How useClientData works
  • [x] How to use the Snapshot Interpolation to get rapidly changing data
  • [x] How to use transient updates to keep FPS high
  • [x] How to define inputs
  • [x] How do do file uploads through inputs
  • [x] How to use netSend to send inputs to the server
  • [x] How to define netRequests
  • [x] How to use netRequests
  • [x] ECS Crash Course
  • [x] How to create a new component
  • [x] How to add and remove components from an entity
  • [x] A catalog of the existing components, and their purpose
  • [x] How to create a new system
  • [x] How to use pubsub.publish to send subscription data to the client
  • [ ] How the server is modeled
  • [ ] How flights are modeled
  • [ ] How clients are modeled
  • [ ] Documentation for all of the UI components
  • [ ] How plugins are structured, and how to create new plugin content
  • [ ] Building a plugin aspect config page.

alexanderson1993 avatar Oct 12 '21 23:10 alexanderson1993