allejo/bzflag-networking.php

A PHP library for reading and unpacking BZFlag network packets

hello, I'm a senior frontend engineer currently working in Higher Ed at UC Merced

previously, i was a Stack Overflow engineer leading accessibility and frontend refactoring efforts, both of which were not a financial priority for the company since my efforts died with my being laid off

i try to maintain a number of open sources but my time is limited nowadays,

• BZFlag core developer
• highlight.js core team
• highlight.php maintainer
• creator of jekyll-toc and jekyll-anchor-headings
• creator of stakx, a PHP static site generator
• developer for WordPress' Syntax-highlighting Code Block (with Server-side Rendering) plugin
• vfsStream co-maintainer
• bottomline (PHP's lodash equivalent) co-maintainer

bzflag-networking.php's Issues

Inconsistency in method name to get player ID

If we have a packet of type MsgAddPlayer, the method to get the player ID is called getPlayerIndex(). While the same method is called getPlayerId() if the packet is of type MsgRemovePlayer or MsgPlayerUpdate

Move rrlog into separate project

Let's move this implementation of rrlog into a separate project and make it a full-blown tool for reading replay files.

Add support for yielding replay packets

Right now, this library reads all of the packets and stores them in memory. For larger replay files, this can become problematic since we'll run into out-of-memory issues.

We need a way to be able to yield packets one at a time since we don't really need the full replay as an object.

MsgPlayerUpdate player state incorrect with original rrlog

With rrlog, we extract the following packet information.

2019/01/01 00:00:00 (408 ms): MsgPlayerUpdateSmall
  player: allejo [0]
    state: 0x0001  order: 1583
      pos:    ( -78.840,  -22.800,   30.000)
      vel:    ( -14.990,    0.020,    0.000)
      angle:  -0.005   =   -0.264 deg
      angvel: -0.785   =  -44.977 deg/sec

However, with our unpacking the same packet is expanded to the following JSON:

{
  "playerId": 0,
  "state": {
      "position": [
          -517.44,
          -588.9000000000001,
          -184.22000000000003
      ],
      "velocity": [
          97.22,
          5.12,
          0
      ],
      "azimuth": -1.1537198437601777,
      "angularVelocity": -4.1000000000000005,
      "physicsDriver": null,
      "userSpeed": null,
      "userAng_Vel": null,
      "jumpJetsScale": null,
      "sounds": null
  },
  "packetType": "MsgPlayerUpdate",
  "timestamp": "2019-01-01T00:00:00+00:00"
},