Tooling setup

Getting the npm package

To install Rostar, make sure Node.js is set up. After that, it can installed by getting the rostar package:

npm install -g rostar

Running the command with the -g argument is recommended, and allows you to run rostar from any location in your console.

Installing Rojo and Remodel

It is recommended to use Foreman for managing Rostar's required tools - Rojo and Remodel. Foreman can be installed through cargo or by getting the binary files inside your system PATH.

note

Foreman may be replaced by Aftman in the future.

Setting up Foreman

Windows

1. Open the "Edit the system environment variables" application.

   

2. Select "Environment Variables...".

   

3. Under the "User variables for me" section, select "Path" and click "Edit...".

   

4. In the menu that opens, click "New".

   

5. Add the C:\Users\<My username>\.foreman\bin\ directory.

6. Create the C:\Users\<My username>\.foreman\bin\ directory:

   mkdir %userprofile%\.foreman\bin

7. Download the Foreman archive specific to your OS from the releases on GitHub.

8. Unzip the archive and place the executable in the C:\Users\<My username>\.foreman\bin\ directory.

MacOS

1. Open or create the ~/.zshrc file and add :/Users/<My username>/.foreman/bin to the end of the PATH= line. If this line doesn't exist add a new line with the contents:

   PATH=/Users/<My username>/.foreman/bin
2. Download the Foreman archive specific to your OS from the releases on GitHub.
3. Unzip the archive and place the executable in /usr/local/bin/.

Linux

1. Depending on the shell, the PATH variable will have to be appended /home/<My username>/.foreman/bin.
2. Download the Foreman archive specific to your OS from the releases on GitHub.
3. Unzip the archive and place the executable in /usr/local/bin/.