Skip to content
This repository
Newer
Older
100644 135 lines (86 sloc) 5.086 kb
21b3239d »
2010-11-09 README cleanup
1 # Mineserver
9a6336c9 »
2010-11-23 Readme changes
2 *by Fador & Nredor and others*
3
67b47be4 »
2012-04-06 Update README.md
4 Custom Minecraft server software written in C++.
5
6 You can find the core team from #mineserver @ irc.freenode.net Also mail to developers@mineserver.be will reach us.
bb280524 »
2010-11-09 Changed .rst to .md -_-
7
1a7f98e4 »
2013-03-14 1.5 updates (Open Window 0x64 packet changed and moved to protocol.h)
8 Copyright (c) 2010-2013, The Mineserver Project
bb280524 »
2010-11-09 Changed .rst to .md -_-
9
67b47be4 »
2012-04-06 Update README.md
10 **NOTICE:** Server still lacks features compared to original minecraft server.
11
b9a66ad1 »
2011-01-13 Working Python!
12
e888de6e »
2012-04-03 Update README.md
13 **Supported platforms**
fcef8d87 »
2011-01-15 Reverted Readme file
14
7df6efe3 »
2011-03-02 update readme a bit
15 * Linux
eb195c9b »
2012-04-04 Some small changes.
16 * Windows (VS2010 project included)
e888de6e »
2012-04-03 Update README.md
17
18 Server has also been tested to build on Mac OS X and FreeBSD/PCBSD but we do not officially support those.
fcef8d87 »
2011-01-15 Reverted Readme file
19
20 We are trying to minimize memory and CPU usage compared to original Java server.
21
47d03768 »
2011-05-28 Clarified language and library dependences a bit.
22 *Important:* The language is C++98 with STL/TR1 library support, so you will need a reasonably modern
18ce38b3 »
2011-05-28 Markdown bug.
23 C++ compiler. MS Visual C++ 10 and GCC 4.4 should be sufficient. The build system requires [cmake](http://www.cmake.org/).
47d03768 »
2011-05-28 Clarified language and library dependences a bit.
24
e6c88d7d »
2012-08-03 Added openssl to the CMakeLists.txt and edited the readme a bit
25
26 ### Supported Minecraft version
27
cb413419 »
2013-06-30 Updated README to say we support 1.5.2
28 * Working with 1.5.2 client (protocol 61)
e6c88d7d »
2012-08-03 Added openssl to the CMakeLists.txt and edited the readme a bit
29
8777d401 »
2011-03-01 Updated readme
30 ### Features
47d03768 »
2011-05-28 Clarified language and library dependences a bit.
31
8777d401 »
2011-03-01 Updated readme
32 * Plugins (chatcommands, filelog, nether, passivemobs, etc..)
fcef8d87 »
2011-01-15 Reverted Readme file
33 * NBT parsing/saving
34 * Lightmap generation
35 * Config file
36 * Normal mining/item spawning/item pickups
37 * Basic physics for gravel and sand
8777d401 »
2011-03-01 Updated readme
38 * Physics for water (currently revising this)
39 * Flatland and terrain map generation (Also biomegen!)
fcef8d87 »
2011-01-15 Reverted Readme file
40 * Working chests, furnaces & signs
41e827b8 »
2012-08-08 Added threaded user validation
41 * User validation from minecraft.net
1a7f98e4 »
2013-03-14 1.5 updates (Open Window 0x64 packet changed and moved to protocol.h)
42 * Protocol Encryption
fcef8d87 »
2011-01-15 Reverted Readme file
43
188ba05e »
2012-04-06 Little cleanup for readme.
44 ### Configuration Notes
11f6b8d8 »
2011-05-28 Added information on configuration files.
45
46 An example `config.cfg` file is located in the `files` subdirectory.
47
48 The config file sets three path names and one file name which are relevant to the server; with their example values they are:
49
188ba05e »
2012-04-06 Little cleanup for readme.
50 system.path.data = "files";
51 system.path.plugins = "plugins";
67b47be4 »
2012-04-06 Update README.md
52 system.path.home = ".";
11f6b8d8 »
2011-05-28 Added information on configuration files.
53 system.pid_file = "mineserver.pid";
54
67b47be4 »
2012-04-06 Update README.md
55 These paths may be either absolute or relative. The server requires a set of configuration files which are located in the `files` subdirectory
188ba05e »
2012-04-06 Little cleanup for readme.
56 of the distribution.
11f6b8d8 »
2011-05-28 Added information on configuration files.
57
188ba05e »
2012-04-06 Little cleanup for readme.
58 The plugin binaries must be manually placed in the appropriate location for the server to find them.
47d03768 »
2011-05-28 Clarified language and library dependences a bit.
59
fcef8d87 »
2011-01-15 Reverted Readme file
60
188ba05e »
2012-04-06 Little cleanup for readme.
61 ### Bug Tracker / To Do / Roadmap
47d03768 »
2011-05-28 Clarified language and library dependences a bit.
62
188ba05e »
2012-04-06 Little cleanup for readme.
63 We use GitHub issue tracker and milestones.
64 Please check the wiki pages for details about the project status and development plans.
47d03768 »
2011-05-28 Clarified language and library dependences a bit.
65 Check the [fork network](https://github.com/fador/mineserver/network) for the latest development status.
fcef8d87 »
2011-01-15 Reverted Readme file
66
eb195c9b »
2012-04-04 Some small changes.
67 ### Compiling
fcef8d87 »
2011-01-15 Reverted Readme file
68
47d03768 »
2011-05-28 Clarified language and library dependences a bit.
69 Mineserver requires the following libraries:
70
71 * [zlib 1.2.5](http://www.zlib.org)
72 * [libevent 1.4.14b](http://monkey.org/~provos/libevent/)
73 * [libnoise 1.0](http://libnoise.sourceforge.net/)
e6c88d7d »
2012-08-03 Added openssl to the CMakeLists.txt and edited the readme a bit
74 * [openssl/libssl](http://www.openssl.org/)
41e827b8 »
2012-08-08 Added threaded user validation
75 * [pthread](http://en.wikipedia.org/wiki/POSIX_Threads)
fcef8d87 »
2011-01-15 Reverted Readme file
76
77 * Installing on Debian and Ubuntu: (For Ubuntu libevent1 -> libevent-1.4-2)
78
e6c88d7d »
2012-08-03 Added openssl to the CMakeLists.txt and edited the readme a bit
79 `sudo apt-get install libssl libssl-dev libevent1 libevent-dev zlib1g zlib1g-dev libnoise-dev`
fcef8d87 »
2011-01-15 Reverted Readme file
80
81 * Installing on CentOS and RHEL
82
83 `# Install EPEL (Extra Packages for Enterprise Linux)`
84 `sudo su -c 'rpm -Uvh http://download.fedora.redhat.com/pub/epel/5/i386/epel-release-5-4.noarch.rpm'`
85 `sudo yum install git libevent libevent-devel zlib zlib-devel libnoise-dev`
86
87 * Installing on FreeBSD / PCBSD
88
89 `sudo pkg_add -r libevent`
90
91 * Installing on Mac OS X
92 * Install libevent using your favourite tool, e.g., homebrew, fink or macports.
93 * Installing libnoise can be painful. Howerver, there is a homebrew formular
94 on [krono's homebrew fork](http://github.com/krono/homebrew).
95
96 So for homebrew do
7df6efe3 »
2011-03-02 update readme a bit
97
fcef8d87 »
2011-01-15 Reverted Readme file
98 `brew install libevent libnoise`
99
100
7df6efe3 »
2011-03-02 update readme a bit
101 **Compiling using Linux (cmake & make & g++):**
fcef8d87 »
2011-01-15 Reverted Readme file
102
103 * Download and extract source or use `git clone git://github.com/fador/mineserver.git`
33f10201 »
2011-02-06 Update build instructions for FreeBSD & Linux
104 * Go to mineserver directory
8777d401 »
2011-03-01 Updated readme
105 * Run `cmake .`
188ba05e »
2012-04-06 Little cleanup for readme.
106 * Run `make all`
33f10201 »
2011-02-06 Update build instructions for FreeBSD & Linux
107 * Run server with `cd bin && ./mineserver`
fcef8d87 »
2011-01-15 Reverted Readme file
108
7df6efe3 »
2011-03-02 update readme a bit
109 **Compiling using FreeBSD / PCBSD (cmake & gmake & g++):**
fcef8d87 »
2011-01-15 Reverted Readme file
110
111 * Download and extract source or use `git clone git://github.com/fador/mineserver.git`
33f10201 »
2011-02-06 Update build instructions for FreeBSD & Linux
112 * Go to mineserver directory
8777d401 »
2011-03-01 Updated readme
113 * Run `cmake .`
188ba05e »
2012-04-06 Little cleanup for readme.
114 * Run `gmake all`
33f10201 »
2011-02-06 Update build instructions for FreeBSD & Linux
115 * Run server with `cd bin && ./mineserver`
fcef8d87 »
2011-01-15 Reverted Readme file
116
188ba05e »
2012-04-06 Little cleanup for readme.
117 **Compiling using Windows (VS2010): (Might be outdated)**
fcef8d87 »
2011-01-15 Reverted Readme file
118
119 * Download and compile [zlib](http://www.zlib.org) or use [pre-built binaries](http://www.winimage.com/zLibDll/index.html)
120 * Add zlib libraries to project (zlibstat.lib or zlibwapi.lib which requires also zlibwapi.dll in the same dir with the executable)
121 * Download and compile [libevent](http://monkey.org/~provos/libevent/)
122 * Download [libnoise 1.0](http://libnoise.sourceforge.net/) and add header/library files to project
123 * Add libevent library to project (libevent.lib)
124 * Build
125 * Run mineserver.exe
e6c88d7d »
2012-08-03 Added openssl to the CMakeLists.txt and edited the readme a bit
126
127 * [Build Pack](http://mineserver.be/downloads/mineserver-VS2010_build_pack.zip) also available for easy compiling
fcef8d87 »
2011-01-15 Reverted Readme file
128
129 An example using commandline compiler available at http://www.microsoft.com/express/Windows/ Please change the ZLIB_INC_DIR, LIBEVENT_INC_DIR, ZLIB_LIB_DIR and LIBEVENT_LIB_DIR to those you keep the includes/libs.
130
131 call "%VS100COMNTOOLS%vsvars32.bat"
132 cl /I"ZLIB_INC_DIR;LIBEVENT_INC_DIR" /W3 /WX- /O2 /D ZLIB_WINAPI /D WIN32 /D NDEBUG /D _CRT_SECURE_NO_WARNINGS /EHsc *.cpp zlibwapi.lib libevent.lib Ws2_32.lib /link /OUT:mineserver.exe /LIBPATH:"ZLIB_LIB_DIR;LIBEVENT_LIB_DIR"
c9b23a1c »
2010-11-17 Initial work for mapgen
133
a69e911d »
2010-12-03 Small update to README.md to list /help and /adminhelp client chat co…
134
Something went wrong with that request. Please try again.