rlbot-rust icon indicating copy to clipboard operation
rlbot-rust copied to clipboard
verified publisher icon RLBot

Use FreshLiveDataPacketFlatbuffer instead of UpdateLiveDataPacket.

Open Quetzal2 opened this issue 6 years ago • 5 comments

Use the new FreshLiveDataPacketFlatbuffer from https://github.com/RLBot/RLBot/commit/94076466d3ad25ed589d93d7d3a0d7cd3bb0ab16 (new option: https://github.com/RLBot/RLBot/commit/8086f41ac9f3be568304e5622337eadfe14fa370) instead of UpdateLiveDataPacket.

An update example (Java) can be found here : https://github.com/RLBot/RLBot/commit/5701357231a13cdc182342f16f84e84f336b7ee3

Quetzal2 avatar Oct 07 '19 17:10 Quetzal2

(adding the base dll code. Will wait for the .so to be updated to complete the change.)

dll.rs, ffi.rs, interface.rs, packeteer.rs and files using the function (examples, …):

  • [x] Flatbuffer version
  • [ ] Non-flatbuffer version

Documentation:

  • [ ] Document FreshLiveDataPacketFlatbuffer
  • [ ] Update other documentations accordingly ~~Mark update_live_data_packet as deprecated?~~ (is still usefull in certain cases)

Cleanup: ~~Remove UpdateLiveDataPacket?~~ (still usefull in certain cases and for backwards compatibility reasons)

  • [ ] Bump version (⇒ Update CHANGELOG.md)?
  • [ ] Is there now some useless code to remove (waiting loops that wait for 18ms for example)?

Quetzal2 avatar Oct 07 '19 20:10 Quetzal2

Topics:

  • [ ] src/interface.rs should be asking for an ffi struct (as all the others do), or manage it by themselves (makes way more sense in this case)?
  • [ ] src/interface.rs (if second option) u32 to c_int management.

Quetzal2 avatar Oct 07 '19 20:10 Quetzal2

(adding the base dll code. Will wait for the .so to be updated to complete the change.) dll.rs, ffi.rs, interface.rs, packeteer.rs and files using the function (examples, …):

* [x]  Flatbuffer version
* [ ]  Non-flatbuffer version

ffi.rs is generated by rust-bindgen, so whatever it generates from the updated header. Instructions here.

Documentation:

* [ ]  Document FreshLiveDataPacketFlatbuffer
* [ ]  Update other documentations accordingly
* [ ]  Mark `update_live_data_packet` as deprecated?

Yes, if it's depreciated upstream.

Cleanup:

* [ ]  Remove `UpdateLiveDataPacket`?

Only if it's been removed upstream.

* [ ]  Bump version (⇒ Update CHANGELOG.md)?

Yes.

saintdev avatar Oct 07 '19 23:10 saintdev

Ok. Thanks saintdev! I'll take care of the ffi.rs generation.

Quetzal2 avatar Oct 08 '19 07:10 Quetzal2

Binaries are available! https://github.com/RLBot/RLBot/commit/0e40017ead76f26b08916a10c4dadd27b492b05d

Also deployed to pypi.

tarehart avatar Oct 09 '19 16:10 tarehart