Skip to content

Commit 8e15179

Browse files
committedMar 3, 2014
Document CMake options in README
1 parent 3e52dd5 commit 8e15179

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed
 

‎README.txt

+67
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,73 @@ $ ./minetest
113113
- Debug build is slower, but gives much more useful output in a debugger
114114
- If you build a bare server, you don't need to have Irrlicht installed. In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source
115115

116+
CMake options
117+
-------------
118+
General options:
119+
120+
BUILD_CLIENT - Build Minetest client
121+
BUILD_SERVER - Build Minetest server
122+
CMAKE_BUILD_TYPE - Type of build (Release vs. Debug)
123+
Release - Release build
124+
Debug - Debug build
125+
RelWithDebInfo - Release build with Debug information
126+
MinSizeRel - Release build with -Os passed to compiler to make executable as small as possible
127+
ENABLE_CURL - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
128+
ENABLE_FREETYPE - Build with Freetype2; Allows using TTF fonts
129+
ENABLE_GETTEXT - Build with Gettext; Allows using translations
130+
ENABLE_GLES - Search for Open GLES headers & libraries and use them
131+
ENABLE_LEVELDB - Build with LevelDB; Enables use of LevelDB, which is much faster than SQLite, as map backend
132+
ENABLE_SOUND - Build with OpenAL, libogg & libvorbis; in-game Sounds
133+
DISABLE_LUAJIT - Do not search for LuaJIT headers & library
134+
RUN_IN_PLACE - Create a portable install (worlds, settings etc. in current directory)
135+
USE_GPROF - Enable profiling using GProf
136+
VERSION_EXTRA - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
137+
138+
Library specific options:
139+
140+
BZIP2_INCLUDE_DIR - Linux only; directory where bzlib.h is located
141+
BZIP2_LIBRARY - Linux only; path to libbz2.a/libbz2.so
142+
CURL_DLL - Only if building with cURL on Windows; path to libcurl.dll
143+
CURL_INCLUDE_DIR - Only if building with cURL; directory where curl.h is located
144+
CURL_LIBRARY - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
145+
EGL_INCLUDE_DIR - Only if building with GLES; directory that contains egl.h
146+
EGL_egl_LIBRARY - Only if building with GLES; path to libEGL.a/libEGL.so
147+
FREETYPE_INCLUDE_DIR_freetype2 - Only if building with Freetype2; directory that contains an freetype directory with files such as ftimage.h in it
148+
FREETYPE_INCLUDE_DIR_ft2build - Only if building with Freetype2; directory that contains ft2build.h
149+
FREETYPE_LIBRARY - Only if building with Freetype2; path to libfreetype.a/libfreetype.so/freetype.lib
150+
GETTEXT_DLL - Only when building with Gettext on Windows; path to libintl3.dll
151+
GETTEXT_ICONV_DLL - Only when building with Gettext on Windows; path to libiconv2.dll
152+
GETTEXT_INCLUDE_DIR - Only when building with Gettext; directory that contains iconv.h
153+
GETTEXT_LIBRARY - Only when building with Gettext on Windows; path to libintl.dll.a
154+
GETTEXT_MSGFMT - Only when building with Gettext; path to msgfmt/msgfmt.exe
155+
IRRLICHT_DLL - path to Irrlicht.dll
156+
IRRLICHT_INCLUDE_DIR - directory that contains IrrCompileConfig.h
157+
IRRLICHT_LIBRARY - path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a
158+
LEVELDB_INCLUDE_DIR - Only when building with LevelDB; directory that contains db.h
159+
LEVELDB_LIBRARY - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll
160+
LUA_INCLUDE_DIR - Only if you want to use LuaJIT; directory where luajit.h is located
161+
LUA_LIBRARY - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
162+
MINGWM10_DLL - Only if compiling with MinGW; path to mingwm10.dll
163+
OGG_DLL - Only if building with sound on Windows; path to libogg.dll
164+
OGG_INCLUDE_DIR - Only if building with sound; directory that contains an ogg directory which contains ogg.h
165+
OGG_LIBRARY - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
166+
OPENAL_DLL - Only if building with sound on Windows; path to OpenAL32.dll
167+
OPENAL_INCLUDE_DIR - Only if building with sound; directory where al.h is located
168+
OPENAL_LIBRARY - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
169+
OPENGLES2_INCLUDE_DIR - Only if building with GLES; directory that contains gl2.h
170+
OPENGLES2_gl_LIBRARY - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
171+
SQLITE3_INCLUDE_DIR - Only if you want to use SQLite from your OS; directory that contains sqlite3.h
172+
SQLITE3_LIBRARY - Only if you want to use the SQLite from your OS; path to libsqlite3.a/libsqlite3.so
173+
VORBISFILE_DLL - Only if building with sound on Windows; path to libvorbisfile-3.dll
174+
VORBISFILE_LIBRARY - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
175+
VORBIS_DLL - Only if building with sound on Windows; path to libvorbis-0.dll
176+
VORBIS_INCLUDE_DIR - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
177+
VORBIS_LIBRARY - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
178+
XXF86VM_LIBRARY - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
179+
ZLIB_DLL - Only on Windows; path to zlibwapi.dll
180+
ZLIB_INCLUDE_DIR - directory where zlib.h is located
181+
ZLIB_LIBRARY - path to libz.a/libz.so/zlibwapi.lib
182+
116183
Compiling on Windows:
117184
---------------------
118185
- This section is outdated. In addition to what is described here:

0 commit comments

Comments
 (0)
Please sign in to comment.