Various Typing Fixes & Client-Side Render Event (Multiple Client Compatible) #428
Conversation
|
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
|
|
A demonstration of this technique is shown here. 2024-02-26.00-01-49.mp4 |
|
There appears to be an 1.8.8 error. However, that doesn't appear to be my fault; the error says the test did not find the server (404 error). I will attempt to re-run. |
.vscode/settings.json
Outdated
| @@ -0,0 +1,3 @@ | |||
| { | |||
| "print.colourScheme": "GitHub" | |||
examples/bot.js
Outdated
| }) | ||
|
|
||
| bot.once('spawn', () => { | ||
| bot.once('spawn', async () => { |
There was a problem hiding this comment.
That doesn't do anything, please undo
| const fps = Math.ceil((frameCount / ((currentTime - lastTime) / fpsCheck))) | ||
| lastTime = currentTime | ||
| frameCount = 0 | ||
| if (fps != null) socket.emit('renderFPS', { id: socket.id, fps }) |
There was a problem hiding this comment.
Please add to doc + use it in an example to explain what it's good for
There was a problem hiding this comment.
I do not know where I would put this server-sided event (renderFPS) firing into docs as there is no mention of server-sided code in the READMEs.
I included documentation on the bot.viewer event firing, however.
| io.on('connection', (socket) => { | ||
| const getRenderInterval = (fps) => setInterval(() => bot.viewer.emit('onRender', fps), 1000 / fps) | ||
|
|
||
| const updateListener = ({ id, fps }) => { |
There was a problem hiding this comment.
please add a comment explaining the intent of this; it's far from obvious
I fixed some typings for Mineflayer, specifically the bot.viewer object.
I also implemented a system that keeps track of the highest FPS of clients currently connected to the viewer. This is used to provide a "render" event that guarantees at least one firing per frame of the fastest client connected.
I chose to poll the FPS of each client every second. That can be tweaked if performance is an issue.
There is unnoticeable impact to performance, both computationally and memory-wise. (It only stores a mapping of socket ids to a number).
In the event that no clients are connected, the event will not fire and the interval that would be firing said event is cleared.