Skip to content
This repository was archived by the owner on Apr 28, 2026. It is now read-only.

Installation Guide

Jump to bottom
stuartt_mcoded edited this page Jan 16, 2023 · 9 revisions

A video guide will be coming out soon!

Installing Rec.js is easy, but requires you to run a few commands to get started.

Part 1: Installing node.js

If you already have node installed, go to Step 2!

This part of the tutorial will come later!

Part 2: Downloading and preparing Rec.js for use!

Now that you have node.js installed, you can now download Rec.js and get it ready for use!

Part 2.1: Pick your version!

There are multiple versions of Rec.js you can choose from.

Note: Stable and Pre links do not work at the moment.

  • 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

Part 2.2: Extract your download!

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.

Part 2.3: Install the requirements!

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!

This part requires you top enter the terminal! Scary!

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.

Part 3: Running

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.

All of these guides are for educational use only!

All guides are a work in progress! Expect some information to be incorrect or change in the future.

Clone this wiki locally