Klagarge/MinecraftElectricalAge
Archived
1
0
Fork 0
Code Issues Pull Requests Activity

update README.md

Browse Source
This commit is contained in:
Rémi Heredero 2023-06-17 15:38:30 +02:00
parent 2a8d9c1e33
commit 0e05dcdb64
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -44,6 +44,25 @@ regulation just for keep the grid alive during the time of the simulation. We st
simulation send a score. This score is how many production we have made with the factory during the simulation. So
the goal is to maximize this score. We didn't have time to make a better regulation.
### Full description
You can find the Javadoc of this project in the folder ``javadoc`` at the root of the project.
## How to use
To use this project you can just download the last release and run the JAR file with some arguments.
The arguments are:
The command to run the JAR file is:
``java -jar MinecraftController.jar <db_url> <db_org> <db_bucket> <db_token> <modbus_host> <modbus_port> [-erasedb]``
Where the arguments are:
``db_url``: The complete URL of the InfluxDB server, including the protocol (http or https)...
Example: https://influx.sdi.hevs.ch
``db_org``: The name of the Influx DB to use. For this project, this name is the name of the group you've been
affected to. (SInXX)
``db_bucket``: The user's name to use to access the DB. It's also your group's name. (SInXX)
``db_token``: The Token to use to access the DB.
``modbus_host``: The IP address of the Minecraft ModbusTCP server (default value: localhost)
``modbus_port``: The port number of the Minecraft ModbusTCP server (default value: 1502)
``-erasedb``: Optional parameter! If set, the application will erase the previous data in InfluxDB...
Example:
``java -jar MinecraftController.jar https://influx.sdi.hevs.ch SIn15 SIn15 evP...nj-Q== localhost 1502 -erasedb``