GreepTheSheep / openplanet-MXRandom

An Openplanet plugin that takes a random map from MX / TMX and play it
https://openplanet.dev/plugin/mxrandom
GNU General Public License v3.0
19 stars 28 forks source link

Add ability to proxy trackmania api to another url #86

Closed dwhitacre closed 1 year ago

dwhitacre commented 1 year ago

This will make it possible to run tests against a local simulator/mock for the MX api, but additionally make it so users of the plugin can stand up their own proxy api server to serve preloaded and cached api response data from the MX api. This will allow users to be not as dependent on the uptime and reliability of the MX api when doing RMC/S runs.

I debated putting this under the search settings, but since those seemed to be opting into a custom ruleset that additionally invalidates being on the official leaderboard, this didnt really seem like a great fit. Ofc, allowing ANY proxies to be included here, does mean someone could circumvent "randomness" by mocking responses for maps they are already familiar with OR find easier looking maps to essentially cheat official leaderboards... so maybe it makes sense to be in that section ultimately. If it makes it easier to move it under that section to get this merged, I can happily do that for now.

It would be nice if you could use this feature and not be opted out of official leaderboards, but I think then you'd need to vet some "allowed" proxy services that prove to be inline with the official rules of the leaderboard.

Really just opening this to start the discussion, as ultimately testing the plugin entirely is sort of out of my wheelhouse (I don't see any automated tests and I am not intimately familiar with all provided functionality of the plugin or even openplanet plugin development for that matter).

dwhitacre commented 1 year ago

One note, I didn't bother proxying any urls that go to support pages or open browser urls for MX. Since ultimately, those dont need to be rerouted for this particular use case. In particular the urls in RecentlyMapsList.as and About.as.

dwhitacre commented 1 year ago

@GreepTheSheep ive updated the pr. ptal. also, I will be out of town away from my computer till the 18th for any follow up reviews.