Minecraft server

From miki
Jump to navigation Jump to search

Links

Servers [1]
The original server from Mojang.
The most popular server
Server API (don't know what it means exactly)
  • Sponge, A community-driven open source Minecraft modding platform. More here.
Server-side tools (for large servers)
Spigot/Bukkit plugins
  • See section below.
Forge/Cauldron mods
  • See section below.
Free Minecraft server

Installation log

Installation

Must install

  • A Minecraft server. This can be either Minecraft vanilla, Bukkit, CraftBukkit, Spigot, Forge, Cauldron...
  • A startup/backup script.
  • In case of Bukkit/Spigot/Cauldron, one or several plugins.
  • In case of Forge/Cauldron, one or several mods.

Spigot

Spigot is an optimized Craftbukkit server. This is the server I used for Minecraft 1.12.2, then upgraded to Minecraft 1.15.2 on our home server.

Following Spigot BuildTools guide:

mkdir spigot_buildtools
cd spigot_buildtools
wget https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar
git config --global --unset core.autocrlf
java -jar BuildTools.jar
Minecraft 1.15.2

The procedure is mostly the same, except that it only produces a single file (spigot-1.15.2.jar). The other file was only produced as an alternative to Spigot (in case of uncompatibility), and hence are not necessary.

When the build is complete, we copy spigot-1.15.2.jar and rename it to spigot.jar (we also delete the obsolete craftbukkit.jar).

Minecraft 1.12.2

This creates 2 jar files: craftbukkit-1.12.2.jar and spigot-1.12.2.jar.

Then follow install instructions [2]:

  • Copy craftbukkit-1.12.2.jar and spigot-1.12.2.jar in a directory dedicated to the minecraft server, and rename to craftbukkit.jar and spigot.jar.
  • Start the server with:
java -Xms1G -Xmx1G -XX:+UseConcMarkSweepGC -jar spigot.jar

More links (used for Spigot on Raspberry Pi):

PaperMC

PaperMC is recent alternative to Spigot and Craftbukkit, touted as superfast.

It is recommended by EssentialX plugin [3].

Not tried yet.

CraftBukkit

Recommended line for starting CraftBukkit [4]:

java -d64 -Xincgc -Xmx1024M -jar craftbukkit.jar nogui

Cauldron and Forge

Cauldron is the new name of MCPC+, ie. basically Spigot + Forge API. Cauldron allows for running servers using both CraftBukkit plugins and Forge mods (like Mo'Creatures). I used Cauldron as Minecraft server up to Minecraft 1.7.2/1.7.10.

  • Best way for installing is to run the Cauldron installer (see download page)
  • When launched, it runs like a standard Spigot / Craftbukkit server.

Configuration

server.properties

See server.properties.

  • server message (including formatting).
motd=\u00A7c-=\u00A76Welcome to \u00A7lI.M.M.I.E\u00A7r\u00A7c=-

Server icon

Simply create a 64x64 PNG file and save it as file server-icon.png in server folder root [5]

Bukkit / Spigot plugins

Plugins greatly enhanced the gameplay and provide many new features. Here some links where we can download plugins:

Often times plugins are available both on Spigot and Bukkit site. It is interesting to view both pages as they might contain different information (and even sometimes different versions!).

Below I list some plugins. Plugins in bold are those I'm currently using; in that case, they are prefixed with the minecraft version (e.g. (mc 1.12.2) or (mc 1.15.2)). Stroke through are plugins that are no longer available. (Try me) indicates very promising plugins I need to try some day.

World management
  • (mc 1.12.2, 1.15.2) Multiverse [6]
Multiverse is the most popular multi-world plugin for minecraft server.
  • (mc 1.12.2, 1.15.2) Multiverse Core [7], the main plugin. Compatible Bukkit 1.12 & 1.15.
  • (mc 1.12.2, 1.15.2) Multiverse Portals [8], to get portals. Compatible Bukkit 1.12 & 1.15.
  • (mc 1.12.2, 1.15.2) Multiverse Nether Portals [9], to get portals to the nether. Compatible Bukkit 1.12 & 1.15.
  • (mc 1.15.2) Multiverse Sign Portals [10], to edit nether portals with sign or use signs as portals. Compatible Bukkit 1.15.
  • (mc 1.12.2, 1.15.2) Per World Inventory [11], to manage inventories. This replace the old multiverse-inventory plugin. Compatible Bukkit 1.12, and 1.14 (not 1.15 so far, problem?).
Essential / permission
An up-to-date fork of Essentials. Provide basic (but usually good enough) support for permissions, spawn, chat, signs, economy, group manager. Compatible Bukkit 1.12. Also essentialsx here. It requires the Vault plugin.
Not sure what is the difference with other permission plugins (like PermissionEx).
All essentials plugins must have matching version. I downloaded them from the Jenkins build, except Group Manager that is available separately.
  • (mc 1.12.2, 1.15.2) EssentialsX Chat (Install jenkins build)
  • (mc 1.12.2, 1.15.2) EssentialsX Spawn (Install jenkins build)
  • (mc 1.12.2, 1.15.2) EssentialsX Group Manager [13] (available separately, must match version though).
  • (mc 1.12.2, 1.15.2) Vault [14]. Seems to federate all permission-related plugins. Compatible Bukkit 1.11.
  • Essential [15]. Original plugin. Seems outdated.
Creative
  • (mc 1.12.2) WorldEdit [16], an easy-to-use in-game editor. Compatible Bukkit 1.12.
Crashed twice on me in Spigot 1.12.2. Time to look for alternatives? Switched to FAWS.
  • (mc 1.12.2, 1.15.2) Fast Async World Edit (FAWE) [17] (wiki).
  • AsyncWorldEdit [18], an alternative to WorldEdit.
  • (mc 1.12.2, 1.15.2) PlotSquared [19], compatible 1.12, is a more up-to-date version of PlotMe (mc 1.8.1).
Economy
  • iConomy is discontinued.
  • (mc 1.12.2, 1.15.2) EssentialX [20]. Provide basic support for economy. See Essential Economy.
  • (mc 1.12.2) CraftConomy [21], can use MySQL and suited to multiserver. Compatible 1.12, actively maintained. Installed in parallel of Essential.
  • (mc 1.15.2) The New Economy [22]. A new economy plugin compatible with 1.15 (seen here).
Economy-related
  • (mc 1.12.2, 1.15.2) Jobs reborn [23]
  • (mc 1.12.2, 1.15.2) Time is Money [24]
  • (Try me) Mobs hunting [25]. Looks really interesting, but maybe redundant with Jobs.
  • KillerMoney [26]. Some simple mob-kill reward plugin.
Essential
Commands
  • (mc 1.12.2, 1.15.2) CommandSign [27] (wiki).
  • To create a block, must right-click with empty hand on the block we want to add the command to.
  • The same applies for copying a block. We must right click with an empty hand.
  • Another command-sign plugin.
Factions
  • (mc 1.12.2, no version for 1.15.2) Factions [28]. Also here.
Anti-grief
  • (mc 1.12.2, no version for 1.15.2) CreeperHeal [29]

Plugin to consider installing:

Plugins I installed in older bukkit server but that are no longer maintained / useful:

Mods

Mod to try on the server:

Installation - Minecraft <= 1.7.10

Start / stop init script

Forge mods

Use Cauldron + forge to run a server that accepts both CraftBukkit plugins and Forge mods

Supported mods
  • Mo' creatures v6.2.0 R2
Simply install the mods in minecraft server mod directory (./mods)

CraftBukkit Troubleshoot

Essentials / permissions debug

To debug permission issues easily, set plugins/Essentials/config.yml:

# More output to the console.
debug: true

Cannot start the server

  • I had issue due to jline, which was parsing my /root/.inputrc file!!!
$ java -jar craftbukkit.jar help
229 recipes
27 achievements
Jul 10, 2013 3:00:24 AM net.minecraft.server.v1_5_R3.MinecraftServer main
SEVERE: Failed to start the minecraft server
java.lang.IllegalArgumentException: No enum constant org.bukkit.craftbukkit.libs.jline.console.Operation.DYNAMIC_COMPLETE_HISTORY
	at java.lang.Enum.valueOf(Enum.java:236)
	at org.bukkit.craftbukkit.libs.jline.console.Operation.valueOf(Operation.java:24)
	at org.bukkit.craftbukkit.libs.jline.console.ConsoleKeys.loadKeys(ConsoleKeys.java:245)
	at org.bukkit.craftbukkit.libs.jline.console.ConsoleKeys.loadKeys(ConsoleKeys.java:71)
	at org.bukkit.craftbukkit.libs.jline.console.ConsoleKeys.<init>(ConsoleKeys.java:43)
	at org.bukkit.craftbukkit.libs.jline.console.ConsoleReader.<init>(ConsoleReader.java:146)
	at org.bukkit.craftbukkit.libs.jline.console.ConsoleReader.<init>(ConsoleReader.java:126)
	at net.minecraft.server.v1_5_R3.MinecraftServer.<init>(MinecraftServer.java:106)
	at net.minecraft.server.v1_5_R3.DedicatedServer.<init>(DedicatedServer.java:34)
	at net.minecraft.server.v1_5_R3.MinecraftServer.main(MinecraftServer.java:653)
	at org.bukkit.craftbukkit.Main.main(Main.java:152)

The solution was simply to remove the binding to dynamic-complete-history in the .inputrc file.

Wrong plugin version

  • The following message indicates a mismatch between server and plugin version:
01:14:18 CONSOLE: [WARNING] WorldEdit: Failed to do NMS safe block set

Frequent disconnect

Getting frequently disconnect from server, with message:

lost connection: Internal Exception: io.netty.handler.timeout.ReadTimeoutException 

See https://bugs.mojang.com/browse/MC-34947

Possible causes
  • Java garbage collector on the server taking too much time.
  • Server triggering disconnects on the client side when loading/generating new chunks.
  • Related to a save spike [31]
  • Related to file data/Mineshaft.dat taking too much CPU
  • At the same time, I had lot of connection loss on the wifi (mandala laptop). Could this be related?
Possible fixes
  • Restart the server
  • Install Oracle Java 7 on the server
  • Change the GC settings [32]. Use -XX:+UseG1GC instead of -XX:MaxGCPauseMillis=200:
java -XX:+UseG1GC -jar minecraft_server.jar nogui
  • Tweak connection mtu settings [33]:
netsh interface ipv4 set subinterface "Local Area Connection" mtu=750 store=persistent
  • rename data/Mineshaft.dat to data/Mineshaft.old
  • upgrade to 1.7.10

Maintenance

CraftBukkit server

  • Clear server log
Use LogManager: /logclear
  • Clear core-protect db.
On the console, /co purge t:7d (only data older than 24h can be purged from the console)
In game, /co purge t:30d (only data older than 30 days can be purged from in-game)

CraftBukkit Plugins

A small plugin to clear the server log from in-game, w/o need to restart the server (/logclear)
This plugin allows for preventing / controling explosion.
# Enable TNT explosion as follows (note that tnt chain are allowed by default)
/acs tnt yield 80              # 80% of exploded blocks will be available back
/acb tnt damage player true    # TNT will damage players...
/acb tnt damage mob true       # ... and mobs
/acb tnt explodeblocks true    # TNT will explode neighbouring blocks
# To protect a zone against TNT (even via TNT cannon)
/rg flag spawn tnt deny
  • DynMap
  • AntiBotUltra
    • Edit plugins/AntiBotUltra/config.yml to change the white list message (use § for colors)
  • AntiCheat
    Problem with these statistical tool is that they only detect after damage is done (all diamonds have been removed), and that they require administration effort.
    Nice analysis of pro and con of other anti-X-ray tools (statistical, obfuscator), and how to detect xraying users.

Basic commands

tphere <PLAYER>
changepw <oldpwd> <newpwd>

Give commands

Give an enchanted object (see Enchanting/ID).

# Give an enchanted sword
/give John diamond_sword 1 0 {ench:[{id:16,lvl:5}]}

# Give an enchanted book
/give @p enchanted_book 1 0 {StoredEnchantments:[{id:16,lvl:2}]}

Essentials

kits

To enable kits via signs, give to user the following permissions:

essentials.signs.kit.use
essentials.kits.<kitname>

To enable kits via /kit command, give the following permissions to the users:

essentials.kit
essentials.kits.<kitname>

Multiverse

Permissions
/manuadd histerical Default plotworld           # Change group of a user in a given world
Set world difficulty
/mvmodify set ?                               # Get help
/mvm set ?                                    # Same, shorter
/mvm set difficulty PEACEFUL
/mvm set mode CREATIVE world                  # Can modify any world

This setting has precedence over server setting. To change server setting, edit file Server.properties on the server:

spawn-monsters=false
Prevent spawning
/mvmodify set monsters false                    # Prevent monsters spawning
/mvmodify set animals false                     # Prevent animals spawning
Set spawn for current world
/mv set spawn
Create a portal

To create a portal, first create a selection containing a portal frame, then create the portal with /mpc.

/mvpc portal_name                 # Create a portal named 'portal_name'
/mvpm dest world_name             # Set the destination of current portal to spawn of world 'world_name'
/mvpm dest p:dest_portal_name     # Set the destination of current portal to portal dest_portal_name
/mvpm dest p:dest_portal_name:n   # Set the destination of current portal to portal dest_portal_name, changing player direction to 'north'
/mvpm dest p:dest_portal_name:s   # Set the destination of current portal to portal dest_portal_name, changing player direction to 'south'
/mvpm dest p:dest_portal_name:e   # Set the destination of current portal to portal dest_portal_name, changing player direction to 'east'
/mvpm dest p:dest_portal_name:w   # Set the destination of current portal to portal dest_portal_name, changing player direction to 'west'
/mvp sel portal_name              # Select portal 'portal_name' as current portal
/mvp remove portal_name           # Destroy portal 'portal_name'
Create inventory group ([35])
/mvinv group                      # Interactive command
Create
emma_survival                     # Create the group, named 'emma_survival'
emma_survival                     # We add the three following worlds
emma_survival_nether
emma_survival_end
@
all                               # We add all shares (so all is shared, inventory, money...)
@

WorldEdit

Reference: FAWS commands, WorldEdit

# Selection
//wand                            # Give the user the editing wand (axe)
//sel                             # Clear selection
//sel cuboid                      # Default mode, ie. cuboid: L click: 1st point, R click: 2nd point
//sel extend                      # Enable extend mode: L click: start, R click: extend cuboid
# More //sel mode available. Type //sel ? to see
//chunk                           # Select the entire chunk

# Selection modification
outset 30 -h                      # Extend selection in all direction horizontally
shift 1 up                        # Shift selection 1 block up

# Basic edit
//set [id]                        # Fill selection with block 'id' (numeric or block name)
//set 80%stone,20%cobble          # Idem, with fill percentage
//set 0                           # Fill with air
//replace [idfrom] [idto]         # Replace given block id with given block id
//outline [id]                    # Set outline
//walls [id]                      # Set walls
//undo                            # Undo edition
//redo                            # Redo edition

# Masked edit
//gmask 0                         # Only affect 0/air blocks
//set stone
//gmask                           # Reset global mask

# Copy / Paste
//copy                            # Copy selection
//paste                           # Paste selection
//rotate [angle]
//flip [direction]

# Schematics (save/load to disk)
//copy
//schem save mcedit filename      # This save file to plugics/WorldEdit/Schematics
//schem load mcedit filename      # This load file from plugics/WorldEdit/Schematics
//paste                           # Paste loaded schematics

# Brush
//brush clipboard [-a]            # Paint with the clipboard. -a to append, not pasting air.
# ...

# Shape generation
# ...

# Utility
//fill id [radius] [depth]        # Fill an area with block 'id', up to 'radius' and depth 'depth'
//fixlava                         # Levels out nearby lava pool
//fixwater                        # Levels out nearby water pool
//thaw                            # Remove snow
/ex [size]/[size]                 # Extinguish fire
//drain                           # Drains all nearby pools of laval or water
//green                           # Greens the area by adding grass to dirt

# Maintenance
//regen                           # Revert selected area to original seed blocks

PlotSquared

Wiki: https://github.com/IntellectualSites/PlotSquared/wiki

/plot merge                 # Merge all neighbours plot (must be claimed beforehand)
                            # !!! DISPOSE now will delete ALL merged plots
/plot unlink                # Unmerge

dynmap

Render the maps
  • Do /dynmap fullrender world to start rendering of world world.
  • Do /dynmap cancelrender world to cancel rendering.
View maps

How-to

Import a single-player world

Import a single player world
  • Copy SP world to say ./world_singleplayer
  • You need to guess the world environment (usually either NORMAL or FLAT) and if needed the generator used (see doc for more information).
To get the list of available environment:
/mv env
  • In the server:
/mv import world_singleplayer NORMAL         # Import with default generator
/mv import world_singleplayer NORMAL FLAT    # Import with FLAT generator

Create PlotMe world

/mv create plotworld normal -g PlotMe           # Must use 'plotworld', or see PlotMe/config.yml
/mangaddp Default creativegates.use             # In the PlotMe world, or user can't use creative gates anymore
/mangaddp Default plotme.use                    # Give user access to plotme commands
/mangaddp Default plotme.limit.1                # Limit to 1 plot / user
/plotme weanywhere                              # To use worldedit anywhere (protection against grief)
/mvm set monsters false                         # To prevent mobs spawning
/mvm set animals false                          # To prevent animals spawning

Edit file plugins/Multiverse-Core/config.yml:

  prefixchat: 'false'

Summon any horses

From [36].

/summon EntityHorse ~0 ~1 ~0
/summon EntityHorse ~0 ~1 ~0 {Tame:1}
/summon EntityHorse ~0 ~1 ~0 {Type:4,Tame:1}                      # Type: 0 to 4
/summon EntityHorse ~0 ~1 ~0 {Type:0,Tame:1,SaddleItem:{id:329}}  # 
/summon EntityHorse ~0 ~1 ~0 {Type:1,Tame:1,SaddleItem:{id:329},ChestedHorse:1}
/summon EntityHorse ~ ~1 ~ {Type:0,Tame:1,SaddleItem:{id:329},ArmorItem:{id:417}}     # ArmorItem: 417 to 419
/summon EntityHorse ~ ~1 ~ {Type:0,Tame:1,Variant:0}              # Variant: 0..6, 256..262, 512..528, 768..774, 1024..1030

Convert PlotMe to PlotSquared

I installed a brand new Spigot server, and wanted to import an old PlotMe world. Here's what I did:

  • Copy the world directory plotworld/ from old server to the new server.
  • Copy the PlotMe configuration directory plugins/PlotMe/ from old server to the new server.
  • Delete PlotSquared configuration directory plugins/PlotSquared/.
  • Start the server.

The conversion started automatically. Here's the log after conversion occured:

[20:13:47 INFO]: Using connector: com.plotsquared.bukkit.database.plotme.ClassicPlotMeConnector
[20:13:47 INFO]: PlotMe->PlotSquared: PlotMe conversion has started. To disable this, please set 'enabled-components -> plotme-converter' to false in the 'settings.yml'
[20:13:47 INFO]: PlotMe->PlotSquared: Connecting to PlotMe DB
[20:13:47 INFO]: PlotMe->PlotSquared: Collecting plot data
[20:13:47 INFO]: PlotMe->PlotSquared:  - plotmePlots
[20:13:47 INFO]: PlotMe->PlotSquared: Updating bukkit.yml
[20:13:47 INFO]: PlotMe->PlotSquared: Copying config for: plotworld
[20:13:47 INFO]:  - plotmeDenied
[20:13:47 INFO]: PlotMe->PlotSquared:  - plotmeAllowed
[20:13:47 INFO]: PlotMe->PlotSquared: Collected 29 plots from PlotMe
[20:13:47 INFO]: PlotMe->PlotSquared: Creating plot DB
[20:13:48 INFO]: PlotMe->PlotSquared: Saving configuration...
[20:13:48 INFO]: === IMPORTANT ===
[20:13:48 INFO]: THIS MESSAGE MAY BE EXTREMELY HELPFUL IF YOU HAVE TROUBLE CONVERTING PlotMe!
[20:13:48 INFO]:  - Make sure 'UUID.read-from-disk' is disabled (false)!
[20:13:48 INFO]:  - Sometimes the database can be locked, deleting PlotMe.jar beforehand will fix the issue!
[20:13:48 INFO]:  - After the conversion is finished, please set 'plotme-converter' to false in the 'settings.yml'
[20:13:48 INFO]: PlotMe->PlotSquared: Invalid world in PlotMe configuration: plotworld
[20:13:48 INFO]: PlotMe->PlotSquared: Please wait until database conversion is complete. You will be notified with instructions when this happens!
[20:13:49 INFO]: Batch 1: 29 | com.intellectualcrafters.plot.object.Plot
[20:13:49 INFO]: Batch 1: 29 | com.intellectualcrafters.plot.database.SQLManager.SettingsPair
[20:13:49 INFO]: PlotMe->PlotSquared: Database conversion is now complete!
[20:13:49 INFO]:  - Stop the server
[20:13:49 INFO]:  - Disable 'plotme-converter' and 'plotme-convert.cache-uuids' in the settings.yml
[20:13:49 INFO]:  - Correct any generator settings that haven't copied to 'settings.yml' properly
[20:13:49 INFO]:  - Start the server

Then

  • stop the server,
  • In plugins/PlotSquared/config/Settings.yml, set plotme-converter to false
  • Start the server
  • Import the world with mv import plotworld normal -g PlotSquared

Convert an old world

Importing old world in recent Minecraft version generates many glitches when exploring unvisited part of the map.

See this guide for tips on how to convert these worlds.