62 lines
1.3 KiB
Markdown
62 lines
1.3 KiB
Markdown
|
# RoboCommander v0.3.6
|
||
|
|
|
||
|
|
A desktop application built with Electron for controlling and managing robot interactions.
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
- **Node.js v8.11.1** (use [nvm](https://github.com/nvm-sh/nvm) to manage versions)
|
||
|
|
- All required `node_modules` are included — no `npm install` needed
|
||
|
|
|
||
|
|
## Setup
|
||
|
|
|
||
|
|
### 1. Install nvm (if not already installed)
|
||
|
|
|
||
|
|
```bash
|
||
|
|
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
|
||
|
|
```
|
||
|
|
|
||
|
|
### 2. Install and use Node v8.11.1
|
||
|
|
|
||
|
|
```bash
|
||
|
|
nvm install 8.11.1
|
||
|
|
nvm use 8.11.1
|
||
|
|
```
|
||
|
|
|
||
|
|
Verify:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
node --version
|
||
|
|
# Expected: v8.11.1
|
||
|
|
```
|
||
|
|
|
||
|
|
### 3. Extract the archive (if you haven't already)
|
||
|
|
|
||
|
|
```bash
|
||
|
|
tar -xf RoboCommander.tar -C /path/to/destination
|
||
|
|
cd /path/to/destination
|
||
|
|
```
|
||
|
|
|
||
|
|
## Running the App
|
||
|
|
|
||
|
|
Launch with the bundled Electron binary:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
./node_modules/.bin/electron .
|
||
|
|
```
|
||
|
|
|
||
|
|
This will open the RoboCommander window (1280x720).
|
||
|
|
|
||
|
|
### Linux: No display / headless environment
|
||
|
|
|
||
|
|
If you get a display error, make sure your `DISPLAY` environment variable is set:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
DISPLAY=:0 ./node_modules/.bin/electron .
|
||
|
|
```
|
||
|
|
|
||
|
|
## Notes
|
||
|
|
|
||
|
|
- Do **not** run with `node main.js` — this is an Electron app and must be launched via the `electron` binary.
|
||
|
|
- The app is pre-built. Source files are bundled into `main.js` and `renderer.js` — no build step is required.
|
||
|
|
- Electron version: **4.0.8**
|