E2E Test Suite

[emansom]

Description

Currently the verification of correctness for the protocol, game features etc. are done using manual testing using the original client.

This takes lots of time and is prone to human error. As "everything that can go wrong, will go wrong".

Proposed solution

Now that there are several Lingo code executors implemented and the original client source code has been reverse engineered, it becomes feasible to programmatically shim a TCP Xtra and invoke parts of the original client in a test suite.

Effectively creating a 1:1 test suite for Habbo Emulators

Useful links

https://github.com/scummvm/scummvm/tree/v2026.1.0/engines/director/lingo
https://github.com/Quackster/LibreShockwave/tree/master/vm/src/main/java/com/libreshockwave/vm
https://github.com/PaulusParssinen/Shockky/tree/wip/Shockky/Lingo

Benefit

Having such a test suite, would allow LLM algorithms to better understand the expected behavior code should have. Allowing faster iterative development, and less hallucinated code in LLM written/generated server implementations.

Especially with LLMs that support RAGs and tool calling.

[emansom]

Additional useful links

https://wiki.scummvm.org/index.php?title=Director
http://fileformats.archiveteam.org/wiki/Lingo_bytecode

https://nosamu.medium.com/a-tour-of-the-adobe-director-file-format-e375d1e063c0

https://docs.google.com/document/d/18FMRZ0EvR2uF9rKTtvt-TXyIMFIBVg13bUhmV3_iHD0/edit
https://docs.google.com/document/d/1jDBXE4Wv1AEga-o1Wi8xtlNZY4K2fHxW2Xs8RgARrqk/edit

https://github.com/Brian151/OpenShockwave
https://github.com/Earthquake-Project

[emansom]

Useful documents:

Team Earthquake Guide.md
Team Earthquake Guide.pdf
More Director Movie File Unofficial Documentation.md
More Director Movie File Unofficial Documentation.pdf