api.md: clarify get_required_client_version (#334)

2022-03-23 02:22:58 +01:00 · 2022-03-23 02:22:58 +01:00 · 5eccb0ed49
parent f326de2686
commit 5eccb0ed49
1 changed files with 2 additions and 0 deletions
--- a/docs/api.md
+++ b/docs/api.md
@ -408,6 +408,8 @@ In addition the following methods can be implemented
 * `def get_required_client_version(self)`
  can return a tuple of 3 ints to make sure the client is compatible to this
  world (e.g. item IDs) when connecting.
+  Always use `return max((x,y,z), super().get_required_client_version())`
+  to catch updates in the lower layers that break compatibility.

 #### generate_early