Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pera-swarm/swarm-simulator
This repository contains the implementations of a mixed reality-based swarm simulator
https://github.com/pera-swarm/swarm-simulator
nodejs simulation swarm-robotics typescript
Last synced: about 1 month ago
JSON representation
This repository contains the implementations of a mixed reality-based swarm simulator
- Host: GitHub
- URL: https://github.com/pera-swarm/swarm-simulator
- Owner: Pera-Swarm
- License: mit
- Created: 2020-07-10T05:56:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-04T18:27:57.000Z (12 months ago)
- Last Synced: 2024-02-04T21:16:15.707Z (12 months ago)
- Topics: nodejs, simulation, swarm-robotics, typescript
- Language: JavaScript
- Homepage:
- Size: 874 KB
- Stars: 1
- Watchers: 2
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
# Mixed Reality Simulator
### Requirements
Please install node dependencies as follows:
```
npm install
```
### Environment Variables
Please copy the _sample.env_ file and rename into _.env_ and complete the configurations for http and mqtt
```bash
MQTT_HOST=mqtt://localhost
MQTT_USER=user
MQTT_PASS=password
MQTT_CLIENT=mqtt_server
MQTT_CHANNEL=v1
ARENA_CONFIG="./app/config/arena/{arena_config}.json"
LOG_LEVEL='info'
```
### Run the scripts
Development environment
```
npm run dev
```
Production environment
```
npm start
```
### Documentation
You can find more information about pera-swarm on the [Official Documentation Page](https://pera-swarm.ce.pdn.ac.lk/docs/).
### Read More
- [TypeScript](https://www.typescriptlang.org/)
- [NodeJS](https://nodejs.org/)
- [NPM](https://www.npmjs.com/)
- [MQTT](https://github.com/mqttjs/MQTT.js)
- [Node Cron](https://github.com/merencia/node-cron)