diff options
Diffstat (limited to '')
| -rw-r--r-- | GETTING-STARTED.md | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/GETTING-STARTED.md b/GETTING-STARTED.md index 535f284df..9ba612919 100644 --- a/GETTING-STARTED.md +++ b/GETTING-STARTED.md @@ -47,7 +47,7 @@ You'll also need CMake to generate the makefile to build from. ### Windows -If you use Windows, your best bet is the MSVC2013 (available as a free download in the Community edition from Microsoft), solution files for which can be generated with cmake. You'll also need cmake to generate the project files. +If you use Windows, your best bet is the Microsoft Visual Studio, available as a free download in the Community edition from Microsoft. You'll also need CMake to generate the project files. Setting up the Repo ------------------- @@ -70,9 +70,9 @@ The Cuberite repo has recently been rearranged for better code separation and ot 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 Cuberite. 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, just make sure they are present (git submodules) - `Server` - This contains the default plugins and environment to actually run the server. You'll find the executable (named `Cuberite`) here and in the `Plugins` directory 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. + This contains the default plugins and environment to actually run the server. This folder's contents are linked into the executable output folder for each build flavor. In the `Plugins` folder there are 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 Style ---------- @@ -94,7 +94,13 @@ 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: +You need to first generate a solution file by executing CMake. At the top-level folder of the repository: +``` +mkdir VS2017-x64 +cd VS2017-x64 +cmake -DBUILD_TOOLS=1 -DSELF_TEST=1 .. +``` +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 Cuberite: right-click the Cuberite project in the Solution Explorer and choose "Set as Startup Project". - Set the debugging folder: right-click the Cuberite project in the Solution Explorer, choose "Properties". In the dialog, browse to "Configuration Properties" -> "Debugging" and set "Working Directory" to "../Server". @@ -102,7 +108,7 @@ You need to first generate a solution file by executing `cmake .` on the command How to Run ---------- -The server can be run (on *nix) by a simple `./Cuberite` in the `Server` directory. On first run it will generate the world and start a server on the default port (configurable in `settings.ini`) so you can connect in Minecraft via `localhost`. Note that if you build a debug version, the executable will be names `Cuberite_debug` instead +The server can be run (on *nix) by a simple `./Cuberite` in the `Server` directory. On first run it will generate the world and start a server on the default port (configurable in `settings.ini`) so you can connect in Minecraft via `localhost`. Where to Get Started -------------------- |