Skip to content

sasial-dev/Edit-Roblox-Place

Repository files navigation

Edit Roblox Place

A powerful, interactive CLI (Command Line Interface) to help you open Roblox Studio places.

GitHub license JavaScript Style Guide npm David David FOSSA Status

Getting Started

Prerequisites

You must have node installed if you are installing through npm. It must be at least version 12.20, 14.14, or 16.0. (This package has dependencies that are Pure ESM)

Reccomended Installation

Use the package manager npm to install edit-roblox-place.

npm install edit-roblox-place --global

Other Installation

Binaries are avaliable for versions 1.1.2 and above. To download them, go to the release page, and download the version for your operating system. You can then use it as a command line argument (Example: ./edit-roblox-place --help)

Or add it to your path in windows, mac and linux. With more information provided here for mac users. It is suggested to use node, but if you have added edit-roblox-place to your path, it will work like the node version.

Usage

edit-roblox-place has been designed to be very similar, keeping close to its inspiration, but providing more features including interactivity and favourites.

Usage: edit-roblox-place [options]

Options:
  -v, --version                                output the version number
  -p, --place <id>                             place id to open
  -f, --favourite <name>                       favourite to use
  -c, --config [create | list | add | remove]  open the interactive config wizard. You can skip this by appending -p & -f options if you wish. Append list to list the current config. Append create to create the config file, if you did not create it at install.
  -h, --help                                   display help for command

Roadmap

None at the moment. If you have any ideas please let us know on the discord or open an issue!

Contributing

We love contributions! Pull requests are warmly welcomed and highly appriciated. For major changes, please open an issue first or discuss on the discord to let us know what you would like to change.

Support

Join the Lundstrong Discord. A channel is there for support.

License

FOSSA Status

Acknowledgements

edit-roblox-place has been inspired by a version written in Rust. (https://github.com/rojo-rbx/edit-roblox-place) We've built on that to provide more features including interactivity and favourites. If it wasn't for that library, this wouldn't exist.

The CLI would not be possible without the following libraries:

And the libraries for the developing: