Merge pull request #2229 from cuberite/readme-namechange
Name change updates.
This commit is contained in:
Alexander Harkness
commit
47d78ab99c
@ -1,4 +1,4 @@
|
||||
Many people have contributed to MCServer, and this list attempts to broadcast at least some of them.
|
||||
Many people have contributed to Cuberite, and this list attempts to broadcast at least some of them.
|
||||
|
||||
BasedDoge (Donated AlchemistVillage prefabs)
|
||||
bearbin (Alexander Harkness)
|
||||
@ -45,4 +45,4 @@ worktycho
|
||||
xoft (Mattes Dolak/madmaxoft on GH)
|
||||
Yeeeeezus (Donated AlchemistVillage prefabs)
|
||||
|
||||
Please add yourself to this list if you contribute to MCServer.
|
||||
Please add yourself to this list if you contribute to Cuberite.
|
||||
|
||||
@ -56,20 +56,20 @@ After that they should come down automatically when you pull but it's not bad to
|
||||
Repo Arrangement
|
||||
---------------------------
|
||||
|
||||
The MCServer repo has recently been rearranged for better code separation and other things, but basically it's split into a few areas:
|
||||
The Cuberite repo has recently been rearranged for better code separation and other things, but basically it's split into a few areas:
|
||||
|
||||
* `src`
|
||||
This holds all of the MCServer source code, and is where most development takes place.
|
||||
This holds all of the Cuberite source code, and is where most development takes place.
|
||||
It's split into logical areas for blocks, the protocol handling and other things.
|
||||
* `lib`
|
||||
This holds all the 3rd party libraries for MCServer. You basically don't need to touch these, and we're thinking of switching them into submodules soon.
|
||||
This holds all the 3rd party libraries for Cuberite. You basically don't need to touch these, and we're thinking of switching them into submodules soon.
|
||||
* `MCServer`
|
||||
This folder isn't greatly named, but it contains the default plugins and environment to actually run the server. You'll find the executable (named `MCServer`) here and in the `plugins` subdir the default plugins. The config files are also stored here. Config files with `.example.ini` on the end are generated by the server or source control and should be left alone, instead you should copy them to a file without the `example` in the name which will be prioritised over the generated ones.
|
||||
|
||||
Code Styles
|
||||
------------------
|
||||
|
||||
Mainly follow the code styles in [CONTRIBUTING.md](https://github.com/mc-server/MCServer/blob/master/CONTRIBUTING.md), which is definitely an important read.
|
||||
Mainly follow the code styles in [CONTRIBUTING.md](https://github.com/cuberite/cuberite/blob/master/CONTRIBUTING.md), which is definitely an important read.
|
||||
|
||||
Note that there is a script file, $/src/CheckBasicStyle.lua, that can check some common violations of the coding style. You should run this file to check your code regularly. This script is run during the integration builds and if it fails, the build will fail. Note that you need Lua installed in order to run this script.
|
||||
|
||||
@ -79,7 +79,7 @@ How to Build
|
||||
|
||||
**Linux/BSD/Solaris/OSX:**
|
||||
|
||||
Follow the instructions in [COMPILING.md](https://github.com/mc-server/MCServer/blob/master/COMPILING.md). You probably want to build in debug mode (when you're developing) for console alerts and debugging capability, even though it's much slower for everyday use.
|
||||
Follow the instructions in [COMPILING.md](https://github.com/cuberite/cuberite/blob/master/COMPILING.md). You probably want to build in debug mode (when you're developing) for console alerts and debugging capability, even though it's much slower for everyday use.
|
||||
|
||||
Basically, the process is:
|
||||
|
||||
@ -88,7 +88,7 @@ Basically, the process is:
|
||||
**Windows:**
|
||||
|
||||
You need to first generate a solution file by executing `cmake .` on the commandline at the top-level folder of the repository, then just open the solution file in MSVC and build. Note that the first time after generating the solution, you will need to do extra setup in order to be able to fully debug in MSVC:
|
||||
- Set the startup project to MCServer: right-click the MCServer project in the Solution Explorer and choose "Set as Startup Project".
|
||||
- Set the startup project to Cuberite: right-click the MCServer project in the Solution Explorer and choose "Set as Startup Project".
|
||||
- Set the debugging folder: right-click the MCServer project in the Solution Explorer, choose "Properties". In the dialog, browse to "Configuration Properties" -> "Debugging" and set "Working Directory" to "../MCServer".
|
||||
|
||||
How to Run
|
||||
@ -108,7 +108,7 @@ There are a few fairly easy issues for you to get started with, as well as some
|
||||
* #577
|
||||
* #381
|
||||
* #752
|
||||
* Clean up some of the compiler warnings. (Check [Travis CI](http://travis-ci.org/mc-server/MCServer) for a list of them.) With clang, there are over 10000 lines of warnings to clean up.
|
||||
* Clean up some of the compiler warnings. (Check [Travis CI](http://travis-ci.org/cuberite/cuberite) for a list of them.) With clang, there are over 10000 lines of warnings to clean up.
|
||||
|
||||
**More Difficult**:
|
||||
|
||||
@ -116,7 +116,7 @@ There are a few fairly easy issues for you to get started with, as well as some
|
||||
* #134
|
||||
* #215
|
||||
|
||||
You may also want to write some plugins. They are written in lua, with excellent API documentation available via [APIDump](http://mc-server.xoft.cz/LuaAPI). The [Core](https://github.com/mc-server/Core) plugin should also help quite a bit here.
|
||||
You may also want to write some plugins. They are written in lua, with excellent API documentation available via [APIDump](http://api-docs.cuberite.org). The [Core](https://github.com/mc-server/Core) plugin should also help quite a bit here.
|
||||
|
||||
Special Things
|
||||
---------------------
|
||||
|
||||
6
LICENSE
6
LICENSE
@ -1,7 +1,7 @@
|
||||
MCServer: A performant C++ Minecraft Server
|
||||
www: http://mc-server.org/
|
||||
Cuberite: A performant C++ Minecraft Server
|
||||
www: https://github.com/cuberite/cuberite
|
||||
|
||||
Copyright 2011-2015 MCServer Team
|
||||
Copyright 2011-2015 Cuberite Team
|
||||
|
||||
------
|
||||
|
||||
|
||||
28
README.md
28
README.md
@ -1,9 +1,9 @@
|
||||
MCServer [](https://travis-ci.org/cuberite/cuberite) [](https://scan.coverity.com/projects/1930) [](http://gratipay.com/cuberite_team)
|
||||
Cuberite [](https://travis-ci.org/cuberite/cuberite) [](https://scan.coverity.com/projects/1930) [](http://gratipay.com/cuberite_team)
|
||||
========
|
||||
|
||||
MCServer is a Minecraft-compatible multiplayer game server that is written in C++ and designed to be efficient with memory and CPU, as well as having a flexible Lua Plugin API. MCServer is compatible with the vanilla Minecraft client.
|
||||
Cuberite is a Minecraft-compatible multiplayer game server that is written in C++ and designed to be efficient with memory and CPU, as well as having a flexible Lua Plugin API. Cuberite is compatible with the vanilla Minecraft client.
|
||||
|
||||
MCServer can run on Windows, *nix and Android operating systems. This includes Android phones and tablets as well as Raspberry Pis.
|
||||
Cuberite can run on Windows, *nix and Android operating systems. This includes Android phones and tablets as well as Raspberry Pis.
|
||||
|
||||
We currently support Release 1.7 and 1.8 (not beta) Minecraft protocol versions.
|
||||
|
||||
@ -11,38 +11,38 @@ Subscribe to [the newsletter](http://newsletter.cuberite.org/subscribe.htm) for
|
||||
|
||||
Installation
|
||||
------------
|
||||
Hosted MCServer is available DIY on DigitalOcean: [](http://doinstall.bearbin.net/install?url=https://github.com/mc-server/MCServer) and [Gamososm](https://gamocosm.com) also offers MCServer support.
|
||||
Hosted Curbeite is available DIY on DigitalOcean: [](http://doinstall.bearbin.net/install?url=https://github.com/cuberite/cuberite) and [Gamososm](https://gamocosm.com) also offers Cuberite support.
|
||||
|
||||
For Linux there is an easy installation method, just run this in your terminal:
|
||||
|
||||
curl -s https://raw.githubusercontent.com/mc-server/MCServer/master/easyinstall.sh | sh
|
||||
curl -s https://raw.githubusercontent.com/cuberite/cuberite/master/easyinstall.sh | sh
|
||||
|
||||
For Windows, you just need to download a file and extract it:
|
||||
|
||||
- [Windows 32 bit](http://builds.cuberite.org/job/MCServer%20Windows%20x86/lastSuccessfulBuild/artifact/Install/MCServer.zip)
|
||||
- [Windows 64 bit](http://builds.cuberite.org/job/MCServer%20Windows%20x64/lastSuccessfulBuild/artifact/Install/MCServer.zip)
|
||||
- [Windows 32 bit](http://builds.cuberite.org/job/Cuberite%20Windows%20x86%20Master/lastSuccessfulBuild/artifact/Install/Cuberite.zip)
|
||||
- [Windows 64 bit](http://builds.cuberite.org/job/Cuberite%20Windows%20x64%20Master/lastSuccessfulBuild/artifact/Install/Cuberite.zip)
|
||||
|
||||
For other operating systems you need to download and compile yourself. This can be done either manually, or with this automatic script:
|
||||
|
||||
bash -c "$(wget -O - https://raw.githubusercontent.com/mc-server/MCServer/master/compile.sh)"
|
||||
bash -c "$(wget -O - https://raw.githubusercontent.com/cuberite/cuberite/master/compile.sh)"
|
||||
|
||||
There is also an archive of binary builds on the buildserver: http://builds.cuberite.org
|
||||
|
||||
Compiling the server yourself has other benefits: you may get better performance performance (1.5-3x as fast) and it supports more operating systems. See the [COMPILING.md](https://github.com/mc-server/MCServer/blob/master/COMPILING.md) file for more details.
|
||||
Compiling the server yourself has other benefits: you may get better performance performance (1.5-3x as fast) and it supports more operating systems. See the [COMPILING.md](https://github.com/cuberite/cuberite/blob/master/COMPILING.md) file for more details.
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
||||
MCServer is licensed under the Apache License V2, and we welcome anybody to fork and submit a Pull Request back with their changes, and if you want to join as a permanent member we can add you to the team.
|
||||
Cuberite is licensed under the Apache License V2, and we welcome anybody to fork and submit a Pull Request back with their changes, and if you want to join as a permanent member we can add you to the team.
|
||||
|
||||
Check out the [CONTRIBUTING.md](https://github.com/mc-server/MCServer/blob/master/CONTRIBUTING.md) file for more details.
|
||||
Check out the [CONTRIBUTING.md](https://github.com/cuberite/cuberite/blob/master/CONTRIBUTING.md) file for more details.
|
||||
|
||||
Other Stuff
|
||||
-----------
|
||||
|
||||
For other stuff, including plugins and discussion, check out the [forums](http://forum.mc-server.org) and [Plugin API](http://mc-server.xoft.cz/LuaAPI/).
|
||||
For other stuff, including plugins and discussion, check out the [forums](http://forum.mc-server.org) and [Plugin API](http://api-docs.cuberite.org).
|
||||
|
||||
Support Us on Gratipay: [](https://www.gratipay.com/cuberite_team)
|
||||
Support Us on Gratipay: [](https://www.gratipay.com/cuberite)
|
||||
|
||||
Travis CI: [](https://travis-ci.org/mc-server/MCServer)
|
||||
Travis CI: [](https://travis-ci.org/cuberite/cuberite)
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user