Skip to content

creepersaur/CreeperCLI-2

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

77 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CreeperCLI_logo|368x222

GitHub Creator Store

What is it?

Have you ever wanted to push your script files from your computer to Roblox Studio directly? Well with CreeperCLI, you can do that. It's extremely simple, and it's easier to use than Rojo.

Supported FileTypes

*.lua -------------> ModuleScript

*.server.lua ------> Script

*.client.lua ------> LocalScript

*.json ------------> ModuleScript

(JSON files will try to automatically be converted to modules.)

How do I use it?

It's really simple. Follow a few steps and you'll be right on track!

Installation

  • Get the CreeperCLI plugin from the Roblox Creator Store.
  • Get the latest release of the .exe file. By going to the Releases tab. (Or from the source code)

Tip

Keep in mind, that you can either put the .exe file inside the folder and run it, or do the following:

  • Download CreeperCLI.
  • Put it somewhere safe (where you won't delete it).
  • Add the directory path to your Environment Variables.

Start/Restart the terminal and in your game's directory. Then use the exe's name (e.g. creeper_cli) to start the server.

Running

  • Create an empty folder
  • Put the .exe inside (or use the tip above).
  • Create a new game folder.
  • Run the .exe first.
  • Open the plugin from the Plugins tab, and click Connect.

[!INFO]

Attempting to connect the plugin before running the server will result in an error.

Not Connected vs. Connected:

alt text vs. alt text

Game / Tree / Root

CreeperCLI uses a tree sort of interface. The same way that the Roblox Explorer does.

The game folder is the starting of the tree, or the root.

Any folders or scripts you add in here, will be translated to folders and scripts in Roblox Studio. Hence if I wanted to put a script inside of ServerScriptService, I'd need to setup my tree like this:

# game
  - ServerScriptService
      - Hello.server.luau

It would get translated to this in studio:

alt text

Caution

If you spell a folder or file incorrectly, it will not line up correctly with in-game folders.

CreeperCLI will create a new folder for any name it cannot find.

Compiling CreeperCLI

  • Install rust + cargo (through rustup).
  • Install Rust Visual Studio Prerequisites (rustup should've done that already).
  • Download the source code and check if cargo is working (use cargo).
  • Clone the git repository and cd into it.
  • Run cargo build --release to compile it. (use cargo run --release to run the .exe immediately).
  • The .exe file should be the target/debug/creeper_cli.exe file. (Binary may be different due to OS).

Have fun creating, and also report any issues on the devforum post. (I probably won't read the Issues tab, but you're free to do anyway.)

About

A linker for Roblox. Inspired by Rojo.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages