Skip to content

Commit 40bb606

Browse files
author
Petar Kresoja
committed
Update README.md
1 parent 719990d commit 40bb606

File tree

1 file changed

+87
-1
lines changed

1 file changed

+87
-1
lines changed

README.md

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,88 @@
11
# JavaRcon
2-
Remote console tool for Source and Minecraft game servers, works on all operating systems (with Java 8 or higher installed))
2+
3+
**JavaRcon** is a simple **java based remote console tool** primarly intended to be used for sending commands to Source endgine and Minecraft servers remotely. Game server must have rcon enabled in order for this tool to work.
4+
5+
You can use this program compiled or you can also compile it yourself by using the included source code. Also you can download the latest compiled version from relises !
6+
7+
## Getting Started
8+
9+
I will give you a short tutorial on how to set up this tool on a Debian distribution called Ubuntu Server (these steps should be same for any Debian based Linux distro). I recommend using Debian distribution called Ubuntu Server for any type of server hosting.
10+
More detailed guide will be available here: [JavaRcon](https://github.io/docs/javarcon/index.html)
11+
12+
### Prerequisites (Windows)
13+
14+
You will need to visit [Java download page](https://www.java.com/en/download/manual.jsp) and download the latest java software for Windows and install it! If you already had java installed skip this part.
15+
16+
Now lets check if the java installed correctly by typing in Command Prompt:
17+
18+
```
19+
java -version
20+
```
21+
22+
If it returns something like this you are ok:
23+
24+
```
25+
java version "1.8.0_241"
26+
Java(TM) SE Runtime Environment (build 1.8.0_241-b07)
27+
Java HotSpot(TM) 64-Bit Server VM (build 25.241-b07, mixed mode)
28+
```
29+
30+
### Prerequisites (Debian\Ubuntu)
31+
32+
First of all we need to download (or make sure we have) Java 8 installed on our server instance. To do that type in:
33+
34+
```
35+
sudo apt update
36+
sudo apt install openjdk-8-jre
37+
```
38+
39+
If the terminal returns:
40+
41+
```
42+
$ openjdk-8-jre is already the newest version
43+
```
44+
45+
You already had Java 8 installed (and that is expected since Minecraft server requries Java 8 too).
46+
47+
### Installing
48+
49+
Download the latest relase from [here](https://github.com/Pequla/JavaRcon/releases) and extract its content !
50+
51+
If you are on widnows just edit "config.properties" and than run the tool with run.bat
52+
53+
This is how your config will look like by default (plase change the parametares to fit your server):
54+
55+
```
56+
#JavaRcon configuration file.
57+
#Created by: Pequla ( https://pequla.github.io/ )
58+
#Thu Mar 12 23:38:50 CET 2020
59+
rcon.password=password
60+
rcon.port=25575
61+
rcon.host=localhost
62+
```
63+
64+
But if you are on Debian distros such as Ubuntu you will alongside editing that config file need to rename the run.bat file to run.sh and thay use terminal to make it executable:
65+
66+
```
67+
sudo rn run.bat run.sh
68+
sudo chmod u+x run.sh
69+
```
70+
71+
NOTE: If you get error after trying to run the run.sh file with ./run.sh please make these files executable too:
72+
73+
```
74+
sudo chmod u+x JavaRcon.jar
75+
sudo chmod u+x /lib/rkon*
76+
```
77+
78+
## Libraries
79+
80+
* [rkon-core](https://github.com/Kronos666/rkon-core) - Source RCON protocol library made by Kronos666
81+
82+
## Authors
83+
84+
* **Petar Kresoja** - *University Singidunum - Faculty of Informatics and Computing* - [Pequla](https://github.com/Pequla)
85+
86+
## License
87+
88+
This project has no licence but any kind of notice to the github page would be kindly appreciated. Thanks !!!

0 commit comments

Comments
 (0)