Home - HearthSim/kettle-design GitHub Wiki

Welcome to the kettle-design wiki!

The information in this WIKI is outdated!

But the information outlines the initial ideas for the protocol. Check the repository code for schema's and documentation!

Key points

  • JSON is used to limit the use of external library dependencies
    • The protocol will be used across various programming languages
    • JSON is human-readable during transit, which eases error inspection
  • The protocol defines game related payloads + infrastructure management payloads
  • The protocol definition will be compiled as a library for various languages
    • This might include socket handling code
    • This library will handle management + game related payloads
    • Simulator projects could use these libraries as plugin
    • Kettle API must be usable without simulator code adjustments!

Structural layout

Structural layout of components