https://github.com/pera-swarm/java-robot
This is a boilerplate template for java virtual robots
https://github.com/pera-swarm/java-robot
Last synced: 3 months ago
JSON representation
This is a boilerplate template for java virtual robots
- Host: GitHub
- URL: https://github.com/pera-swarm/java-robot
- Owner: Pera-Swarm
- License: mit
- Created: 2021-05-10T17:32:43.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-28T06:49:15.000Z (over 1 year ago)
- Last Synced: 2025-03-27T20:41:06.049Z (4 months ago)
- Language: Java
- Size: 9.77 KB
- Stars: 1
- Watchers: 0
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](http://www.gnu.org/licenses/gpl-3.0) [](https://github.com/Pera-Swarm/java-robot/actions/workflows/java-ci.yml) 
# Java Robot
This is a boilerplate template for java virtual robots, under *Pera-Swarm*
## Local Environment Setup
If you need to run this repository on your local environment, please create a file named *'mqtt.properties'* in path, *'./src/resources/config/'* as follows and provide your MQTT broker's configurations.
You can select any channel, as same as your simulation server runs on.
```
server=127.0.0.1
port=1883
username=user
password=pass
channel="v1"
```
## Install the Library
- You need to setup a GitHub Token with the scope of `read:packages` and save it along with your GitHub UserName as environment variables as follows:
```xml
{GITHUB_USERNAME}
{GITHUB_TOKEN}
```
- Run the following command to run the `mvn install`
```bash
mvn -s ./settings.xml -B install --file pom.xml
```
## Run with commandline
- Compile the packages and assembly with all the dependencies, using `mvn compile assembly:single`
```bash
mvn clean compile assembly:single -s settings.xml
```
- Run the code implementation using `java -jar [jar_file_path] `
```bash
java -jar target/java-robot-node-1.0-SNAPSHOT-jar-with-dependencies.jar
```
## Detailed Guide
- [pera-swarm.ce.pdn.ac.lk/docs/robots/virtual/v1/java/](https://pera-swarm.ce.pdn.ac.lk/docs/robots/virtual/v1/java/)