Add README.md
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Andreas Greiner 2024-02-02 20:04:46 +01:00
parent 1b8bafe6e5
commit 7c215d3177

26
README.md Normal file
View File

@ -0,0 +1,26 @@
# XCraft bot collection
A collection of bots for the game XCraft, some being unfinished examples.
## Download
Download the latest version from [releases](https://git.greinet.com/EDV-Schule/XCraftBots/releases). It is a packed jar with all needed dependencies.
## Usage
Simply execute the jar using the following command to see the available bots:
```
java -jar XCraftBots-1.0-jar-with-dependencies.jar
```
```
Please specify as parameter what you want to launch:
(1) XCastPlantFarm
(2) MarketplaceUI
(3) SwingUI2
(4) XCastHealthFarm
(5) XCastOkariFarm
```
Then select the wanted bot and specify it as parameter:
```
java -jar XCraftBots-1.0-jar-with-dependencies.jar 2
```