Minetest is an open source voxel game engine with easy modding and game creation
Go to file
2023-12-16 12:51:42 +01:00
.github Hash-check buildbot dependencies 2023-12-15 10:23:52 +01:00
android Continue with 5.9.0-dev 2023-12-04 17:15:43 +00:00
builtin Add sound volume when unfocused setting (#14083) 2023-12-10 19:11:39 +01:00
client Allow the server to control fog_distance and fog_start via the sky-api (#13448) 2023-06-30 19:11:17 -07:00
clientmods/preview Add minetest.settings to CSM API and allow CSMs to provide settingtypes.txt (#12131) 2022-08-02 11:58:08 +02:00
cmake/Modules Android build via CMake (#13528) 2023-05-26 15:21:23 +02:00
doc Remove use_texture_alpha compatibility code for nodeboxes & meshes (#13929) 2023-12-13 13:15:59 +01:00
fonts Fully remove bitmap font support (#11863) 2022-01-08 14:53:25 +01:00
games/devtest Fix unittest failure for release versions (#14067) 2023-12-08 21:13:33 +01:00
lib Remove trailing whitespace (#13505) 2023-05-18 20:34:18 +02:00
misc Bump version to 5.8.0 2023-12-04 17:15:36 +00:00
mods Remove trailing whitespace (#13505) 2023-05-18 20:34:18 +02:00
po Run updatepo.sh 2023-12-03 18:48:54 +01:00
src Change MapBlock content cache to a vector 2023-12-16 12:51:42 +01:00
textures Add package update detection on Content tab (#13807) 2023-10-28 17:33:44 +01:00
util Hash-check buildbot dependencies 2023-12-15 10:23:52 +01:00
worlds Add a worlds_here.txt file in the worlds folder and update .gitignore (#12720) 2022-10-30 16:53:31 +01:00
.clang-tidy Update clang-tidy configuration and scripts 2020-03-12 00:10:09 +01:00
.dockerignore fix: don't send the whole local context to the docker image 2021-04-02 14:40:22 +02:00
.editorconfig Settings GUI: Add setting dependencies (#13704) 2023-08-05 17:55:27 +01:00
.gitattributes .gitattributes 2011-08-11 17:57:40 +02:00
.gitignore Add .fleet folder to gitignore (#13611) 2023-06-20 22:00:15 +07:00
.gitlab-ci.yml Debundle Minetest Game (#13818) 2023-11-07 22:18:26 +01:00
.luacheckrc Rewrite the gamebar (#13768) 2023-09-02 23:02:02 +02:00
.mailmap Update credits tab and mailmap 2023-03-29 23:19:11 +02:00
CMakeLists.txt Improve Irrlicht instructions (#14055) 2023-12-08 21:11:54 +01:00
CNAME Build MkDocs Lua API docs using GitHub CI, deploy to api.minetest.net (#13675) 2023-09-18 19:17:18 +03:00
COPYING.LESSER Added copy of LGPL-2.1 (#12950) 2022-11-16 13:09:53 -05:00
Dockerfile Debundle Minetest Game (#13818) 2023-11-07 22:18:26 +01:00
LICENSE.txt Add package update detection on Content tab (#13807) 2023-10-28 17:33:44 +01:00
minetest.conf.example Update from builtin/settingtypes.txt 2023-12-03 18:47:50 +01:00
README.md Debundle Minetest Game (#13818) 2023-11-07 22:18:26 +01:00

Minetest

Build Status Translation status License

Minetest is a free open-source voxel game engine with easy modding and game creation.

Copyright (C) 2010-2022 Perttu Ahola celeron55@gmail.com and contributors (see source file comments and the version control log)

Table of Contents

  1. Further Documentation
  2. Default Controls
  3. Paths
  4. Configuration File
  5. Command-line Options
  6. Compiling
  7. Docker
  8. Version Scheme

Further documentation

Default controls

All controls are re-bindable using settings. Some can be changed in the key config dialog in the settings tab.

Button Action
Move mouse Look around
W, A, S, D Move
Space Jump/move up
Shift Sneak/move down
Q Drop itemstack
Shift + Q Drop single item
Left mouse button Dig/punch/use
Right mouse button Place/use
Shift + right mouse button Build (without using)
I Inventory menu
Mouse wheel Select item
0-9 Select item
Z Zoom (needs zoom privilege)
T Chat
/ Command
Esc Pause menu/abort/exit (pauses only singleplayer game)
+ Increase view range
- Decrease view range
K Enable/disable fly mode (needs fly privilege)
J Enable/disable fast mode (needs fast privilege)
H Enable/disable noclip mode (needs noclip privilege)
E Aux1 (Move fast in fast mode. Games may add special features)
C Cycle through camera modes
V Cycle through minimap modes
Shift + V Change minimap orientation
F1 Hide/show HUD
F2 Hide/show chat
F3 Disable/enable fog
F4 Disable/enable camera update (Mapblocks are not updated anymore when disabled, disabled in release builds)
F5 Cycle through debug information screens
F6 Cycle through profiler info screens
F10 Show/hide console
F12 Take screenshot

Paths

Locations:

  • bin - Compiled binaries
  • share - Distributed read-only data
  • user - User-created modifiable data

Where each location is on each platform:

  • Windows .zip / RUN_IN_PLACE source:
    • bin = bin
    • share = .
    • user = .
  • Windows installed:
    • bin = C:\Program Files\Minetest\bin (Depends on the install location)
    • share = C:\Program Files\Minetest (Depends on the install location)
    • user = %APPDATA%\Minetest or %MINETEST_USER_PATH%
  • Linux installed:
    • bin = /usr/bin
    • share = /usr/share/minetest
    • user = ~/.minetest or $MINETEST_USER_PATH
  • macOS:
    • bin = Contents/MacOS
    • share = Contents/Resources
    • user = Contents/User or ~/Library/Application Support/minetest or $MINETEST_USER_PATH

Worlds can be found as separate folders in: user/worlds/

Configuration file

  • Default location: user/minetest.conf
  • This file is created by closing Minetest for the first time.
  • A specific file can be specified on the command line: --config <path-to-file>
  • A run-in-place build will look for the configuration file in location_of_exe/../minetest.conf and also location_of_exe/../../minetest.conf

Command-line options

  • Use --help

Compiling

Docker

We provide Minetest server Docker images using the GitLab mirror registry.

Images are built on each commit and available using the following tag scheme:

  • registry.gitlab.com/minetest/minetest/server:latest (latest build)
  • registry.gitlab.com/minetest/minetest/server:<branch/tag> (current branch or current tag)
  • registry.gitlab.com/minetest/minetest/server:<commit-id> (current commit id)

If you want to test it on a Docker server you can easily run:

sudo docker run registry.gitlab.com/minetest/minetest/server:<docker tag>

If you want to use it in a production environment you should use volumes bound to the Docker host to persist data and modify the configuration:

sudo docker create -v /home/minetest/data/:/var/lib/minetest/ -v /home/minetest/conf/:/etc/minetest/ registry.gitlab.com/minetest/minetest/server:master

Data will be written to /home/minetest/data on the host, and configuration will be read from /home/minetest/conf/minetest.conf.

Note: If you don't understand the previous commands please read the official Docker documentation before use.

You can also host your Minetest server inside a Kubernetes cluster. See our example implementation in misc/kubernetes.yml.

Version scheme

We use major.minor.patch since 5.0.0-dev. Prior to that we used 0.major.minor.

  • Major is incremented when the release contains breaking changes, all other numbers are set to 0.
  • Minor is incremented when the release contains new non-breaking features, patch is set to 0.
  • Patch is incremented when the release only contains bugfixes and very minor/trivial features considered necessary.

Since 5.0.0-dev and 0.4.17-dev, the dev notation refers to the next release, i.e.: 5.0.0-dev is the development version leading to 5.0.0. Prior to that we used previous_version-dev.