OSFR Launcher

A launcher for the Open-Source FreeRealms Project

Install Instructions

• Download OSFRLauncher-win32-x64.zip from the latest release

• Extract OSFRLauncher-win32-x64.zip

• Open the extracted OSFRLauncher-win32-x64 folder and run OSFRLauncher.exe

Usage Instructions

• Once OSFRLauncher.exe is opened. Click Install - This step can take a while depending on your setup
• Click Start Server to start a local server - This is also required to play locally
• Enter your nickname in the Username input field
• Enter the server ip or domain in the Server input field - This is only required if connecting externally and is not required for playing locally
• Click Play to jump into Free Realms!
• Select the Cog Wheel at the bottom left to change your character's customization options.

Compiling Instructions

• Download the latest version of NodeJS
• Open Command Prompt and navigate to the project folder
• type npm i electron and hit enter
• then type npx electron-packager . OSFRLauncher --overwrite --icon=src\www\img\icon.ico

Credit

The original design and code were made by Lillious