Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
30 changed files
with
2,206 additions
and
2,164 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,12 @@ | ||
| language: python | ||
| python: | ||
| - "2.7" | ||
| before_install: | ||
| - sudo apt-get update | ||
| - sudo apt-get install oracle-java8-installer | ||
| - sudo update-java-alternatives -s java-8-oracle | ||
| install: | ||
| - "pip install html5validator" | ||
| script: | ||
| - "python generate.py" | ||
| - "html5validator --root out/" | ||
| language: python | ||
| python: | ||
| - "2.7" | ||
| before_install: | ||
| - sudo apt-get update | ||
| - sudo apt-get install oracle-java8-installer | ||
| - sudo update-java-alternatives -s java-8-oracle | ||
| install: | ||
| - "pip install html5validator" | ||
| script: | ||
| - "python generate.py" | ||
| - "html5validator --root out/" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,37 @@ | ||
| users-manual | ||
| ============ | ||
|
|
||
| A User's Manual for Cuberite | ||
|
|
||
| There is an automatically updated version of the manual at [book.cuberite.org](https://book.cuberite.org), which updates every hour if a new commit has been pushed to this repository. | ||
|
|
||
|
|
||
| Developers' Area | ||
| ---------------- | ||
|
|
||
| This book is structured as individual HTML snippets for each chapter. The filename describes the section number and also the name of the section, separated by " - ". | ||
|
|
||
| A sample input directory structure would be: | ||
|
|
||
| / | ||
| |> 0 - Introduction/ | ||
| | |> 1 - Intro.html | ||
| | |> 2 - Notes.html | ||
| |> 1 - Setting Up/ | ||
| | |> 1 - Downloading.html | ||
| | |> 2 - Running.html | ||
|
|
||
| The idea is that the generator, combines the files to form 2 outputs - one standalone HTML page with all sections integrated and internal links, and another with each file (or section?) being a separate page. At the moment the generator only compiles to a single page, but multiple page is planned. | ||
|
|
||
| Here is a guide to writing: | ||
|
|
||
| Links to another section are automatically generated like so - `{{Section Number - Text of Link}}`. | ||
|
|
||
| Here is a list of semantically correct and styled HTML elements for specific purposes: | ||
|
|
||
| * `<p>` For Paragraphs | ||
| * `<h4>` For Headings | ||
| * `<aside class="infobox">` For information tangentially related to the content. | ||
| * `<aside class="warnbox">` For a warning related to the content. | ||
| * `<figure class="codebox">` For a code sample, with nested `<pre>` and `<code>` tags. Optionally with a `<figcaption>` for a caption. | ||
| * `<figure class="imgbox"` For an image/screenshot. Optionally with a `<figcaption>` for a caption. | ||
| users-manual | ||
| ============ | ||
|
|
||
| A User's Manual for Cuberite | ||
|
|
||
| There is an automatically updated version of the manual at [book.cuberite.org](https://book.cuberite.org), which updates every hour if a new commit has been pushed to this repository. | ||
|
|
||
|
|
||
| Developers' Area | ||
| ---------------- | ||
|
|
||
| This book is structured as individual HTML snippets for each chapter. The filename describes the section number and also the name of the section, separated by " - ". | ||
|
|
||
| A sample input directory structure would be: | ||
|
|
||
| / | ||
| |> 0 - Introduction/ | ||
| | |> 1 - Intro.html | ||
| | |> 2 - Notes.html | ||
| |> 1 - Setting Up/ | ||
| | |> 1 - Downloading.html | ||
| | |> 2 - Running.html | ||
|
|
||
| The idea is that the generator, combines the files to form 2 outputs - one standalone HTML page with all sections integrated and internal links, and another with each file (or section?) being a separate page. At the moment the generator only compiles to a single page, but multiple page is planned. | ||
|
|
||
| Here is a guide to writing: | ||
|
|
||
| Links to another section are automatically generated like so - `{{Section Number - Text of Link}}`. | ||
|
|
||
| Here is a list of semantically correct and styled HTML elements for specific purposes: | ||
|
|
||
| * `<p>` For Paragraphs | ||
| * `<h4>` For Headings | ||
| * `<aside class="infobox">` For information tangentially related to the content. | ||
| * `<aside class="warnbox">` For a warning related to the content. | ||
| * `<figure class="codebox">` For a code sample, with nested `<pre>` and `<code>` tags. Optionally with a `<figcaption>` for a caption. | ||
| * `<figure class="imgbox"` For an image/screenshot. Optionally with a `<figcaption>` for a caption. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,38 @@ | ||
| <p> | ||
| This is the Cuberite User's Manual. It is intended as a guide on how to | ||
| operate the basics of Cuberite, as well as an introduction to some advanced | ||
| features. It is organised into major sections as well as more detailed | ||
| subsections and these are laid out in the {{toc - Table of Contents}}. | ||
| The first section deals with downloading, installing, and running Cuberite. | ||
| The second section is an overview of configuring Cuberite. Reading those two | ||
| sections is enough to get you started. The remaining sections cover more | ||
| advanced features and further configuration options in greater depth. | ||
| </p> | ||
|
|
||
| <p> | ||
| As with Cuberite itself, this manual is in active development, and you can | ||
| contribute yourself or file an issue if you find an error or ommission on the | ||
| <a href="https://github.com/cuberite/users-manual">GitHub Repository</a>. | ||
| If you're using a printed version, note that the latest version of this | ||
| manual is always available <a href="https://book.cuberite.org/">online</a>. | ||
| </p> | ||
|
|
||
| <h4>Resources</h4> | ||
|
|
||
| <ul> | ||
| <li><a href="http://cuberite.org/">Cuberite Homepage</a></li> | ||
| <li><a href="https://forum.cuberite.org/">Forum</a></li> | ||
| <li><a href="https://forum.cuberite.org/forum-2.html">Plugin Repository</a></li> | ||
| <li><a href="https://forum.cuberite.org/thread-1435.html">Server List</a></li> | ||
| <li><a href="https://forum.cuberite.org/thread-2146.html">Development Progress</a></li> | ||
| <li><a href="https://forum.cuberite.org/thread-2504.html">Crash Avoidance Tips</a></li> | ||
| <li><a href="mailto:support@cuberite.org">Support E-mail Address</a></li> | ||
| </ul> | ||
|
|
||
| <h4>Developer Resources</h4> | ||
|
|
||
| <ul> | ||
| <li><a href="http://api-docs.cuberite.org/Writing-a-Cuberite-plugin.html">Writing your First Plugin</a></li> | ||
| <li><a href="http://api-docs.cuberite.org/">Plugin API Documentation</a></li> | ||
| <li><a href="https://github.com/cuberite/cuberite">GitHub Repository</a></li> | ||
| </ul> | ||
| <p> | ||
| This is the Cuberite User's Manual. It is intended as a guide on how to | ||
| operate the basics of Cuberite, as well as an introduction to some advanced | ||
| features. It is organised into major sections as well as more detailed | ||
| subsections and these are laid out in the {{toc - Table of Contents}}. | ||
| The first section deals with downloading, installing, and running Cuberite. | ||
| The second section is an overview of configuring Cuberite. Reading those two | ||
| sections is enough to get you started. The remaining sections cover more | ||
| advanced features and further configuration options in greater depth. | ||
| </p> | ||
|
|
||
| <p> | ||
| As with Cuberite itself, this manual is in active development, and you can | ||
| contribute yourself or file an issue if you find an error or ommission on the | ||
| <a href="https://github.com/cuberite/users-manual">GitHub Repository</a>. | ||
| If you're using a printed version, note that the latest version of this | ||
| manual is always available <a href="https://book.cuberite.org/">online</a>. | ||
| </p> | ||
|
|
||
| <h4>Resources</h4> | ||
|
|
||
| <ul> | ||
| <li><a href="http://cuberite.org/">Cuberite Homepage</a></li> | ||
| <li><a href="https://forum.cuberite.org/">Forum</a></li> | ||
| <li><a href="https://forum.cuberite.org/forum-2.html">Plugin Repository</a></li> | ||
| <li><a href="https://forum.cuberite.org/thread-1435.html">Server List</a></li> | ||
| <li><a href="https://forum.cuberite.org/thread-2146.html">Development Progress</a></li> | ||
| <li><a href="https://forum.cuberite.org/thread-2504.html">Crash Avoidance Tips</a></li> | ||
| <li><a href="mailto:support@cuberite.org">Support E-mail Address</a></li> | ||
| </ul> | ||
|
|
||
| <h4>Developer Resources</h4> | ||
|
|
||
| <ul> | ||
| <li><a href="http://api-docs.cuberite.org/Writing-a-Cuberite-plugin.html">Writing your First Plugin</a></li> | ||
| <li><a href="http://api-docs.cuberite.org/">Plugin API Documentation</a></li> | ||
| <li><a href="https://github.com/cuberite/cuberite">GitHub Repository</a></li> | ||
| </ul> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| <p> | ||
| Cuberite is a Free and Open Source (FOSS) Minecraft-compatible Game Server. Cuberite is designed with performance, configurability, and extensibility in mind, and also aims to accurately recreate most vanilla features. Cuberite is written in C++, and there is an extensive plugin system that allows for the user to write their own plugins with Lua. In fact, many of the built in commands are implemented by the Core plugin, which has its own <a href="https://github.com/cuberite/Core">GitHub repository</a> and developer community. For more information on the plugin system and how to use it, as well as how to develop for it, please see {{2.4 - Plugins}}. | ||
| </p> | ||
|
|
||
| <p> | ||
| Cuberite today is maintained by a large team of <a href="https://github.com/cuberite/cuberite/blob/master/CONTRIBUTORS">contributors</a> and plugin developers. If you want to reward the developers for their work, you should set up a donation on <a href="https://salt.bountysource.com/teams/cuberite">Bountysource</a> with a credit card, bitcoin or other currency. | ||
| </p> | ||
| <p> | ||
| Cuberite is a Free and Open Source (FOSS) Minecraft-compatible Game Server. Cuberite is designed with performance, configurability, and extensibility in mind, and also aims to accurately recreate most vanilla features. Cuberite is written in C++, and there is an extensive plugin system that allows for the user to write their own plugins with Lua. In fact, many of the built in commands are implemented by the Core plugin, which has its own <a href="https://github.com/cuberite/Core">GitHub repository</a> and developer community. For more information on the plugin system and how to use it, as well as how to develop for it, please see {{2.4 - Plugins}}. | ||
| </p> | ||
|
|
||
| <p> | ||
| Cuberite today is maintained by a large team of <a href="https://github.com/cuberite/cuberite/blob/master/CONTRIBUTORS">contributors</a> and plugin developers. If you want to reward the developers for their work, you should set up a donation on <a href="https://salt.bountysource.com/teams/cuberite">Bountysource</a> with a credit card, bitcoin or other currency. | ||
| </p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,23 @@ | ||
| <p> | ||
| Cuberite was created in late 2010 by <a href="https://github.com/faketruth">FakeTruth</a> with its original name "MCServer", as a replacement for the vanilla server, designed to be better performing and more configurable. It was soon open-sourced and developers started working. | ||
| </p> | ||
|
|
||
| <p> | ||
| In the summer of 2013, the main MCServer repository was moved from Google Code to GitHub, and a new build system was introduced. Several new developers also joined the project around that time, and the project began to increase in members and popularity. | ||
| </p> | ||
|
|
||
| <p> | ||
| As of late 2014, MCServer had a team of more than 10 regular developers, and the codebase had grown to over 125,000 lines (excluding comments, blank lines and external libraries). Many new features were also introduced in 2014: | ||
| </p> | ||
|
|
||
| <ul> | ||
| <li>Chunk Sparsing (ram usage reduction)</li> | ||
| <li>New Redstone Simulator</li> | ||
| <li>New Water and Lava Simulators</li> | ||
| <li>New Generators (and improved speed)</li> | ||
| </ul> | ||
|
|
||
| <p> | ||
| In 2015, many new developers joined the project, and the community decided to adopt the current name of Cuberite. | ||
| As of late 2015, Cuberite has over 1000 stars on GitHub. | ||
| </p> | ||
| <p> | ||
| Cuberite was created in late 2010 by <a href="https://github.com/faketruth">FakeTruth</a> with its original name "MCServer", as a replacement for the vanilla server, designed to be better performing and more configurable. It was soon open-sourced and developers started working. | ||
| </p> | ||
|
|
||
| <p> | ||
| In the summer of 2013, the main MCServer repository was moved from Google Code to GitHub, and a new build system was introduced. Several new developers also joined the project around that time, and the project began to increase in members and popularity. | ||
| </p> | ||
|
|
||
| <p> | ||
| As of late 2014, MCServer had a team of more than 10 regular developers, and the codebase had grown to over 125,000 lines (excluding comments, blank lines and external libraries). Many new features were also introduced in 2014: | ||
| </p> | ||
|
|
||
| <ul> | ||
| <li>Chunk Sparsing (ram usage reduction)</li> | ||
| <li>New Redstone Simulator</li> | ||
| <li>New Water and Lava Simulators</li> | ||
| <li>New Generators (and improved speed)</li> | ||
| </ul> | ||
|
|
||
| <p> | ||
| In 2015, many new developers joined the project, and the community decided to adopt the current name of Cuberite. | ||
| As of late 2015, Cuberite has over 1000 stars on GitHub. | ||
| </p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,29 @@ | ||
| <p id="buildsurl"> | ||
| For Windows, Linux, Raspberry Pi or Mac builds, the main download location | ||
| is the <a href="http://cuberite.org">official homepage</a>, with the latest | ||
| builds available. For developers who want more control over the builds they | ||
| download, visit the <a href="https://builds.cuberite.org">buildserver</a>. | ||
| </p> | ||
|
|
||
| <p> | ||
| On Linux or Raspberry Pi, you can simply paste this command into your | ||
| terminal to install Cuberite: | ||
| </p> | ||
|
|
||
| <figure class="codebox"> | ||
| <pre><code>sh -c "$(wget -O - https://download.cuberite.org)"</code></pre> | ||
| </figure> | ||
|
|
||
| <p> | ||
| Once you have downloaded Cuberite, you can skip straight to | ||
| {{1.3 - Running Cuberite}}. | ||
| </p> | ||
|
|
||
| <p> | ||
| Pre-compiled builds are faster to install and easier to use than compiling | ||
| the source yourself, and are recommended for beginners. However, for some | ||
| unusual hardware for which no pre-compiled build exists it may be necessary | ||
| to compile the code yourself. Compiling yourself also has a significant | ||
| performance advantage on modern machines. If you know how to use the command | ||
| line or want extra speed you should {{1.2 - compile Cuberite yourself}}. | ||
| </p> | ||
| <p id="buildsurl"> | ||
| For Windows, Linux, Raspberry Pi or Mac builds, the main download location | ||
| is the <a href="http://cuberite.org">official homepage</a>, with the latest | ||
| builds available. For developers who want more control over the builds they | ||
| download, visit the <a href="https://builds.cuberite.org">buildserver</a>. | ||
| </p> | ||
|
|
||
| <p> | ||
| On Linux or Raspberry Pi, you can simply paste this command into your | ||
| terminal to install Cuberite: | ||
| </p> | ||
|
|
||
| <figure class="codebox"> | ||
| <pre><code>sh -c "$(wget -O - https://download.cuberite.org)"</code></pre> | ||
| </figure> | ||
|
|
||
| <p> | ||
| Once you have downloaded Cuberite, you can skip straight to | ||
| {{1.3 - Running Cuberite}}. | ||
| </p> | ||
|
|
||
| <p> | ||
| Pre-compiled builds are faster to install and easier to use than compiling | ||
| the source yourself, and are recommended for beginners. However, for some | ||
| unusual hardware for which no pre-compiled build exists it may be necessary | ||
| to compile the code yourself. Compiling yourself also has a significant | ||
| performance advantage on modern machines. If you know how to use the command | ||
| line or want extra speed you should {{1.2 - compile Cuberite yourself}}. | ||
| </p> |
Oops, something went wrong.