Rōblox: Freedom Distribution: Revival-style launcher that allows people to host their own instances of Rōblox for other people to play.

Anonymous | Dec 01, 2025 5:05 PM No.1933

1933

[Report]

Rōblox: Freedom Distribution

Want to host your own Rōblox LAN parties? Looking for a way to deploy your Rōblox experiences, new and old, on your own machine?

https://github.com/user-attachments/assets/483c4263-db43-4ec2-9243-b0b885e625f6

Rōblox Freedom Distribution is one such solution. It's a revival launcher built on existing research for self-hosting Rōblox servers.

Using RFD, users can host their own server instances from compiled Rōblox binaries from 2018-07-25 or 2021-01-25.

Players can join existing servers.

Clients only need to keep track of which hosts and ports to connect to. That's because clients will automatically connect to a server of the same version.

If you worked with Python 3.12+ before, (#download) is supposed to take less than a minute. Why initial? Freedom Distribution automatically downloads additional data (at most 90 MiB) for you.

Initial adaptation from the (https://web.archive.org/web/20241113091646/https://jetray.itch.io/roblox-filtering-disabled) project by Jetray, et al.

All the code is free-as-in-freedom software and is licensed under the GNU GPL v3.

This README is optimised for viewing on (https://github.com/Windows81/Roblox-Freedom-Distribution).

Copyright Acknowledgement

My use of Rōblox's binaries are prone to copyright-infringement issues. Be wary of any potential copyright takedowns.

In the event of a DMCA takedown, don't rely on forks of this repo on GitHub. Consider using other means. Also consult this (https://github.com/Windows81/Roblox-Freedom-Distribution/blob/main/LEGAL.md) if you want to know why I believe I'm protected under fair-use law.

Download

RFD is natively supported on Windows and works on GNU/Linux systems with wine.

As an Executable

This is good for if you want to deploy quickly on any machine with connection to the internet.

For Windows

To download as an executable, run:

mkdir rfd
cd rfd
curl https://github.com/Windows81/Roblox-Freedom-Distribution/releases/latest/download/RFD-windows-latest.exe --output RFD.exe

To launch RFD, your command line will look something like this:

./RFD.exe player -h 127.0.0.1 -p 2005

For GNU/Linux

Still needs work.

RFD requires wine to be installed on your system.

For balance of information, consult (https://github.com/Windows81/Roblox-Freedom-Distribution/blob/main/Guides/Linux/README.MD).

mkdir rfd
cd rfd
curl https://github.com/Windows81/Roblox-Freedom-Distribution/releases/latest/download/RFD-windows-latest.exe --output RFD.exe

To launch RFD, your command line will look something like this:

./RFD.exe player -h 127.0.0.1 -p 2005

From (https://github.com/Windows81/Roblox-Freedom-Distribution/archive/refs/heads/main.zip)

This is good for if you already have Python installed on your machine. Do you want to help contribute to RFD? Use this.

You need Python 3.12+ on your system.

To install from source, run:

git clone --depth 1 https://github.com/Windows81/Roblox-Freedom-Distribution rfd
cd rfd/Source
pip install -r requirements.txt

Wanna use venv? That works too!

To launch RFD, your command line will look something like this:

py _main.py player -h 127.0.0.1 -p 2005

Command Syntax

`server`

Game-specific options are specified in the --config_path argument, which defaults to ./GameConfig.toml.

(#gameconfigtoml-structure)

As of RFD 0.58.2, the available options are as follows:

usage: _main.py server  |
                       --place_path ] 
                       ] ]
                        ] 
                        ]



options:
  --config_path, --config, -cp 
                        Game-specific options; defaults to ./GameConfig.toml.
                        Please review each option before starting a new server
                        up.
  --place_path, --place, -pl 
                        Path to the place file to be loaded. Argument
                        `config_path` can't be passed in when using this
                        option.
  --ipv4-only           Run server using IPv4 only.
  --ipv6-only           Run server using IPv6 only.
  --rcc_port, --port, -rp, -p 
                        Port number for the RCC server to run from.
  --web_port, -wp 
                        Port number for the web server to run from.
  --run_client, -rc, --run_player
                        Runs an instance of the player immediately after
                        starting the server.
  --user_code, -u 
                        If -run_client is passed in, .
  --quiet, -q           Suppresses console output.
  --no_colour, --no_color
                        Suppresses ANSI colour codes.
  --rcc_log_options, --rcc_log, -log 
                        Filter list for which FLog types to print in RCC.
  --skip_rcc            Only runs the webserver, skipping the RCC binary
                        completely.
  --skip_rcc_popen      Runs the webserver and initialises RCC configuration,
                        but doesn't execute `RCCService.exe`.
  --skip_web            Only runs the Studio binary, skipping hosting the
                        webserver.
  --clear_cache         Deletes cached content specific to the host you are
                        connecting to. Searches in the
                        %LocalAppData%\Temp\Roblox\http directory.
  --skip_download       Disables auto-download of RFD binaries from the
                        internet.
  --debug               Opens an instance of x96dbg and attaches it to the
                        running "server" binary.
  --debug_all           Opens instances of x96dbg and attaches them to all
                        running binaries.
  --help, -?            show this help message and exit

`player`

As of RFD 0.58.2, the available options are as follows:

usage: _main.py player ] ]
                       ] ]
                       ]  


options:
  --rcc_host, --host, -rh, -h 
                        Hostname or IP address to connect this program to the
                        RCC server.
  --rcc_port, --port, -rp, -p 
                        Port number to connect this program to the RCC server.
  --web_host, -wh 
                        Hostname or IP address to connect this program to the
                        web server.
  --web_port, -wp 
                        Port number to connect this program to the web server.
  --user_code, -u 
  --quiet, -q           Suppresses console output.
  --clear_cache         Deletes cached content specific to the host you are
                        connecting to. Searches in the
                        %LocalAppData%\Temp\Roblox\http directory.
  --skip_download       Disables auto-download of RFD binaries from the
                        internet.
  --debug               Opens an instance of x96dbg and attaches it to the
                        running "player" binary.
  --debug_all           Opens instances of x96dbg and attaches them to all
                        running binaries.
  --help, -?            show this help message and exit

`studio`

The studio command allows developers to modify existing place files whilst connected to RFD's webserver.

As of RFD 0.62.2, the available options are as follows:

usage: _main.py studio  | --place_path ] ]   


options:
  --config_path, --config, -cp 
                        Game-specific options; defaults to ./GameConfig.toml. Please review each option before starting a new server up.
  --place_path, --place, -pl 
                        Path to the place file to be loaded. Argument `config_path` can't be passed in when using this option.
  --web_port, -wp, -p 
                        Port number for the locally-hosted web server to run from.
  --quiet, -q           Suppresses console output.
  --skip_web            Skips hosting the webserver.
  --skip_studio         Skips opening Studio.
  --clear_cache         Deletes cached content specific to the host you are connecting to. Searches in the %LocalAppData%\Temp\Roblox\http directory.
  --skip_download       Disables auto-download of RFD binaries from the internet.
  --debug               Opens an instance of x96dbg and attaches it to the running "studio" binary.
  --debug_all           Opens instances of x96dbg and attaches them to all running binaries.
  --help, -?            show this help message and exit

`serialise`

The serialise command allows developers to modify files to be compatible with RFD's asset-loading systems.

As of RFD 0.58.2, the available options are as follows:

usage: _main.py serialise ] ]
                          ]


options:
  --load, --read, -r LOAD 
                        Path to the file(s) to be loaded.
  --save, --write, -w SAVE 
                        Path to the file(s) to be saved.
  --method {method.csg,method.rbxl,method.video,method.mesh} 
                        Serialisers to use on the file(s) provided.
  --help, -?            show this help message and exit

`download`

The download command allows you to download specific versions of Rōblox components.

As of RFD 0.58.2, the available options are as follows:

usage: _main.py download 
                         ]


options:
  --rbx_version, -v RBX_VERSION
                        Version to download.
  --bin_subtype, -b {Player,Server,Studio} 
                        Directories to download.
  --help, -?            show this help message and exit

`test`

The test command performs a pre-determined series of unit tests. Useful for debugging RFD's compatibility with modern Rōblox systems over time.

As of RFD 0.61.0, the available options are as follows:

usage: _main.py test  

positional arguments:
  tests_to_run  Unit tests which are run by RFD.

options:
  --help, -?    show this help message and exit

`cookie`

Extracts the ROBLOSECURITY cookie which a running instance of RFD would use to extract assets from Roblox.com.

As of RFD 0.61.0, the available options are as follows:

usage: _main.py cookie  

options:
  --verbose, --show, -v
                        Exposes the entire cookie in plaintext.
  --help, -?            show this help message and exit

Network Ports in Use

To keep it simple: open port 2005 on both TCP and UDP.

Anyone can host a server and must leave both a TCP -wp and UDP -rp network port of their choice accessible.

It's possible to connect to a webserver and an RCC server from different hosts. However, I wouldn't recommend it.

RCC (UDP)

RCC is an acronym for 'Rōblox Cloud Compute', which is the exe program we use to run the Rōblox servers. The UDP-based protocol is derived from (but is incompatible with) (http://www.raknet.com/).

Host is specified by the -h option (also by --rcc_host or -rh).

Port is specified by the -p option (also by --rcc_port or -rp).

Webserver (unsigned HTTPS)

The webserver is responsible for facilitating player connections and loading in-game assets.

Host is optionally specified by the --web_host or -wh option, in case RCC is hosted elsewhere.

Port is specified by the --web_port or -wp option.

Loading Assets from Rōblox

To load assets directly from Roblox.com, our software needs to provide a valid ROBLOSECURITY token. RFD can extract this token through two methods:

If you are on a Windows and play Roblox.com, our RFD will find and decrypt the contents of %LocalAppData%\Roblox\LocalStorage\RobloxCookies.dat and there are no further actions needed to start loading assets.
Otherwise, across all OS types, RFD will extract your ROBLOSECURITY environment variable.

Freedom Distribution will NOT save/upload your token anywhere and will not use It outside roblox assetdelivery services. The cookie handling can be found in the Source "extractor.py" file.

PlaceID Spoofing

There are some uncopylocks that somehow when you enter them the audio works fine but when you enter from outside the official uncopylock the audios are privated this is very rare for it to happen, but in case it happens setup an enviroment value called "rfdplaceid" with the PlaceID you want to spoof.
Tof you are the owner of the place you are loading assets and the account is logged in/set ROBLOSECURITY in enviroment, your privated audios should load fine without spoofing.

Setting Up Enviroment Variables

This short snippet shows you how to setup enviroment variables from the PowerShell for Windows users as those are the most complicated ones to set up, specifically the .ROBLOSECURITY token however remember "If you are on a Windows and play Roblox.com" you can skip setting your ROBLOSECURITY token in the enviroment.
Using the PowerShell is recommended as the cmd will not handle such large strings correctly, you can launch it by pressing the WindowsKey + R and typing "powershell.exe"

To set your .ROBLOSECURITY token up, with 'YOURTOKEN' being replaced by that token:

$env:ROBLOSECURITY = 'YOURTOKEN'

To set place-iden spoofing up, with the 12345 being replaced by your desired place iden:

$env:rfdplaceid = '12345'

SIDENOTE: The way this commands setup enviroment tables will not persist once you close the PowerShell

Local Asset Persistence

Assets are automatically cached server-side in directory ./AssetCache. To manually add assets, place the raw data in a file named with the iden number or string without any extension.

The following are examples of asset idens resolving to cache files:

<table> <thead> <tr> <th>Asset Iden</th> <th>File Name</th> <th>Format</th> </tr> </thead> <tbody> <tr> <td>rbxassetid://1818</td> <td>./00000001818</td> <td>%11d</td> </tr> <tr> <td>rbxassetid://5950704</td> <td>./00005950704</td> <td>%11d</td> </tr> <tr> <td>rbxassetid://97646706196482</td> <td>./97646706196482</td> <td>%11d</td> </tr> <tr> <td>rbxassetid://custom-asset</td> <td>./custom-asset</td> <td>%s</td> </tr> </tbody> </table>

This behaviour can be changed in (#game_setupasset_cachename_template).

How About Studio?

RFD (#studio). However, they are not fully usable as of 2025-10-02. These should be used only if modern Studio doesn't mesh well with your places.

RFD is designed to accommodate current-day rbxl (not rbxlx) files. To accommodate breaking changes to the file format, RFD includes a (./Source/assets/serialisers/) which automatically processes:

Assets remotely loaded from Roblox.com into ./AssetCache, and
rbxl place files as used by RFD servers.

Objects transformed include:

Fonts which existed in their respective versions, and
Meshes encoded with versions 4 or 5 back to version 2 (courtesy (https://github.com/PrintedScript/RBXMesh/blob/main/RBXMesh.py)).

Some modern programs do weird things to client-sided scripts. They use Script classs objects, but with a (https://robloxapi.github.io/ref/class/BaseScript.html#member-RunContext) property set to (https://robloxapi.github.io/ref/enum/RunContext.html#member-Client). You will also need to manually convert these objects to LocalScripts.

And, union operations done in current-day Studio (CSG v3) are not supported. This is because CSG v2 support was completely removed in late 2022.

If you need any help, please shoot me an issue on GitHub or a message to an account with some form of 'VisualPlugin' elsewhere.

Directories Affected

The program is mostly portable; RFD does not store any persistent settings to your machine.

However, the Rōblox player and RCC executables that we hook to will write to the following directories:

%LocalAppData%\Temp\Roblox\http\
%LocalAppData%\Temp\Roblox\

You'll also probably find some registry keys written to:

Computer\HKEY_CURRENT_USER\Software\Roblox

Usage Examples

Where ... is (#download),

Server

... server -p 2005 --config ./GameConfig.toml

For quick prototyping, you can just put it the rbxl place by itself.

... server -p 2005 --place ./Place.rbxl

The (#gameconfigtoml-structure) can also be piped from stdin.

... echo '{ "server_core": { "place_file": { "rbxl_uri": "_.rbxl" } } }' | ... server --config -

Player

... player -h 127.0.0.1 -p 2005

`GameConfig.toml` Structure

This specification is current as of 0.58.2. Some options might be different in future versions.

Optionally, toml files can be expressed in json. The following basic configurations work the same way:

{ "server_core": { "place_file": { "rbxl_uri": "_.rbxl" } } }

server_core.place_file.rbxl_uri = '_.rbxl'


rbxl_uri = '_.rbxl'

Special Types

Functions

Function-type options are very flexible in RFD. Way too flexible if you're asking me.

Look out for {OPTION}_call_mode, where {OPTION} is the name of the option you're modifying. If {OPTION}_call_mode is not specified, RFD tries to assume on its own.

Following is a hypothetical option called skibidi_plugin. The examples all do the same thing.

Python Mode

skibidi_plugin_call_mode = "python"
skibidi_plugin = '''
def f(int_val: int, bool_val: bool):
    if int_val == 666:
        return {
            "evil": 666,
        }
    elif bool_val == True:
        return {
            "owo": 7,
        }
    elif int_val == 420 and bool_val == False:
        return {
            "uwu": 3,
        }
    return {
        "camera_man": 1,
        "ohio": 2,
    }
'''

Nobody cares what name you give the function. RFD should be smart enough to figure out what you're using.

In Python mode, RFD assigns global constants for your convenience.

<table> <thead> <tr> <th>Variable</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>CONFIG_DIR</td> <td>the config file's directory path</td> </tr> </tbody> </table>

Dict Mode

skibidi_plugin_call_mode = "dict"
skibidi_plugin.666 = {
    "evil": 666,
}
skibidi_plugin.True = {
    "owo": 7,
}
skibidi_plugin.420-False = {
    "uwu": 3,
}
skibidi_plugin.default = {
    "camera_man": 1,
    "ohio": 2,
}

Dict keys are access in the following order of precedence:

Each of the individual stringified arguments in positional order,
The joined string of all arguments with string separators _, ,, then ,,
Then the static key default.

Lua Mode (unstable)

skibidi_plugin_call_mode = "lua"
skibidi_plugin = '''
function(int_val, bool_val)
    if int_val == 666 then
        return {
            evil = 666,
        }
    elseif bool_val == true then
        return {
            owo = 7,
        }
    elseif int_val == 420 and bool_val == false then
        return {
            uwu = 3,
        }
    end
    return {
        camera_man = 1,
        ohio = 2,
    }
end
'''

Options

`metadata.config_version_wildcard`

Resolves to a wildcard; defaults to "*".

Matches against the GIT_RELEASE_VERSION internal constant. Useful for protecting changes in config structure between RFD versions.

`server_core.startup_script`

Resolves to type str.

Runs at the CoreScript security level whenever a new server is started.

startup_script = 'game.workspace.FilteringEnabled = false'

`server_core.metadata.title`

Resolves to type str.

Shows up on the loading screen when a player joins the server.

`server_core.metadata.description`

Resolves to type str.

Shows up on the loading screen when a player joins the server.

`server_core.metadata.creator_name`

Resolves to type str.

Shows up on the loading screen when a player joins the server.

`server_core.metadata.icon_uri`

Resolves to internal type uri_obj.

Can resolve to either a relative or absolute local path -- or extracted from a remote URL.

`server_core.place_file.rbxl_uri`

Resolves to internal type uri_obj. Files must be encoded in the binary rbxl format and not in the human-readable rbxlx format.

Can resolve to either a relative or absolute local path -- or extracted from a remote URL.

rbxl_uri = 'c:\Users\USERNAME\Documents\Baseplate.rbxl'

rbxl_uri = 'https://archive.org/download/robloxBR1/RBR1/RBR1.rbxl'

`server_core.place_file.enable_saveplace`

Resolves to type bool; defaults to false.

When game:SavePlace() is called and enable_saveplace is true, the file at (#game_setupplace_filerbxl_uri) is overwritten. It won't work if rbxl_uri points to a remote resource.

`server_core.place_file.track_file_changes`

Resolves to type bool; defaults to false.

When the file at rbxl_uri is modified, RCC is restarted such that RFD always runs the latest version of the file. It won't work if rbxl_uri points to a remote resource.

`game_setup.roblox_version`

The following are valid version strings.

All entries on the same column are aliases for the same version.

`game_setup.asset_cache.dir_path`

Resolves to type path_str. Relative paths are traced from the directory where the config file is placed.

`game_setup.asset_cache.clear_on_start`

Resolves to type bool; defaults to false.

If true, deletes cache from assets which should redirect so that the config file remains correct.

`game_setup.asset_cache.name_template`

Resolves to (#functions) type (int | str) -> str.

With the asset iden passed in (a string or integer), returns the name of the asset file that is stored in (#asset-packs).

Default naming convention is %11d for integers or %s for strings.

`game_setup.persistence.clear_on_start`

Resolves to type bool; defaults to false.

If true, clears (#game_setuppersistencesqlite_path) before starting a new server.

`game_setup.persistence.sqlite_path`

Resolves to type path_str. Relative paths are traced from the directory where the config file is placed.

`server_core.chat_style`

Corresponds to Rōblox (https://create.roblox.com/docs/reference/engine/enums/ChatStyle). Can either be "Classic", "Bubble", or "ClassicAndBubble".

`server_core.retrieve_default_user_code`

Resolves to (#functions) type (float) -> str.

If the client doesn't include a (#player) whilst connecting to the server, this function is called. Should be a randomly-generated value.

retrieve_default_user_code_call_mode = "lua"
retrieve_default_user_code = '''
function(tick) -- float -> str
    return string.format('Player%d', tick)
end

`server_core.check_user_allowed`

Resolves to (#functions) type (int, str) -> bool.

Expect this function to be called multiple times for a single user.

check_user_allowed_call_mode = "lua"
check_user_allowed = '''
function(user_id_num, user_code) -- string -> bool
    return true
end
'''

`server_core.check_user_has_admin`

Resolves to (#functions) type (int, str) -> bool.

check_user_has_admin_call_mode = "lua"
check_user_has_admin = '''
function(user_id_num, user_code) -- string -> bool
    return true
end
'''

`server_core.retrieve_username`

Resolves to (#functions) type (int, str) -> str.

Only gets called the first time a new user joins. Otherwise, RFD checks for a cached value in (#game_setuppersistencesqlite_path).

retrieve_username_call_mode = "lua"
retrieve_username = '''
function(user_id_num, user_code)
    return user_code
end
'''

`server_core.retrieve_user_id`

Resolves to (#functions) type (str) -> int.

Only gets called the first time a new user joins. Otherwise, RFD checks for a cached value in (#game_setuppersistencesqlite_path).

retrieve_user_id_call_mode = "lua"
retrieve_user_id = '''
function(user_code)
    return math.random(1, 16777216)
end
'''

`server_core.retrieve_avatar`

Resolves to (#functions) type (int, str) -> util.types.structs.avatar.

This function replaces the following options from versions 0.59.X and earlier:

retrieve_avatar_type,
retrieve_avatar_items,
retrieve_avatar_scales, and
retrieve_avatar_colors.

retrieve_avatar_call_mode = "lua"
retrieve_avatar = '''
function(user_id_num, user_code)
    return {
        type = 'R15',
        items = {
            10726856854,
            9482991343,
            9481782649,
            9120251003,
            4381817635,
            6969309778,
            5731052645,
            2846257298,
            121390054,
            261826995,
            154386348,
            201733574,
            48474294,
            6340101,
            192483960,
            190245296,
            183808364,
            34247191,
        },
        scales = {
            height = 1,
            width = 0.8,
            head = 1,
            depth = 0.8,
            proportion = 0,
            body_type = 0,
        },
        colors = {
            head = 315,
            left_arm = 315,
            left_leg = 315,
            right_arm = 315,
            right_leg = 315,
            torso = 315,
        },
    }
end
'''

`server_core.retrieve_groups`

Resolves to (#functions) type (int, str) -> dict.

Key is the group iden number written as a string; value is the rank value from 0 to 255.

retrieve_groups_call_mode = "lua"
retrieve_groups = '''
function(user_id_num, user_code)
    return {
         = 255;
         = 255;
         = 255;
         = 255;
         = 255;
         = 255;
         = 255;
    }
end
'''

`server_core.retrieve_account_age`

Resolves to (#functions) type (int, str) -> int.

retrieve_account_age_call_mode = "lua"
retrieve_account_age = '''
function(user_id_num, user_code) -- str -> int
    return 6969
end
'''

`server_core.retrieve_default_funds`

Resolves to (#functions) type (int, str) -> int.

Established the amount of funds that a player receives when they join a server for the first time. These funds can only be spent on (#remote_datagamepasses).

retrieve_default_funds_call_mode = "lua"
retrieve_default_funds = '''
function(user_id_num, user_code)
    return 6969
end
'''

`server_core.filter_text`

Resolves to (#functions) type (str, int, str) -> str.

filter_text_call_mode = "lua"
filter_text = '''
function(text, user_id_num, user_code)
    return text:gsub('oo','òó'):gsub('OO','ÒÓ'):gsub('ee','èé'):gsub('EE','ÈÉ'):gsub('Roblox','Rōblox'):gsub('ROBLOX','RŌBLOX')
end
'''

`remote_data.gamepasses`

Resolves to a data dictionary.

]
id_num = 163231044
name = 'EnforcersPowers'
price = 100


name = 'EnforcersPowers'
price = 100

`remote_data.asset_redirects`

Resolves to (#functions) type (int | str) -> asset_redirect.

When an RFD server receives a request to load an asset by id, it does so from Roblox.com by default.

However, entries in (#remote_dataasset_redirects) override that default.

The following examples notate the structure into the (#dict-mode) syntax:

Through the forward_url field, clients are automatically redirected to a new URL to load any assets.

Asset redirects with this scheme are not saved to ./AssetCache.

 # asset iden 13
forward_url = 'https://archive.org/download/youtube-WmNfDXTnKMw/WmNfDXTnKMw.webm'

You can include a cmd_line field if you want the loaded asset to literally come from the stdout of a program installed on the server.

Asset redirects with this scheme are saved to ./AssetCache.

 # asset iden 14
cmd_line = 'curl https://archive.org/download/youtube-WmNfDXTnKMw/WmNfDXTnKMw.webm -L --output -'

A raw_data field works here too. That literally encapsuates the binary data that will be sent as an asset.

Asset redirects with this scheme are saved to ./AssetCache.


raw_data = '\0'

This script (in (#python-mode)) should work. It redirects asset iden strings starting wtih time_music_ to static files on the internet.

remote_data.asset_redirects = "python"
remote_data.asset_redirects = '''
def f(asset_iden):
    PREFIX = "time_music_"
    if asset_iden.startswith(PREFIX):
        h = int(asset_iden)
        return {
            "forward_url": "https://github.com/Windows81/Time-Is-Musical/blob/main/hour_%02d.wav" % (h % 24)
        }
    return None
'''

`remote_data.badges`

Resolves to a data dictionary.

]
id_num = 757
name = 'Awardable Badge'
price = 1


name = 'Awardable Badge'
price = 1

https://github.com/Windows81/Roblox-Freedom-Distribution/tree/main

Post a Reply

>>1933
<h1 align="center"><img src=https://github.com/Windows81/Roblox-Freedom-Distribution/raw/main/Assets/Logo.png" height="20px"/> Rōblox: Freedom Distribution <img src="https://github.com/Windows81/Roblox-Freedom-Distribution/raw/main/Assets/Logo.png" height="20px"/></h1>

_Want to host your own Rōblox LAN parties? Looking for a way to deploy your Rōblox experiences, new and old, on your own machine?_

[video]https://github.com/user-attachments/assets/483c4263-db43-4ec2-9243-b0b885e625f6[/video]

Rōblox Freedom Distribution is one such solution. It's a revival launcher built on existing research for self-hosting Rōblox servers.

Using RFD, users can host their own server instances from compiled Rōblox binaries from 2018-07-25 or 2021-01-25.

Players can join existing servers.

Clients only need to keep track of which hosts and ports to connect to. That's because _clients will automatically connect to a server of the same version_.

**If you worked with Python 3.12+ before, [_initial_ setup](#download) is supposed to take less than a minute. Why _initial_? Freedom Distribution automatically downloads additional data (at most 90 MiB) for you.**

Initial adaptation from the [Rōblox Filtering Disabled](https://web.archive.org/web/20241113091646/https://jetray.itch.io/roblox-filtering-disabled) project by Jetray, et al.

All the code is free-as-in-freedom software and is licensed under the GNU GPL v3.

_This README is optimised for viewing on [GitHub](https://github.com/Windows81/Roblox-Freedom-Distribution)._

## Copyright Acknowledgement

My use of Rōblox's binaries are prone to copyright-infringement issues. Be wary of any potential copyright takedowns.

In the event of a DMCA takedown, don't rely on forks of this repo on GitHub. Consider using other means. Also consult this [document](https://github.com/Windows81/Roblox-Freedom-Distribution/blob/main/LEGAL.md) if you want to know why I believe I'm protected under fair-use law.

## Download

RFD is natively supported on Windows and works on GNU/Linux systems with `wine`.

### As an Executable

This is good for if you want to deploy quickly on any machine with connection to the internet.

#### For Windows

To download _as an executable_, run:

```
mkdir rfd
cd rfd
curl https://github.com/Windows81/Roblox-Freedom-Distribution/releases/latest/download/RFD-windows-latest.exe --output RFD.exe
```

To launch RFD, your command line will look something like this:

```
./RFD.exe player -h 127.0.0.1 -p 2005
```

#### For GNU/Linux

Still needs work.

RFD requires `wine` to be installed on your system.

For balance of information, consult [this guide](https://github.com/Windows81/Roblox-Freedom-Distribution/blob/main/Guides/Linux/README.MD).

```
mkdir rfd
cd rfd
curl https://github.com/Windows81/Roblox-Freedom-Distribution/releases/latest/download/RFD-windows-latest.exe --output RFD.exe
```

To launch RFD, your command line will look something like this:

```
./RFD.exe player -h 127.0.0.1 -p 2005
```

### From [Source](https://github.com/Windows81/Roblox-Freedom-Distribution/archive/refs/heads/main.zip)

This is good for if you already have Python installed on your machine. Do you want to help contribute to RFD? Use this.

**You need Python 3.12+ on your system.**

To install _from source_, run:

```
git clone --depth 1 https://github.com/Windows81/Roblox-Freedom-Distribution rfd
cd rfd/Source
pip install -r requirements.txt
```

Wanna use _venv_? That works too!

To launch RFD, your command line will look something like this:

```
py _main.py player -h 127.0.0.1 -p 2005
```

## Command Syntax

### `server`

Game-specific options are specified in the `--config_path` argument, which defaults to `./GameConfig.toml`.

[**Please review each option in the config file before starting your server up.**](#gameconfigtoml-structure)

As of RFD 0.58.2, the available options are as follows:

```
usage: _main.py server [--config_path [CONFIG_PATH] |
                       --place_path [PLACE_PATH]] [--ipv4-only | --ipv6-only]
                       [--rcc_port [RCC_PORT]] [--web_port [WEB_PORT]]
                       [--run_client] [--user_code [USER_CODE]] [--quiet]
                       [--no_colour] [--rcc_log_options [FLog ...]]
                       [--skip_rcc | --skip_rcc_popen | --skip_web]
                       [--clear_cache] [--skip_download] [--debug |
                       --debug_all] [--help]

options:
  --config_path, --config, -cp [CONFIG_PATH]
                        Game-specific options; defaults to ./GameConfig.toml.
                        Please review each option before starting a new server
                        up.
  --place_path, --place, -pl [PLACE_PATH]
                        Path to the place file to be loaded. Argument
                        `config_path` can't be passed in when using this
                        option.
  --ipv4-only           Run server using IPv4 only.
  --ipv6-only           Run server using IPv6 only.
  --rcc_port, --port, -rp, -p [RCC_PORT]
                        Port number for the RCC server to run from.
  --web_port, -wp [WEB_PORT]
                        Port number for the web server to run from.
  --run_client, -rc, --run_player
                        Runs an instance of the player immediately after
                        starting the server.
  --user_code, -u [USER_CODE]
                        If -run_client is passed in, .
  --quiet, -q           Suppresses console output.
  --no_colour, --no_color
                        Suppresses ANSI colour codes.
  --rcc_log_options, --rcc_log, -log [FLog ...]
                        Filter list for which FLog types to print in RCC.
  --skip_rcc            Only runs the webserver, skipping the RCC binary
                        completely.
  --skip_rcc_popen      Runs the webserver and initialises RCC configuration,
                        but doesn't execute `RCCService.exe`.
  --skip_web            Only runs the Studio binary, skipping hosting the
                        webserver.
  --clear_cache         Deletes cached content specific to the host you are
                        connecting to. Searches in the
                        %LocalAppData%\Temp\Roblox\http directory.
  --skip_download       Disables auto-download of RFD binaries from the
                        internet.
  --debug               Opens an instance of x96dbg and attaches it to the
                        running "server" binary.
  --debug_all           Opens instances of x96dbg and attaches them to all
                        running binaries.
  --help, -?            show this help message and exit

```

### `player`

As of RFD 0.58.2, the available options are as follows:

```
usage: _main.py player [--rcc_host [RCC_HOST]] [--rcc_port [RCC_PORT]]
                       [--web_host [WEB_HOST]] [--web_port [WEB_PORT]]
                       [--user_code [USER_CODE]] [--quiet] [--clear_cache]
                       [--skip_download] [--debug | --debug_all] [--help]

options:
  --rcc_host, --host, -rh, -h [RCC_HOST]
                        Hostname or IP address to connect this program to the
                        RCC server.
  --rcc_port, --port, -rp, -p [RCC_PORT]
                        Port number to connect this program to the RCC server.
  --web_host, -wh [WEB_HOST]
                        Hostname or IP address to connect this program to the
                        web server.
  --web_port, -wp [WEB_PORT]
                        Port number to connect this program to the web server.
  --user_code, -u [USER_CODE]
  --quiet, -q           Suppresses console output.
  --clear_cache         Deletes cached content specific to the host you are
                        connecting to. Searches in the
                        %LocalAppData%\Temp\Roblox\http directory.
  --skip_download       Disables auto-download of RFD binaries from the
                        internet.
  --debug               Opens an instance of x96dbg and attaches it to the
                        running "player" binary.
  --debug_all           Opens instances of x96dbg and attaches them to all
                        running binaries.
  --help, -?            show this help message and exit

```

### `studio`

The `studio` command allows developers to modify existing place files whilst connected to RFD's webserver.

As of RFD 0.62.2, the available options are as follows:

```
usage: _main.py studio [--config_path [CONFIG_PATH] | --place_path [PLACE_PATH]] [--web_port [WEB_PORT]] [--quiet] [--skip_web] [--skip_studio]
                       [--clear_cache] [--skip_download] [--debug | --debug_all] [--help]

### `serialise`

The `serialise` command allows developers to modify files to be compatible with RFD's asset-loading systems.

As of RFD 0.58.2, the available options are as follows:

```
usage: _main.py serialise [--load LOAD [LOAD ...]] [--save SAVE [SAVE ...]]
                          [--method {method.csg,method.rbxl,method.video,method.mesh} [{method.csg,method.rbxl,method.video,method.mesh} ...]]
                          [--help]

options:
  --load, --read, -r LOAD [LOAD ...]
                        Path to the file(s) to be loaded.
  --save, --write, -w SAVE [SAVE ...]
                        Path to the file(s) to be saved.
  --method {method.csg,method.rbxl,method.video,method.mesh} [{method.csg,method.rbxl,method.video,method.mesh} ...]
                        Serialisers to use on the file(s) provided.
  --help, -?            show this help message and exit
```

### `download`

The `download` command allows you to download specific versions of Rōblox components.

As of RFD 0.58.2, the available options are as follows:

```
usage: _main.py download [--rbx_version RBX_VERSION]
                         [--bin_subtype {Player,Server,Studio} [{Player,Server,Studio} ...]]
                         [--help]

options:
  --rbx_version, -v RBX_VERSION
                        Version to download.
  --bin_subtype, -b {Player,Server,Studio} [{Player,Server,Studio} ...]
                        Directories to download.
  --help, -?            show this help message and exit
```

### `test`

The `test` command performs a pre-determined series of unit tests. Useful for debugging RFD's compatibility with modern Rōblox systems over time.

As of RFD 0.61.0, the available options are as follows:

```
usage: _main.py test [--help] [tests_to_run ...]

positional arguments:
  tests_to_run  Unit tests which are run by RFD.

options:
  --help, -?    show this help message and exit
```

### `cookie`

Extracts the `ROBLOSECURITY` cookie which a running instance of RFD would use to extract assets from Roblox.com.

As of RFD 0.61.0, the available options are as follows:

```
usage: _main.py cookie [--verbose] [--help]

options:
  --verbose, --show, -v
                        Exposes the entire cookie in plaintext.
  --help, -?            show this help message and exit
```

## Network Ports in Use

**To keep it simple: open port 2005 on both TCP and UDP.**

Anyone can host a server and must leave _both a TCP `-wp` and UDP `-rp` network port_ of their choice accessible.

It's possible to connect to a webserver and an RCC server from different hosts. However, I wouldn't recommend it.

### RCC (UDP)

RCC is an acronym for 'Rōblox Cloud Compute', which is the `exe` program we use to run the Rōblox servers. The UDP-based protocol is derived from (but is incompatible with) [RakNet](http://www.raknet.com/).

Host is specified by the `-h` option (also by `--rcc_host` or `-rh`).

Port is specified by the `-p` option (also by `--rcc_port` or `-rp`).

### Webserver (_unsigned_ HTTPS)

The webserver is responsible for facilitating player connections and loading in-game assets.

Host is optionally specified by the `--web_host` or `-wh` option, in case RCC is hosted elsewhere.

Port is specified by the `--web_port` or `-wp` option.

### Loading Assets from Rōblox

To load assets directly from Roblox.com, our software needs to provide a valid `ROBLOSECURITY` token. RFD can extract this token through two methods:

1. _If you are on a Windows and play Roblox.com_, our RFD will find and decrypt the contents of `%LocalAppData%\Roblox\LocalStorage\RobloxCookies.dat` and there are no further actions needed to start loading assets.
2. Otherwise, across all OS types, RFD will extract your `ROBLOSECURITY` environment variable.

**Freedom Distribution will NOT save/upload your token anywhere and will not use It outside roblox assetdelivery services.** The cookie handling can be found in the Source "extractor.py" file.

### PlaceID Spoofing

There are some uncopylocks that somehow when you enter them the audio works fine but when you enter from outside the official uncopylock **the audios are privated** this is very rare for it to happen, but in case it happens setup an enviroment value called "rfdplaceid" with the PlaceID you want to spoof.
Tof you are the owner of the place you are loading assets and the account is logged in/set ROBLOSECURITY in enviroment, your privated audios **should** load fine without spoofing.

### Setting Up Enviroment Variables

This short snippet shows you how to setup enviroment variables from the PowerShell for Windows users as those are the most complicated ones to set up, **specifically the `.ROBLOSECURITY` token** however remember "_If you are on a Windows and play Roblox.com_" you can skip setting your ROBLOSECURITY token in the enviroment.
Using the **PowerShell** is recommended as the **cmd** will not handle such large strings correctly, you can launch it by pressing the **WindowsKey + R** and typing "powershell.exe"

To set your `.ROBLOSECURITY` token up, with `'YOURTOKEN'` being replaced by that token:

```ps1
$env:ROBLOSECURITY = 'YOURTOKEN'
```

To set place-iden spoofing up, with the `12345` being replaced by your desired place iden:

```ps1
$env:rfdplaceid = '12345'
```
**SIDENOTE: The way this commands setup enviroment tables will not persist once you close the PowerShell**
### Local Asset Persistence

Assets are automatically cached server-side in directory `./AssetCache`. To manually add assets, place the raw data in a file named with the iden number or string _without_ any extension.

The following are examples of asset idens resolving to cache files:

| Asset Iden                    | File Name          | Format |
| ----------------------------- | ------------------ | ------ |
| `rbxassetid://1818`           | `./00000001818`    | `%11d` |
| `rbxassetid://5950704`        | `./00005950704`    | `%11d` |
| `rbxassetid://97646706196482` | `./97646706196482` | `%11d` |
| `rbxassetid://custom-asset`   | `./custom-asset`   | `%s`   |

This behaviour can be changed in [your game configuration file](#game_setupasset_cachename_template).

## How About Studio?

RFD [comes bundled with Studio builds](#studio). However, they are not fully usable as of 2025-10-02. These should be used only if modern Studio doesn't mesh well with your places.

RFD is designed to accommodate current-day `rbxl` (_not_ `rbxlx`) files. To accommodate breaking changes to the file format, RFD includes a [serialiser suite](./Source/assets/serialisers/) which automatically processes:

1. Assets remotely loaded from Roblox.com into `./AssetCache`, and
1. `rbxl` place files as used by RFD servers.

Objects transformed include:

1. Fonts which existed in their respective versions, and
1. Meshes encoded with versions 4 or 5 _back_ to version 2 (courtesy [rbxmesh](https://github.com/PrintedScript/RBXMesh/blob/main/RBXMesh.py)).

Some modern programs do weird things to client-sided scripts. They use `Script` classs objects, but with a [`RunContext`](https://robloxapi.github.io/ref/class/BaseScript.html#member-RunContext) property set to [`"Client"`](https://robloxapi.github.io/ref/enum/RunContext.html#member-Client). You will also need to _manually_ convert these objects to `LocalScripts`.

And, **union operations done in current-day Studio (CSG v3) are not supported**. This is because CSG v2 support was completely removed in late 2022.

If you need any help, please shoot me an issue on GitHub or a message to an account with some form of 'VisualPlugin' elsewhere.

## Directories Affected

The program is mostly portable; RFD does not store any persistent settings to your machine.

However, the Rōblox player and RCC executables that we hook to will write to the following directories:

- `%LocalAppData%\Temp\Roblox\http\`
- `%LocalAppData%\Temp\Roblox\`

You'll also probably find some registry keys written to:

- `Computer\HKEY_CURRENT_USER\Software\Roblox`

## Usage Examples

Where `...` is [your command-line prefix](#download),

### Server

```shell
... server -p 2005 --config ./GameConfig.toml
```

For quick prototyping, you can just put it the `rbxl` place by itself.

```shell
... server -p 2005 --place ./Place.rbxl
```

The [config data](#gameconfigtoml-structure) can also be piped from `stdin`.

```shell
... echo '{ "server_core": { "place_file": { "rbxl_uri": "_.rbxl" } } }' | ... server --config -
```

### Player

```shell
... player -h 127.0.0.1 -p 2005
```

## `GameConfig.toml` Structure

This specification is current as of 0.58.2. Some options might be different in future versions.

Optionally, `toml` files can be expressed in `json`. The following basic configurations work the same way:

```json
{ "server_core": { "place_file": { "rbxl_uri": "_.rbxl" } } }
```

```toml
server_core.place_file.rbxl_uri = '_.rbxl'
```

```toml
[server_core.place_file]
rbxl_uri = '_.rbxl'
```

### Special Types

#### Functions

Function-type options are very flexible in RFD. _Way_ too flexible if you're asking me.

Look out for `{OPTION}_call_mode`, where `{OPTION}` is the name of the option you're modifying. If `{OPTION}_call_mode` is not specified, RFD tries to assume on its own.

Following is a hypothetical option called `skibidi_plugin`. The examples all do the same thing.

##### Python Mode

```toml
skibidi_plugin_call_mode = "python"
skibidi_plugin = '''
def f(int_val: int, bool_val: bool):
    if int_val == 666:
        return {
            "evil": 666,
        }
    elif bool_val == True:
        return {
            "owo": 7,
        }
    elif int_val == 420 and bool_val == False:
        return {
            "uwu": 3,
        }
    return {
        "camera_man": 1,
        "ohio": 2,
    }
'''
```

Nobody cares what name you give the function. RFD should be smart enough to figure out what you're using.

In Python mode, RFD assigns global constants for your convenience.

| Variable     | Description                      |
| ------------ | -------------------------------- |
| `CONFIG_DIR` | the config file's directory path |

##### Dict Mode

```toml
skibidi_plugin_call_mode = "dict"
skibidi_plugin.666 = {
    "evil": 666,
}
skibidi_plugin.True = {
    "owo": 7,
}
skibidi_plugin.420-False = {
    "uwu": 3,
}
skibidi_plugin.default = {
    "camera_man": 1,
    "ohio": 2,
}
```

Dict keys are access in the following order of precedence:

1. Each of the individual stringified arguments in positional order,
1. The joined string of all arguments with string separators `_`, `,`, then `, `,
1. Then the static key `default`.

##### Lua Mode (unstable)

```toml
skibidi_plugin_call_mode = "lua"
skibidi_plugin = '''
function(int_val, bool_val)
    if int_val == 666 then
        return {
            evil = 666,
        }
    elseif bool_val == true then
        return {
            owo = 7,
        }
    elseif int_val == 420 and bool_val == false then
        return {
            uwu = 3,
        }
    end
    return {
        camera_man = 1,
        ohio = 2,
    }
end
'''
```

### Options

#### `metadata.config_version_wildcard`

Resolves to a wildcard; defaults to `"*"`.

Matches against the `GIT_RELEASE_VERSION` internal constant. Useful for protecting changes in config structure between RFD versions.

#### `server_core.startup_script`

Resolves to type `str`.

Runs at the CoreScript security level whenever a new _server_ is started.

```toml
startup_script = 'game.workspace.FilteringEnabled = false'
```

#### `server_core.metadata.title`

Resolves to type `str`.

Shows up on the loading screen when a player joins the server.

#### `server_core.metadata.description`

Resolves to type `str`.

Shows up on the loading screen when a player joins the server.

#### `server_core.metadata.creator_name`

Resolves to type `str`.

Shows up on the loading screen when a player joins the server.

#### `server_core.metadata.icon_uri`

Resolves to internal type `uri_obj`.

Can resolve to either a relative or absolute local path -- or extracted from a remote URL.

#### `server_core.place_file.rbxl_uri`

Resolves to internal type `uri_obj`. Files must be encoded in the binary `rbxl` format and not in the human-readable `rbxlx` format.

Can resolve to either a relative or absolute local path -- or extracted from a remote URL.

```toml
rbxl_uri = 'c:\Users\USERNAME\Documents\Baseplate.rbxl'
```

```toml
rbxl_uri = 'https://archive.org/download/robloxBR1/RBR1/RBR1.rbxl'
```

#### `server_core.place_file.enable_saveplace`

Resolves to type `bool`; defaults to false.

When `game:SavePlace()` is called and `enable_saveplace` is true, the file at [`rbxl_uri`](#game_setupplace_filerbxl_uri) is overwritten. It won't work if `rbxl_uri` points to a remote resource.

#### `server_core.place_file.track_file_changes`

Resolves to type `bool`; defaults to false.

When the file at `rbxl_uri` is modified, RCC is restarted such that RFD always runs the latest version of the file. It won't work if `rbxl_uri` points to a remote resource.

#### `game_setup.roblox_version`

The following are valid version strings.

| `"v348"`  | `"v463"`  |
| --------- | --------- |
| `"2018M"` | `"2021E"` |
| `"2018"`  | `"2021"`  |

All entries on the same column are aliases for the same version.

#### `game_setup.asset_cache.dir_path`

Resolves to type `path_str`. Relative paths are traced from the directory where the config file is placed.

#### `game_setup.asset_cache.clear_on_start`

Resolves to type `bool`; defaults to false.

If true, deletes cache from assets which should redirect so that the config file remains correct.

#### `game_setup.asset_cache.name_template`

Resolves to [function](#functions) type `(int | str) -> str`.

With the asset iden passed in (a string or integer), returns the name of the asset file that is stored in [`./AssetCache`](#asset-packs).

Default naming convention is `%11d` for integers or `%s` for strings.

#### `game_setup.persistence.clear_on_start`

Resolves to type `bool`; defaults to false.

If true, clears [the `sqlite` database](#game_setuppersistencesqlite_path) before starting a new server.

#### `game_setup.persistence.sqlite_path`

Resolves to type `path_str`. Relative paths are traced from the directory where the config file is placed.

#### `server_core.chat_style`

Corresponds to Rōblox [`Enum.ChatStyle`](https://create.roblox.com/docs/reference/engine/enums/ChatStyle). Can either be `"Classic"`, `"Bubble"`, or `"ClassicAndBubble"`.

#### `server_core.retrieve_default_user_code`

Resolves to [function](#functions) type `(float) -> str`.

If the client doesn't include a [`-u` user code](#player) whilst connecting to the server, this function is called. Should be a randomly-generated value.

```toml
retrieve_default_user_code_call_mode = "lua"
retrieve_default_user_code = '''
function(tick) -- float -> str
    return string.format('Player%d', tick)
end
```

#### `server_core.check_user_allowed`

Resolves to [function](#functions) type `(int, str) -> bool`.

Expect this function to be called multiple times for a single user.

```toml
check_user_allowed_call_mode = "lua"
check_user_allowed = '''
function(user_id_num, user_code) -- string -> bool
    return true
end
'''
```

#### `server_core.check_user_has_admin`

Resolves to [function](#functions) type `(int, str) -> bool`.

```toml
check_user_has_admin_call_mode = "lua"
check_user_has_admin = '''
function(user_id_num, user_code) -- string -> bool
    return true
end
'''
```

#### `server_core.retrieve_username`

Resolves to [function](#functions) type `(int, str) -> str`.

Only gets called the first time a new user joins. Otherwise, RFD checks for a cached value in [the `sqlite` database](#game_setuppersistencesqlite_path).

```toml
retrieve_username_call_mode = "lua"
retrieve_username = '''
function(user_id_num, user_code)
    return user_code
end
'''
```

#### `server_core.retrieve_user_id`

Resolves to [function](#functions) type `(str) -> int`.

Only gets called the first time a new user joins. Otherwise, RFD checks for a cached value in [the `sqlite` database](#game_setuppersistencesqlite_path).

```toml
retrieve_user_id_call_mode = "lua"
retrieve_user_id = '''
function(user_code)
    return math.random(1, 16777216)
end
'''
```

#### `server_core.retrieve_avatar`

Resolves to [function](#functions) type `(int, str) -> util.types.structs.avatar`.

This function replaces the following options from versions 0.59.X and earlier:

- `retrieve_avatar_type`,
- `retrieve_avatar_items`,
- `retrieve_avatar_scales`, and
- `retrieve_avatar_colors`.

```toml
retrieve_avatar_call_mode = "lua"
retrieve_avatar = '''
function(user_id_num, user_code)
    return {
        type = 'R15',
        items = {
            10726856854,
            9482991343,
            9481782649,
            9120251003,
            4381817635,
            6969309778,
            5731052645,
            2846257298,
            121390054,
            261826995,
            154386348,
            201733574,
            48474294,
            6340101,
            192483960,
            190245296,
            183808364,
            34247191,
        },
        scales = {
            height = 1,
            width = 0.8,
            head = 1,
            depth = 0.8,
            proportion = 0,
            body_type = 0,
        },
        colors = {
            head = 315,
            left_arm = 315,
            left_leg = 315,
            right_arm = 315,
            right_leg = 315,
            torso = 315,
        },
    }
end
'''
```

#### `server_core.retrieve_groups`

Resolves to [function](#functions) type `(int, str) -> dict[str, int]`.

Key is the group iden number written as a string; value is the rank value from 0 to 255.

```toml
retrieve_groups_call_mode = "lua"
retrieve_groups = '''
function(user_id_num, user_code)
    return {
        ['1200769'] = 255;
        ['2868472'] = 255;
        ['4199740'] = 255;
        ['4265462'] = 255;
        ['4265456'] = 255;
        ['4265443'] = 255;
        ['4265449'] = 255;
    }
end
'''
```

#### `server_core.retrieve_account_age`

Resolves to [function](#functions) type `(int, str) -> int`.

```toml
retrieve_account_age_call_mode = "lua"
retrieve_account_age = '''
function(user_id_num, user_code) -- str -> int
    return 6969
end
'''
```

#### `server_core.retrieve_default_funds`

Resolves to [function](#functions) type `(int, str) -> int`.

Established the amount of funds that a player receives when they join a server for the first time. These funds can only be spent on [server-defined gamepasses](#remote_datagamepasses).

```toml
retrieve_default_funds_call_mode = "lua"
retrieve_default_funds = '''
function(user_id_num, user_code)
    return 6969
end
'''
```

#### `server_core.filter_text`

Resolves to [function](#functions) type `(str, int, str) -> str`.

```toml
filter_text_call_mode = "lua"
filter_text = '''
function(text, user_id_num, user_code)
    return text:gsub('oo','òó'):gsub('OO','ÒÓ'):gsub('ee','èé'):gsub('EE','ÈÉ'):gsub('Roblox','Rōblox'):gsub('ROBLOX','RŌBLOX')
end
'''
```

#### `remote_data.gamepasses`

Resolves to a data dictionary.

```toml
[[remote_data.gamepasses]]
id_num = 163231044
name = 'EnforcersPowers'
price = 100
```

```toml
[remote_data.gamepasses.163231044]
name = 'EnforcersPowers'
price = 100
```

#### `remote_data.asset_redirects`

Resolves to [function](#functions) type `(int | str) -> asset_redirect`.

When an RFD server receives a request to load an asset by id, it does so from Roblox.com by default.

However, entries in [`asset_redirects`](#remote_dataasset_redirects) override that default.

The following examples notate the structure into the [dict mode](#dict-mode) syntax:

Through the `forward_url` field, clients are automatically redirected to a new URL to load any assets.

Asset redirects with this scheme are _not_ saved to `./AssetCache`.

```toml
[remote_data.asset_redirects.13] # asset iden 13
forward_url = 'https://archive.org/download/youtube-WmNfDXTnKMw/WmNfDXTnKMw.webm'
```

You can include a `cmd_line` field if you want the loaded asset to _literally_ come from the `stdout` of a program installed on the server.

Asset redirects with this scheme _are_ saved to `./AssetCache`.

```toml
[remote_data.asset_redirects.14] # asset iden 14
cmd_line = 'curl https://archive.org/download/youtube-WmNfDXTnKMw/WmNfDXTnKMw.webm -L --output -'
```

A `raw_data` field works here too. That literally encapsuates the binary data that will be sent as an asset.

Asset redirects with this scheme _are_ saved to `./AssetCache`.

```toml
[remote_data.asset_redirects.15]
raw_data = '\0'
```

---

This script (in [Python mode](#python-mode)) should work. It redirects asset iden strings starting wtih `time_music_` to static files on the internet.

```toml
remote_data.asset_redirects = "python"
remote_data.asset_redirects = '''
def f(asset_iden):
    PREFIX = "time_music_"
    if asset_iden.startswith(PREFIX):
        h = int(asset_iden[len(PREFIX):])
        return {
            "forward_url": "https://github.com/Windows81/Time-Is-Musical/blob/main/hour_%02d.wav" % (h % 24)
        }
    return None
'''
```

#### `remote_data.badges`

Resolves to a data dictionary.

```toml
[[remote_data.badges]]
id_num = 757
name = 'Awardable Badge'
price = 1
```

```toml
[remote_data.badges.757]
name = 'Awardable Badge'
price = 1
```

---

<p align="center"><img src="https://github.com/Windows81/Roblox-Freedom-Distribution/raw/main/Assets/Logo.png" height="60px"/></p>
https://github.com/Windows81/Roblox-Freedom-Distribution/tree/main

Formatting Options:

HTML BBCode (Default) Markdown

Attachments (Max 5MB each):

Anonymous attachments will always expire 15 minutes after upload.

The Cyberix Network

Rōblox: Freedom Distribution: Revival-style launcher that allows people to host their own instances of Rōblox for other people to play.

Rōblox: Freedom Distribution

Copyright Acknowledgement

Download

As an Executable

For Windows

For GNU/Linux

From (https://github.com/Windows81/Roblox-Freedom-Distribution/archive/refs/heads/main.zip)

Command Syntax

server

player

studio

serialise

download

test

cookie

Network Ports in Use

RCC (UDP)

Webserver (unsigned HTTPS)

Loading Assets from Rōblox

PlaceID Spoofing

Setting Up Enviroment Variables

Local Asset Persistence

How About Studio?

Directories Affected

Usage Examples

Server

Player

GameConfig.toml Structure

Special Types

Functions

Python Mode

Dict Mode

Lua Mode (unstable)

Options

metadata.config_version_wildcard

server_core.startup_script

server_core.metadata.title

server_core.metadata.description

server_core.metadata.creator_name

server_core.metadata.icon_uri

server_core.place_file.rbxl_uri

server_core.place_file.enable_saveplace

server_core.place_file.track_file_changes

game_setup.roblox_version

game_setup.asset_cache.dir_path

game_setup.asset_cache.clear_on_start

game_setup.asset_cache.name_template

game_setup.persistence.clear_on_start

game_setup.persistence.sqlite_path

server_core.chat_style

server_core.retrieve_default_user_code

server_core.check_user_allowed

server_core.check_user_has_admin

server_core.retrieve_username

server_core.retrieve_user_id

server_core.retrieve_avatar

server_core.retrieve_groups

server_core.retrieve_account_age

server_core.retrieve_default_funds

server_core.filter_text

remote_data.gamepasses

remote_data.asset_redirects

remote_data.badges

Post a Reply

`server`

`player`

`studio`

`serialise`

`download`

`test`

`cookie`

`GameConfig.toml` Structure

`metadata.config_version_wildcard`

`server_core.startup_script`

`server_core.metadata.title`

`server_core.metadata.description`

`server_core.metadata.creator_name`

`server_core.metadata.icon_uri`

`server_core.place_file.rbxl_uri`

`server_core.place_file.enable_saveplace`

`server_core.place_file.track_file_changes`

`game_setup.roblox_version`

`game_setup.asset_cache.dir_path`

`game_setup.asset_cache.clear_on_start`

`game_setup.asset_cache.name_template`

`game_setup.persistence.clear_on_start`

`game_setup.persistence.sqlite_path`

`server_core.chat_style`

`server_core.retrieve_default_user_code`

`server_core.check_user_allowed`

`server_core.check_user_has_admin`

`server_core.retrieve_username`

`server_core.retrieve_user_id`

`server_core.retrieve_avatar`

`server_core.retrieve_groups`

`server_core.retrieve_account_age`

`server_core.retrieve_default_funds`

`server_core.filter_text`

`remote_data.gamepasses`

`remote_data.asset_redirects`

`remote_data.badges`