From efc7fed05b4800289cc644fbdeff18fe6cdd2a96 Mon Sep 17 00:00:00 2001 From: mathiascode Date: Mon, 19 Dec 2016 18:08:19 +0200 Subject: [PATCH] Updated links and docs (#3488) --- COMPILING.md | 18 +++++++++--------- Doxyfile | 2 +- GETTING-STARTED.md | 2 +- LICENSE | 2 +- README.md | 6 +++--- Server/Plugins/APIDump/APIDesc.lua | 2 +- Server/Plugins/APIDump/Classes/Geometry.lua | 2 +- Server/Plugins/APIDump/InfoFile.html | 2 +- Server/Plugins/APIDump/SettingUpDecoda.html | 2 +- Server/Plugins/APIDump/SettingUpZeroBrane.html | 2 +- Server/Plugins/APIDump/UsingChunkStays.html | 2 +- Server/Plugins/APIDump/WebWorldThreads.html | 2 +- .../APIDump/Writing-a-Cuberite-plugin.html | 2 +- Server/Plugins/APIDump/main_APIDump.lua | 8 +++++--- Server/README.txt | 12 ++++++------ Server/webadmin/login_template.html | 6 +++--- Server/webadmin/template.lua | 4 ++-- compile.sh | 4 ++-- docs/Cubeset file format.html | 2 +- src/Enchantments.h | 2 +- src/Entities/Entity.cpp | 8 ++++---- src/Entities/Player.cpp | 2 +- src/OSSupport/Errors.cpp | 2 +- 23 files changed, 49 insertions(+), 47 deletions(-) diff --git a/COMPILING.md b/COMPILING.md index deddaeb1b..82bbcfe65 100644 --- a/COMPILING.md +++ b/COMPILING.md @@ -15,15 +15,15 @@ Windows We use Microsoft Visual Studio for Windows compilation. It is possible to use other toolchains, but we don't test against them and they aren't supported. Visual Studio 2013 Express for Desktop is being actively used for development. -You can find download links for VS2013 Express here: http://go.microsoft.com/?linkid=9832280 +You can find download links for VS2013 Express here: https://go.microsoft.com/?linkid=9832280 -Next, you need to download and install CMake. Download from here: http://cmake.org/cmake/resources/software.html . You should download a full installation package, so that the installer will set everything up for you (especially the paths). +Next, you need to download and install CMake. Download from here: https://cmake.org/download/ . You should download a full installation package, so that the installer will set everything up for you (especially the paths). To contribute your changes to the source back to the repository, you need a Git client. Options are: - * MsysGit: http://msysgit.github.io/ - * GitHub windows client: http://windows.github.com/ - * TortoiseGit: http://code.google.com/p/tortoisegit/ + * Git for Windows: https://git-for-windows.github.io/ + * GitHub Desktop: https://desktop.github.com/ + * TortoiseGit: https://tortoisegit.org/ Alternatively, if you want only to compile the source, without contributing, you can [download the sources in a ZIP file directly from GitHub](https://github.com/cuberite/cuberite/archive/master.zip). @@ -50,11 +50,11 @@ In order to tinker with the code, you'll more than likely need to use the debugg OSX --- -Install git from its [website](http://git-scm.com) or homebrew: `brew install git`. +Install git from its [website](https://git-scm.com/) or homebrew: `brew install git`. Install Xcode (commandline tools are recommended) from the App Store or [the website](https://developer.apple.com/downloads). -Install CMake from its [website](http://cmake.org) or homebrew: `brew install cmake`. +Install CMake from its [website](https://cmake.org/) or homebrew: `brew install cmake`. ### Getting the sources ### @@ -72,7 +72,7 @@ After doing so, run the command `xcodebuild lib/polarssl/POLARSSL.xcodeproj` in Linux, FreeBSD etc. ------------------- -Install git, make, cmake and clang (or gcc), using your platform's package manager. debian/ubuntu: +Install git, make, cmake and clang (or gcc), using your platform's package manager. Debian/Ubuntu: ``` sudo apt-get install git make cmake clang @@ -96,7 +96,7 @@ cmake -DCMAKE_BUILD_TYPE=RELEASE .. make -j`nproc` ``` -This will build Cuberite in release mode, which is better for almost all cases. For more `cmake` options, or for building in debug mode, see the section below. +This will build Cuberite in release mode, which is better for almost all cases. For more `cmake` options, or for building in debug mode, see [CMake on Unix-based platforms](#cmake-on-unix-based-platforms). Android ------- diff --git a/Doxyfile b/Doxyfile index 1b958f2e0..d9a59062a 100644 --- a/Doxyfile +++ b/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NUMBER = # for a project that appears at the top of each page and should give viewer # a quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "A custom Minecraft compatible game server written in C++" +PROJECT_BRIEF = "A lightweight, fast and extensible game server for Minecraft" # With the PROJECT_LOGO tag one can specify an logo or icon that is # included in the documentation. The maximum height of the logo should not diff --git a/GETTING-STARTED.md b/GETTING-STARTED.md index 7d0880e64..7f46a0b79 100644 --- a/GETTING-STARTED.md +++ b/GETTING-STARTED.md @@ -23,7 +23,7 @@ Useful Resources * [Minecraft Wiki](http://minecraft.gamepedia.com/Minecraft_Wiki) * [Minecraft Protocol Wiki](http://wiki.vg/Main_Page) - * [Lua API Documentation](http://api-docs.cuberite.org/) + * [Lua API Documentation](https://api.cuberite.org/) * [VS2013 Community Edition Download](https://www.visualstudio.com/products/visual-studio-community-vs) Setting up a Dev Environment diff --git a/LICENSE b/LICENSE index 048be9885..ffe546924 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Cuberite: A custom Minecraft compatible game server written in C++ +Cuberite: A lightweight, fast and extensible game server for Minecraft www: https://github.com/cuberite/cuberite Copyright 2011-2016 Cuberite Team diff --git a/README.md b/README.md index e1b33a306..6c3d06c34 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Cuberite is a Minecraft-compatible multiplayer game server that is written in C+ 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.8 and 1.9 Minecraft protocol versions. +We currently support Release 1.8 - 1.10 Minecraft protocol versions. Subscribe to [the newsletter](https://cuberite.org/news/#subscribe) for important updates and project news. @@ -54,8 +54,8 @@ You can also help with documentation by contributing to the [User's Manual](http Other Stuff ----------- -For other stuff, check out the [homepage](https://cuberite.org), the [Users' Manual](https://book.cuberite.org), -the [forums](https://forum.cuberite.org/), and the [Plugin API](http://api-docs.cuberite.org/). +For other stuff, check out the [homepage](https://cuberite.org/), the [Users' Manual](https://book.cuberite.org/), +the [forums](https://forum.cuberite.org/), and the [Plugin API](https://api.cuberite.org/). [Support Us on Bountysource](https://bountysource.com/teams/cuberite) diff --git a/Server/Plugins/APIDump/APIDesc.lua b/Server/Plugins/APIDump/APIDesc.lua index 2ed3b861f..3fc21b6a3 100644 --- a/Server/Plugins/APIDump/APIDesc.lua +++ b/Server/Plugins/APIDump/APIDesc.lua @@ -3687,7 +3687,7 @@ end @Xcolor X (X is 0 - 9 or a - f, same as dye meta The following picture, taken from MineCraft Wiki, illustrates the color codes:

- + ]], Functions = { diff --git a/Server/Plugins/APIDump/Classes/Geometry.lua b/Server/Plugins/APIDump/Classes/Geometry.lua index fa0fe995a..2f37a9c25 100644 --- a/Server/Plugins/APIDump/Classes/Geometry.lua +++ b/Server/Plugins/APIDump/Classes/Geometry.lua @@ -1236,7 +1236,7 @@ end Type = "Vector3d", }, }, - Notes = "Returns a new Vector3d that is a {{http://en.wikipedia.org/wiki/Cross_product|cross product}} of this vector and the specified vector.", + Notes = "Returns a new Vector3d that is a {{https://en.wikipedia.org/wiki/Cross_product|cross product}} of this vector and the specified vector.", }, Dot = { diff --git a/Server/Plugins/APIDump/InfoFile.html b/Server/Plugins/APIDump/InfoFile.html index 6f70e5b54..e293931f2 100644 --- a/Server/Plugins/APIDump/InfoFile.html +++ b/Server/Plugins/APIDump/InfoFile.html @@ -2,7 +2,7 @@ Cuberite - Info.lua file - + diff --git a/Server/Plugins/APIDump/SettingUpDecoda.html b/Server/Plugins/APIDump/SettingUpDecoda.html index d9b91ed3a..15df27816 100644 --- a/Server/Plugins/APIDump/SettingUpDecoda.html +++ b/Server/Plugins/APIDump/SettingUpDecoda.html @@ -3,7 +3,7 @@ Cuberite - Setting up Decoda - + diff --git a/Server/Plugins/APIDump/SettingUpZeroBrane.html b/Server/Plugins/APIDump/SettingUpZeroBrane.html index 3038c4795..b2a820ee3 100644 --- a/Server/Plugins/APIDump/SettingUpZeroBrane.html +++ b/Server/Plugins/APIDump/SettingUpZeroBrane.html @@ -3,7 +3,7 @@ Cuberite - Setting up ZeroBrane Studio - + diff --git a/Server/Plugins/APIDump/UsingChunkStays.html b/Server/Plugins/APIDump/UsingChunkStays.html index 1fada61eb..b8cc1bf5f 100644 --- a/Server/Plugins/APIDump/UsingChunkStays.html +++ b/Server/Plugins/APIDump/UsingChunkStays.html @@ -2,7 +2,7 @@ Cuberite - Using ChunkStays - + diff --git a/Server/Plugins/APIDump/WebWorldThreads.html b/Server/Plugins/APIDump/WebWorldThreads.html index e48df9845..c35aa0337 100644 --- a/Server/Plugins/APIDump/WebWorldThreads.html +++ b/Server/Plugins/APIDump/WebWorldThreads.html @@ -2,7 +2,7 @@ Cuberite - Webserver vs World threads - + diff --git a/Server/Plugins/APIDump/Writing-a-Cuberite-plugin.html b/Server/Plugins/APIDump/Writing-a-Cuberite-plugin.html index cb0637f22..eaf56deed 100644 --- a/Server/Plugins/APIDump/Writing-a-Cuberite-plugin.html +++ b/Server/Plugins/APIDump/Writing-a-Cuberite-plugin.html @@ -3,7 +3,7 @@ Cuberite Plugin Tutorial - + diff --git a/Server/Plugins/APIDump/main_APIDump.lua b/Server/Plugins/APIDump/main_APIDump.lua index bbd2fa19e..624aed93b 100644 --- a/Server/Plugins/APIDump/main_APIDump.lua +++ b/Server/Plugins/APIDump/main_APIDump.lua @@ -271,7 +271,7 @@ local function WriteHtmlHook(a_Hook, a_HookNav) f:write([[ Cuberite API - ]], HookName, [[ Hook - + @@ -965,6 +965,7 @@ local function WriteHtmlClass(a_ClassAPI, a_ClassMenu, a_API) cf:write([[ Cuberite API - ]], a_ClassAPI.Name, [[ Class + @@ -1442,6 +1443,7 @@ local function DumpAPIHtml(a_API, a_Descs) Cuberite API - Index + @@ -1641,7 +1643,7 @@ local function DumpLuaCheck(a_API) file:write([[ -- This file is the config file for the tool named Luacheck --- Documentation: http://luacheck.readthedocs.io/en/stable/index.html +-- Documentation: https://luacheck.readthedocs.io/en/stable/index.html -- Ignore unused function and loop arguments unused_args = false @@ -1891,7 +1893,7 @@ end local function CheckNewUndocumentedSymbols() -- Download the official API stats on undocumented stuff: -- (We need a blocking downloader, which is impossible with the current cNetwork API) - assert(os.execute("wget -q -O official_undocumented.lua https://apidocs.cuberite.org/_undocumented.lua")) + assert(os.execute("wget -q -O official_undocumented.lua https://api.cuberite.org/_undocumented.lua")) local OfficialStats = cFile:ReadWholeFile("official_undocumented.lua") if (OfficialStats == "") then return true, "Cannot load official stats" diff --git a/Server/README.txt b/Server/README.txt index 62f6c29b8..88d60fae8 100644 --- a/Server/README.txt +++ b/Server/README.txt @@ -1,16 +1,16 @@ ---------------------------------------------------------------------------------- - Welcome to your new Cuberite server, compatible with Minecraft 1.8 and 1.9! ---------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- + Welcome to your new Cuberite server, compatible with Minecraft 1.8 - 1.10! +-------------------------------------------------------------------------------- - To get started with your server, read the user's manual at https://book.cuberite.org/ - - Subscribe to the Newsletter for update news and important information - at https://newsletter.cuberite.org/subscribe.htm + - Subscribe to the Newsletter for update news and important information at + https://cuberite.org/news/#subscribe - For information about adding plugins to your server, visit https://cuberite.org/plugins/ - For additional support, visit https://cuberite.org/support/ ---------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- diff --git a/Server/webadmin/login_template.html b/Server/webadmin/login_template.html index 20393d828..75c2f8e7e 100644 --- a/Server/webadmin/login_template.html +++ b/Server/webadmin/login_template.html @@ -51,17 +51,17 @@
- Copyright © Cuberite Team. + Copyright © Cuberite Team.
diff --git a/Server/webadmin/template.lua b/Server/webadmin/template.lua index 168f87993..ac7fb9d72 100644 --- a/Server/webadmin/template.lua +++ b/Server/webadmin/template.lua @@ -197,10 +197,10 @@ function ShowPage(WebAdmin, TemplateRequest)
diff --git a/compile.sh b/compile.sh index 0f26f8607..05a83db04 100755 --- a/compile.sh +++ b/compile.sh @@ -186,7 +186,7 @@ The compilation and download will occur in the current directory. If you're updating, you should run: /compile.sh Compiling from source takes time, but it usually generates faster executables. If you prefer ready-to-use binaries or if you want -more info, please visit: http://cuberite.org/" +more info, please visit: https://cuberite.org/" doDependencyCheck() { @@ -482,7 +482,7 @@ exit 0 :windows_detected @echo off echo This script is not available for Windows yet, sorry. -echo You can still download the Windows binaries from: http://cuberite.org +echo You can still download the Windows binaries from: https://cuberite.org/ echo You can also manually compile for Windows. See: https://github.com/cuberite/cuberite rem windows_exit exit diff --git a/docs/Cubeset file format.html b/docs/Cubeset file format.html index da4fe4e88..6ead2e700 100644 --- a/docs/Cubeset file format.html +++ b/docs/Cubeset file format.html @@ -22,7 +22,7 @@

There are some existing formats available to consider first:

  • schematic - file format native to MCEdit / Bukkit / WorldEdit communities. Can store the prefab, the block entities and regular entities, and any metadata. Cannot store multiple prefabs. No effort to read or write, there's already code to do that (except for the entities) in the server.
    • -
  • bob / bo2 / bo3 - file format created for prefabs in the Terrain Control mod. Can store the prefab and any metadata. Support for block entities and regular entities is unknown. Cannot store multiple prefabs. Medium difficulty for reading and writing, would need new parser and serializer. Unknown (but assumed true) whether the format truly supports any metadata.
    • +
  • bob / bo2 / bo3 - file format created for prefabs in the Terrain Control mod. Can store the prefab and any metadata. Support for block entities and regular entities is unknown. Cannot store multiple prefabs. Medium difficulty for reading and writing, would need new parser and serializer. Unknown (but assumed true) whether the format truly supports any metadata.
  • cpp - export from our Gallery server directly into C++ source files. Can store the prefab and any metadata, block entities and regular entities currently not implemented but could be added. Very difficult for reading, writing already implemented. Only usable when compiling directly into the server. Can store multiple prefabs and metadata for the entire set.
Obviously none of these fully satisfy our needs, so we'll need to either extend one of them or create yet another one. Extending the .schematic file would mean that the exporter plugin would need to change most of the export code, which was deemed too unmaintainable. Because the bob format is not implemented at all, it wasn't even considered. The cpp format would have been a great candidate if it weren't so difficult to parse. However, it sparked an idea - something similar in form to the cpp format, but easily parsed. Since we already have the Lua interpreter, why not base the new format in Lua?

diff --git a/src/Enchantments.h b/src/Enchantments.h index acc15dc7e..1119f7e2f 100644 --- a/src/Enchantments.h +++ b/src/Enchantments.h @@ -40,7 +40,7 @@ Serialization will never put zero-level enchantments into the stringspec and wil class cEnchantments { public: - /** Individual enchantment IDs, corresponding to their NBT IDs: http://www.minecraftwiki.net/wiki/Data_Values#Enchantment_IDs + /** Individual enchantment IDs, corresponding to their NBT IDs: http://minecraft.gamepedia.com/Data_values#Enchantment_IDs */ enum eEnchantment diff --git a/src/Entities/Entity.cpp b/src/Entities/Entity.cpp index 48d07fbbc..d155d9d9d 100644 --- a/src/Entities/Entity.cpp +++ b/src/Entities/Entity.cpp @@ -674,7 +674,7 @@ bool cEntity::DoTakeDamage(TakeDamageInfo & a_TDI) int cEntity::GetRawDamageAgainst(const cEntity & a_Receiver) { // Returns the hitpoints that this pawn can deal to a_Receiver using its equipped items - // Ref: http://www.minecraftwiki.net/wiki/Damage#Dealing_damage as of 2012_12_20 + // Ref: http://minecraft.gamepedia.com/Damage#Dealing_damage as of 2012_12_20 switch (this->GetEquippedWeapon().m_ItemType) { case E_ITEM_WOODEN_SWORD: return 4; @@ -711,7 +711,7 @@ int cEntity::GetRawDamageAgainst(const cEntity & a_Receiver) bool cEntity::ArmorCoversAgainst(eDamageType a_DamageType) { - // Ref.: http://www.minecraftwiki.net/wiki/Armor#Effects as of 2012_12_20 + // Ref.: http://minecraft.gamepedia.com/Armor#Effects as of 2012_12_20 switch (a_DamageType) { case dtOnFire: @@ -761,7 +761,7 @@ int cEntity::GetArmorCoverAgainst(const cEntity * a_Attacker, eDamageType a_Dama } // Add up all armor points: - // Ref.: http://www.minecraftwiki.net/wiki/Armor#Defense_points as of 2012_12_20 + // Ref.: http://minecraft.gamepedia.com/Armor#Defense_points as of 2012_12_20 int ArmorValue = 0; switch (GetEquippedHelmet().m_ItemType) { @@ -797,7 +797,7 @@ int cEntity::GetArmorCoverAgainst(const cEntity * a_Attacker, eDamageType a_Dama } // TODO: Special armor cases, such as wool, saddles, dog's collar - // Ref.: http://www.minecraftwiki.net/wiki/Armor#Mob_armor as of 2012_12_20 + // Ref.: http://minecraft.gamepedia.com/Armor#Mob_armor as of 2012_12_20 // Now ArmorValue is in [0, 20] range, which corresponds to [0, 80%] protection. Calculate the hitpoints from that: return a_Damage * (ArmorValue * 4) / 100; diff --git a/src/Entities/Player.cpp b/src/Entities/Player.cpp index ce3b8b195..f3ea45cf4 100644 --- a/src/Entities/Player.cpp +++ b/src/Entities/Player.cpp @@ -2316,7 +2316,7 @@ void cPlayer::TickBurning(cChunk & a_Chunk) void cPlayer::HandleFood(void) { - // Ref.: http://www.minecraftwiki.net/wiki/Hunger + // Ref.: http://minecraft.gamepedia.com/Hunger if (IsGameModeCreative() || IsGameModeSpectator()) { diff --git a/src/OSSupport/Errors.cpp b/src/OSSupport/Errors.cpp index 004cbaccc..a6a66c73c 100644 --- a/src/OSSupport/Errors.cpp +++ b/src/OSSupport/Errors.cpp @@ -20,7 +20,7 @@ AString GetOSErrorString( int a_ErrNo) #else // _WIN32 - // According to http://linux.die.net/man/3/strerror_r there are two versions of strerror_r(): + // According to https://linux.die.net/man/3/strerror_r there are two versions of strerror_r(): #if defined(__GLIBC__) && defined( _GNU_SOURCE) && !defined(ANDROID) // GNU version of strerror_r()