MrAntares / roBrowserLegacy

This is a continuation of the original robrowser. All credits to the original creators and the new ones :)
GNU General Public License v3.0
184 stars 118 forks source link

ROBrowser Legacy

This is a continuation of roBrowser expanded with some features. This repo is not directly forked from the original repository due to safety concerns, but it is roBrowser.

If you wish to discuss anything related to this project, or you want to join, contact us on Discord: https://discord.gg/8JdHwM4Kqm

For info on how to setup the client read the contents of our Getting Started doc. For the original branche's docs please visit the https://www.robrowser.com/ site.

All credits to the original owners/creators and the new ones.

Guide

Checkout the getting started guide

Remote Client

Remote Client serves game assets to roBrowser via http by extracting them from their GRFs. You will need to setup a remote client if you want to serve the game assets centrally from your server. roBrowser can use local game assets via the Intro screen by dragging them into the file box. The original implementation of the Remote Client is written in PHP and can be found in the roBrowserLegacy-RemoteClient-PHP repository. Other implementations may arise and when they do we will list them here.

WebSocket Proxy

The game server uses TCP/IP to communicate with the client, while roBrowser being a web page can't use TCP/IP. We use the WebSocket API to communicate with a proxy server that translates the packets into TCP/IP packets. This server is called wsProxy. You will need to install and configure wsProxy to make roBrowser able to connect to a game server. For more info, please visit the roBrowserLegacy-wsProxy repository.

Plugins

For available plugins and information on how to install them please visit the roBrowserLegacy-plugins repository.

Contributing

roBrowser was started by this awesome team and we continue it. We also manually add content from other forks that didn't made it back to the original branch, huge shoutout to them! If you wish to contribute then check out the documentation or the code itself and submit a pull request!

Contact

Original branch: