documentation

This commit is contained in:
lightbulblighter 2022-08-12 02:14:59 -07:00
parent 01c9fc53e4
commit 5dacb11496
No known key found for this signature in database
GPG Key ID: 58D6EDC2C38C9B3B
1 changed files with 13 additions and 7 deletions

View File

@ -1,21 +1,20 @@
# Tadah.DLL
DLL used for extending game client/server functionality
Based off [ndoesstuff/JoinScriptUrlImpl](https://github.com/ndoesstuff/JoinScriptUrlImpl) as per the MIT license
Fork of [ProjectPolygon/PolygonDLL](https://github.com/ProjectPolygon/PolygonDLL), which is based off of [ndoesstuff/JoinScriptUrlImpl](https://github.com/ndoesstuff/JoinScriptUrlImpl) as per the MIT license
Test trust check:
1. Insert a new brick with decal
2. Try setting decal ID to http://tadah.rocks - Should succeed
3. Try setting decal ID to http://tadah.rocks@example.com - Should fail
2. Try setting decal ID to `http://tadah.rocks` - Should succeed
3. Try setting decal ID to `http://tadah.rocks@example.com` - Should fail
Test extended signature check:
- Run `loadfile("rbxasset://signatureinvalid.txt")()` - Should throw an exception
- Run `loadfile("rbxasset://signatureoverflow.txt")()` - Should throw an exception
- Run `loadfile("https://tadah.rocks/test/sha256succ")()` - Should succeed (if compiled with the Tadah public key)
- Run `loadfile("rbxasset://invalid-signature.txt")()` - Should throw an exception
- Run `loadfile("rbxasset://overflow-signature.txt")()` - Should throw an exception
- Run `loadfile("https://polygon.pizzaboxer.xyz/Game/Visit.ashx")()` - Should succeed (if compiled with the Project Polygon public key)
Test command line parameter reimplementation:
- `> RobloxApp.exe -a http://polygondev.pizzaboxer.xyz/login/negotiate.ashx -t 0 -j http://polygondev.pizzaboxer.xyz/game/visit.ashx`
- `> RobloxApp.exe -a http://polygondev.pizzaboxer.xyz/Login/Negotiate.ashx -t 0 -j http://polygondev.pizzaboxer.xyz/Game/Visit.ashx`
Test asset redirection:
- Run `game:Load("https://www.roblox.com/Asset?id=1818&version=1")` - Should succeed
@ -23,6 +22,13 @@ Test asset redirection:
2. Try setting decal ID to `https://www.roblox.com/Thumbs/Asset.ashx?id=1818&x=768&y=432` - Should succeed
3. Try setting decal ID to `https://www.roblox.com/Thumbs/Avatar.ashx?id=1&x=768&y=432` - Should succeed
## CI/CD
Tadah.DLL is available on the Tadah CI. All builds are compiled as release, and a build occurs per push.
- [player-win-x86](https://ci.tadah.sipr/buildConfiguration/Tadah_DLL_PlayerWinX86)
- [studio-win-x86](https://ci.tadah.sipr/buildConfiguration/Tadah_DLL_StudioWinX86)
- [server-win-x86](https://ci.tadah.sipr/buildConfiguration/Tadah_DLL_ServerWinX86)
## Build
Tadah.DLL requires [vcpkg](https://github.com/microsoft/vcpkg) to manage package installation such with libcurl, detours, and rapidjson. Here's a quick way to install vcpkg;