Installation Guide
Installing Rec.js is easy, but requires you to run a few commands to get started.
If you already have node installed, go to Step 2!
node.js setup should be easy enough to do.
You can find the node installer here. I recommended that you use the LTS release of node as it tends to be more stable than the latest release.
When the installer is finished downloading, run the file. When it launches, you should see something like this.
Click "Next".
Accept the terms and click "Next".
If you want to install node to a different location, change it here. When you're done, click "Next".
I recommend you don't touch anything here and just click "Next".
None of the modules use this, so leave it unchecked and click "Next".
When you're ready, click "Install"!
If you get a UAC prompt, just allow it.
When the installer is done, click "Finish"!
Now that you have node.js installed, you can now download Rec.js and get it ready for use!
There are multiple versions of Rec.js you can choose from.
- Latest Stable Release - The current stable release of Rec.js. The most stable offering. Recommended
- Latest Pre Release - The next version of Rec.js. Contains new features and is not as stable.
- Latest Developer Release - Contains features that come out as soon as they are added. The least stable version with untested code. Use at your own risk!
If you have git installed, you can clone the project by running git clone https://github.com/RealMCoded/Rec.js.
note: using git will download the Developer release
If you used git, skip this step!
Depending on what version you downloaded, your downloaded file will be called something different. No matter the case, the file will still have "Rec.js" in the name at the beginning.
Extract the folder that is in the ZIP file to a memorable location.
Now that you have the files for Rec.js on your computer, it's time to install the files that are required to make it work!
There are 2 ways to do this. With the install script that is included in the package or with typing the commands in the terminal. This part goes over the install process with a terminal.
To launch the terminal, you can either right click inside the directory where Rec.js is and click "Open in Terminal". It does not matter if your terminal is in PowerShell or Command Prompt mode.
With the terminal open, you can now run the command npm i to install all requirements.
If you get the error code ENOENT, you probably don't have the terminal open in the same location as Rec.js.
To start the program, run the following command in the terminal: npm run rec.js. This will run the EZ-Menu which allows you to get quick access to the config utility and to start the server.
If you want to skip the EZ-Menu, there are ways to access the functions without it. Check out Command Line Arguments for more information.