Skip to content

Commit 2693874

Browse files
committed
Update README & ADD demo server
- Translation of forgotten sentences; - Addition of information in the readme file; - Adding a script and a minecraft 1.15.2 demo server.
1 parent e93c7a2 commit 2693874

4 files changed

Lines changed: 147 additions & 11 deletions

File tree

README.md

Lines changed: 75 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,30 @@
11
# MinecraftServerShManager - EndServ
22

33
![GitHub license](https://img.shields.io/badge/license-GPL--3.0-%23fe7d37) ![GitHub last commit](https://img.shields.io/github/last-commit/EndMove/MinecraftServerShManager)
4+
5+
[![Donate][link-icon-coffee]][link-paypal-me] [![Website][link-icon-website]][link-website]
6+
7+
[link-icon-coffee]: https://img.shields.io/badge/%E2%98%95-Buy%20me%20a%20cup%20of%20coffee-991481.svg
8+
[link-paypal-me]: https://www.paypal.me/EndMove/2.5eur
9+
[link-icon-website]: https://img.shields.io/badge/%F0%9F%92%BB-My%20Web%20Site-0078D4.svg
10+
[link-website]: https://www.endmove.eu/
11+
412
MinecraftServerShManager, will allow you to host several minecraft servers on your machine and to navigate freely between their different consoles. Thanks to the simplified EndServ management script, you don't have to bother with a lot of useless commands, you just need to remember the name of your server!
513

614
## Getting Started
715
To get started you will need to install `screen`, `java` as well as `nano`, to do this follow the instructions below.
816

917
### Installing Dependencies
10-
To perform updates if the system is not:
18+
To perform updates if the system is not :
1119
````sh
1220
apt-get update && apt-get upgrade
1321
````
1422

15-
Install Java, Screen, Nano (if you already have one of the packages remove it from the list)
23+
Install Java, Screen, Nano (if you already have one of the packages remove it from the list).
1624
````sh
1725
apt-get install default-jdk screen nano
1826
````
27+
Warning, to be able to run `server.jar` you must have Java 8 at least (`apt-get install oracle-java8-installer`)
1928

2029
### Installing
2130
For this installation the directory `~/home/minecraft/` will be the main directory where the minecraft servers will be stored.
@@ -31,42 +40,97 @@ mv MinecraftServerShManager minecraft && cd minecraft
3140

3241
### Create a Minecraft Server
3342
Perform this process the number of times you need a minecraft server.
43+
3444
:warning: Don't forget to replace `server_name` with the name of your server.
3545

3646
````sh
3747
# We copy the EndServ.sh file (to have one per server)
3848
cp EndServ.sh server_name.sh
3949
# We change permissions
4050
chmod +x server_name.sh
41-
# We chalk up the server's file and move in.
51+
# We chalk up the server's file and move in
4252
mkdir server_name && cd server_name
43-
# On craie le fichier EULA de Mojang et on le valide
53+
# Let's chalk up Mojang's EULA file and validate it
4454
touch eula.txt && echo "eula=true" >> eula.txt
4555
````
4656

47-
Now you need to download the `.jar` Sigot, Vanilla, Sponge, ... you want to use as a server and put it in the server_name folder you just created. Once the downloaded `.jar` file renamed it to `server.jar` to do this you can use the command `mv file_name.jar server.jar`. Once all these manipulations are done your architecture should look like this:
57+
Now you need to download the `.jar` Sigot, Vanilla, Sponge, ... you want to use as a server and put it in the server_name folder you just created. Once the downloaded `.jar` file renamed it to `server.jar` to do this you can use the command `mv file_name.jar server.jar`. Once all these manipulations are done your architecture should look like this :
4858
````
4959
~/home/minecraft
5060
|-- .gitattributes
5161
|-- EndServ.sh
5262
|-- LICENSE
5363
|-- README.md
5464
|
65+
|----@ /demo
66+
| |-- server.jar
67+
| |-- eula.txt
68+
|-- demo.sh
69+
|
5570
|----@ /server_name
5671
| |-- server.jar
5772
| |-- eula.txt
5873
|-- server_name.sh
5974
|
6075
|----@ /(your other servers)
76+
| |-- server.jar
77+
| |-- eula.txt
78+
|-- (your other manager script).sh
6179
````
6280

63-
Il faut maintenant configurer votre fichier `server_name.sh`.
81+
Now you need to configure your `server_name.sh` file.
6482
````sh
65-
# We go back to the '~/home/minecraft' folder.
83+
# We go back to the '~/home/minecraft' folder
6684
cd ../
67-
# We open your server's EndServ file with the nano editor.
68-
# Replace in the configuration settings at the top of the file, 'server_name' with the name of your server.
69-
# Use CTRL+O to save followed by CTRL+X followed by ENTER to exit.
85+
# We open your server's EndServ file with the nano editor
86+
# Replace in the configuration settings at the top of the file, 'server_name' with the name of your server
87+
# Use CTRL+O to save followed by CTRL+X followed by ENTER to exit
7088
nano server_name.sh
7189
````
72-
Congratulations! Your configuration is complete use the command `cd /home/minecraft` to go to your management directory and the command `./server_name.sh help` to display the script parameters.
90+
Congratulations! Your configuration is complete use the command `cd /home/minecraft` to go to your management directory and the command `./server_name.sh help` to display the script parameters.
91+
92+
## Comment utiliser ?
93+
After the installation is complete and a server is created, use this command to move to the EndServ scripts directory: `cd /home/minecraft`.
94+
When you are in the directory you can access the controls of your server with this command: `./server_name.sh` this will display the help menu.
95+
96+
### EndServ commands
97+
List of common EndServ commands :
98+
99+
- Start : `./server_name.sh start`
100+
This command starts your minecraft server.
101+
102+
- Stop : `./server_name.sh stop`
103+
Cette commande vous permet d'arrèter votre serveur minecraft.
104+
105+
- Status : `./server_name.sh status`
106+
This command shows if your server is on or off.
107+
108+
- Screen : `./server_name.sh screen`
109+
This command allows you to access the terminal of your minecraft server.
110+
111+
- Reload : `./server_name.sh reload`
112+
This command reloads your minecraft server.
113+
114+
- Version : `./server_name.sh version`
115+
This command gives you some information about the script you are currently using.
116+
117+
- Help : `./server_name.sh help`
118+
This command displays the list of commands of the script.
119+
120+
### Demo server
121+
A demo server has been made available before you can use its script don't forget to make it executable. Use this command in the `~/home/minecraft` directory to do this : `chmod +x demo.sh`. And start your demo server with the command `./demo.sh start`. (server in vanilla version 1.15.2).
122+
123+
## FAQ (Frequently Asked Questions)
124+
Find below some answers to your questions !?
125+
126+
#### [FAQ 1°]: How do I exit the server console (screen) ?
127+
To exit Screen use the keyboard shortcut : `CTRL + A + D`.
128+
129+
#### [FAQ 2°]: My server says the command `./server_name.sh` doesn't exist ?
130+
Don't panic, check that you are in the sh EndServ script folder, if it is the case then the startup shortcut has been disabled on your server ... Run the script using the `sh server_name.sh` command instead of `./server_name.sh`.
131+
132+
#### [FAQ 3°]: My server tells me I don't have permission to run my EndServ script ?
133+
Check that you are an administrator on your machine / vps. If it is not the case use the command `sudo ./server_name.sh` the server will ask you for the root password, indicate it. If you are the administrator in this case, maybe the permissions in your `server_name.sh` file are incorrect, use the command : `chmod 755 server_name.sh`.
134+
135+
#### [FAQ 4°]: The script says that my minecraft server starts but nothing works ?
136+
In this case change the permissions of your minecraft server's folder by running this command : `chmod -R 775 server_name`. If after that your server still doesn't start check that you have correctly configured your EndServ script. You can always contact me at : `contact@endmove.eu` (French and English only).

demo.sh

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
#!/bin/bash
2+
# Powered By EndMove - https://www.endmove.eu/ - Jérémi N
3+
# Version used: 1.0.0
4+
5+
SCREEN="demo" # The name of the screen of your minecraft server
6+
NAME="demo" # The name of your minecraft server
7+
START="java -Xincgc -Xms3024M -jar server.jar" # Startup command for your server
8+
PREFIX="[EndServ]" # Prefix of the sh EndServ script
9+
cd "/home/minecraft/demo/" # Emplacement de votre serveur minecraft conseillé "(~/home/minecraft/server_name/"
10+
11+
isrunning(){
12+
if ! screen -list | grep -q "$SCREEN"
13+
then
14+
return 1
15+
else
16+
return 0
17+
fi
18+
}
19+
20+
case "$1" in
21+
version)
22+
echo "
23+
$PREFIX is a creation of EndMove
24+
You are using version: v1.0.0
25+
"
26+
;;
27+
28+
start)
29+
if ( isrunning )
30+
then
31+
echo "$PREFIX : Server ($NAME) is already running!"
32+
else
33+
echo "$PREFIX : Starting server ($NAME)..."
34+
screen -dmS $SCREEN $START
35+
fi
36+
;;
37+
38+
status)
39+
if ( isrunning )
40+
then
41+
echo "$PREFIX : Server ($NAME) is running."
42+
else
43+
echo "$PREFIX : Server ($NAME) is not running."
44+
fi
45+
;;
46+
47+
screen)
48+
screen -r $SCREEN
49+
;;
50+
51+
reload)
52+
screen -S $SCREEN -p 0 -X stuff `printf "reload\r"`
53+
echo "$PREFIX : Server ($NAME) will be restarted."
54+
;;
55+
56+
stop)
57+
if ( isrunning )
58+
then
59+
screen -S $SCREEN -p 0 -X stuff `printf "stop\r"`
60+
echo "$PREFIX : Stopping server ($NAME)."
61+
else
62+
echo "$PREFIX : Server ($NAME) is not running!"
63+
fi
64+
;;
65+
66+
*)
67+
echo "$PREFIX Usage : {start|stop|status|screen|reload|version|help}"
68+
;;
69+
esac
70+
71+
exit 0

demo/eula.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
eula=true

demo/server.jar

31 MB
Binary file not shown.

0 commit comments

Comments
 (0)