62 lines
1.4 KiB
Markdown
62 lines
1.4 KiB
Markdown
# workspace-detector
|
|
|
|
A command-line tool for analyzing Roblox .rbxm(x) model files to identify workspaces and detect hidden places embedded within them.
|
|
|
|
## Overview
|
|
|
|
This tool works to detect Roblox workspaces within .rbxm(x) model files, which could potentially contain stolen/lost places. It runs on the [Lune](https://github.com/lune-org/lune) runtime environment.
|
|
|
|
## Installation
|
|
|
|
### Prerequisites
|
|
|
|
[Install the Lune runtime using rokit](https://lune-org.github.io/docs/getting-started/1-installation/)
|
|
|
|
### Setup
|
|
|
|
Clone or download this repository and ensure all required libraries are installed:
|
|
|
|
```bash
|
|
git clone https://github.com/filoxen/workspace-detector.git
|
|
cd workspace-detector
|
|
rokit install
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Basic Usage
|
|
|
|
```bash
|
|
lune run detector path/to/your/model.rbxm(x)
|
|
```
|
|
|
|
### Options
|
|
|
|
#### Directory scan (recursive):
|
|
|
|
```bash
|
|
lune run detector.lua --directory /path/to/your/directory/with/models
|
|
```
|
|
|
|
#### Output list of files containing workspaces:
|
|
|
|
```bash
|
|
lune run detector.lua --output /path/to/your/output/file.txt
|
|
```
|
|
|
|
#### Process non-extensioned files (i.e no filetype extension / differing extension from .rbxm)
|
|
|
|
```bash
|
|
lune run detector.lua --force-binary-read /path/to/your/model.variantfile
|
|
```
|
|
|
|
|
|
|
|
## Limitations
|
|
|
|
- Requires valid .rbxm files (corrupted/invalid/different versioned files may cause errors)
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome. Please ensure new features include documentation.
|