Getting Started

Installation

First of all we are going to need to install the RoSync plugin for Roblox Studio, you can Install it here if you plan on using team create make sure you Read the Team create documentation. If you are using a online server like Replit make sure you read Setting up a online server for RoSync However if you plan on using your own computer you can Download RoSync (All platforms) this will install RoSync so it can be used in Command Prompt

Creating a new RoSync project

Once you have installed RoSync onto your computer open a command prompt and type the following command to set up a RoSync project

rosync init

it will now ask you to input a project name, This is what your project will be named as. Now go to your documents and into the RoSync folder. Inside of there you will find your project with the name you chose, This is your RoSync project.

Starting the server

If you are using your computer then open a command prompt and type

rosync start

If you already have a RoSync server started you will need to change the port the new server starts on. To do this you can use this command

rosync start -p PORT

make sure to replace PORT with the number you want (Some may be already in use so choose carefully) and now your RoSync server is up and running. Now we can connect to it inside of Roblox Studio.

Connecting to the server

Inside of Roblox Studio Go to the plugins area and click the RoSync icon. This will show or hide the RoSync Plugin's UI. Inside this UI is the connection page. To connect to your server just hit the connect button and click allow on the Roblox Prompts. If you chose a custom port make sure to enter it in the box that says 14812 if you have a online server enter its public url into the box that says localhost and click connect. (You may have to put port 0 if you are using a online server as they may automatically handle ports)

RoSync project tree

You may notice inside of your RoSync project that you have a folder called src in this you will see a bunch of folders similar to Roblox studio's explorer. This is the tree of your project, Every folder corresponds to the actual location in Roblox Studio. To see how to create files and scripts make sure to Read How to use RoSync

Team Create with RoSync

Team Creating with RoSync doesn't have to be a pain all you need is to set up your own server on your computer Read this for more information or use a free online service like Replit if you choose to use a online service Read this for more information and then you can all edit your game with not a lot of hassle as RoSync allows you to work inside of Roblox Studio and on your local machine

Setting up a online server

If you want to set up a online server I would recommend using Replit. Once you have chosen your online service create a new nodejs project. Now install rosync for nodejs using this command

npm i rosync-nodejs

Now inside of index.js you can create a new RoSync project using this code

const RoSync=require('rosync-nodejs');
RoSync.init('PROJECTNAME');

Make sure to replace PROJECTNAME with your desired project name. Once it finishes you need to start the server. Make sure that index.js is empty and paste the following code in it

const RoSync=require('rosync-nodejs');
RoSync.StartServer();

And thats it. Your RoSync server is now up. Now to ensure it stays up you can use an online monitoring service such as Freshping or Uptime Robot to make sure it stays alive. To connect to it in Roblox Studio Click here