Are there any api/protocol documents?

[lin-calvin]

I would lile to develop a android client for xpra but there are seems no protocol documents

[totaam]

There used to be a couple of documentation pages about the network protocol and packet format on the old wiki.
I didn't convert them when moving to github because they were already out of date.
I do have plans to modify the code to be self-documenting. In particular, the switch to the new packet format (#1942) should help.

In the meantime, the crucial bits are quite simple:

• make a socket connection
• format all your packets with this header format:

  xpra/xpra/net/protocol/header.py

  Lines 38 to 42 in 56cfbee

  	#'P' + protocol-flags + compression_level + packet_index + data_size
  	_header_pack_struct = struct.Struct(b'!BBBBL')
  	assert ord("P") == 80
  	def pack_header(proto_flags:int, level:int, index:int, payload_size:int) -> bytes:
  	return _header_pack_struct.pack(80, proto_flags, level, index, payload_size)

• send a rencodeplus packet containing ("hello", capabilities) where capabilities is just a dictionary
• you will receive a hello packet back using the same format
• handle new packets as they come - ie new-window, etc.

There used to be an Android client, but it never really worked well.

[totaam]

There is now a work in progress: #3981
The subsystems documentation is a good start:
https://github.com/Xpra-org/xpra/tree/master/docs/Subsystems