mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-04-23 00:55:57 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1775 from Intyre/docs

Browse Source 
docs for pocketmine-mp.readthedocs.org
This commit is contained in:
Intyre 2014-07-25 07:03:06 +02:00
commit 48b99486b0
21 changed files with 1649 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.gitignore vendored
View File

@ -20,4 +20,8 @@ Desktop.ini
# Mac crap
.DS_Store
/nbproject/private/
/nbproject/private/
# Sphinx-doc
/docs/build/
!/docs/requirements.txt

177
docs/Makefile Normal file
View File

@ -0,0 +1,177 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PocketMine-MP.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PocketMine-MP.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/PocketMine-MP"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PocketMine-MP"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

15
docs/README.md Normal file
View File

@ -0,0 +1,15 @@
PocketMine-MP Documentation
===========================
PocketMine-MP Documentation for http://pocketmine-mp.readthedocs.org/
Build local
-----------
To build the documentation you need python and 2 extra modules.
* Sphinx
* sphinx_rtd_theme
or install it using `pip -r requirements`

242
docs/make.bat Normal file
View File

@ -0,0 +1,242 @@
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
set I18NSPHINXOPTS=%SPHINXOPTS% source
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an epub
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. xml to make Docutils-native XML files
echo. pseudoxml to make pseudoxml-XML files for display purposes
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
%SPHINXBUILD% 2> nul
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\PocketMine-MP.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PocketMine-MP.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdf" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdfja" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf-ja
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "texinfo" (
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
goto end
)
if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
if "%1" == "xml" (
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The XML files are in %BUILDDIR%/xml.
goto end
)
if "%1" == "pseudoxml" (
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
goto end
)
:end

2
docs/requirements.txt Normal file
View File

@ -0,0 +1,2 @@
Sphinx
sphinx_rtd_theme

334
docs/source/conf.py Normal file
View File

@ -0,0 +1,334 @@
# -*- coding: utf-8 -*-
#
# PocketMine-MP documentation build configuration file, created by
# sphinx-quickstart on Mon Jul 21 07:51:00 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'PocketMine-MP'
copyright = u'2014, PocketMine Team'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.4'
# The full version, including alpha/beta/rc tags.
release = 'Alpha 1.4dev'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# on_rtd is whether we are on readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = False
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'PocketMine-MPDocsdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'PocketMine-MPDocs.tex', u'PocketMine-MP Documentation',
u'Intyre', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'pocketmine-mpdocs', u'PocketMine-MP Documentation',
[u'Intyre'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'PocketMine-MPDocs', u'PocketMine-MP Documentation',
u'Intyre', 'PocketMine-MPDocs', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = u'PocketMine-MP'
epub_author = u'PocketMine Team'
epub_publisher = u'PocketMine'
epub_copyright = u'2014, PocketMine'
# The basename for the epub file. It defaults to the project name.
#epub_basename = u'MCPE Tools'
# The HTML theme for the epub output. Since the default themes are not optimized
# for small screen space, using the same theme for HTML and epub output is
# usually not wise. This defaults to 'epub', a theme designed to save visual
# space.
#epub_theme = 'epub'
# The language of the text. It defaults to the language option
# or en if the language is not set.
epub_language = 'en'
# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#epub_identifier = ''
# A unique identification for the text.
#epub_uid = ''
# A tuple containing the cover image and cover page html template filenames.
#epub_cover = ()
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
#epub_guide = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []
# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3
# Allow duplicate toc entries.
#epub_tocdup = True
# Choose between 'default' and 'includehidden'.
#epub_tocscope = 'default'
# Fix unsupported image types using the PIL.
#epub_fix_images = False
# Scale large images.
#epub_max_image_width = 0
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#epub_show_urls = 'inline'
# If false, no index is generated.
epub_use_index = False

428
docs/source/config.rst Normal file
View File

@ -0,0 +1,428 @@
.. _config:
Configuration
=============
.. contents::
:depth: 2
Basic settings
--------------
When you start the server for the first time you will get a set-up wizard.
Set-up wizard
-------------
.. code-block:: text
PocketMine-MP/ $ ./start.sh
[*] PocketMine-MP set-up wizard
[*] Please select a language:
English => en
Español => es
中文 => zh
Pyccĸий => ru
日本語 => ja
Deutsch => de
한국어 => ko
Français => fr
Italiano => it
Nederlands => nl
Svenska => sv
Suomi => fi
Türkçe => tr
[?] Language (en):
Choose the language you want and press enter
.. code-block:: text
[?] Language (en): en
.. code-block:: text
[*] English has been correctly selected.
Welcome to PocketMine-MP!
Before starting setting up your new server you have to accept the license.
PocketMine-MP is licensed under the LGPL License,
that you can read opening the LICENSE file on this folder.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
.. code-block:: text
[?] Do you accept the License? (y/N): y
[?] Do you want to skip the set-up wizard? (y/N):
If this is not the first time or you already have a custom properties file you can skip the wizard.
.. code-block:: text
[?] Do you want to skip the set-up wizard? (y/N): n
.. code-block:: text
[*] You are going to set up your server now.
[*] If you don't want to change the default value, just press Enter.
[*] You can edit them later on the server.properties file.
[?] Give a name to your server (Minecraft: PE Server):
[*] Do not change the default port value if this is your first server.
[?] Server port (19132):
[*] The RAM is the maximum amount of memory PocketMine-MP will use. A value of 128-256 MB is recommended
[?] Server RAM in MB (256):
[*] Choose between Creative (1) or Survival (0)
[?] Default Game mode: (0):
[?] Max. online players (20):
[*] The spawn protection disallows placing/breaking blocks in the spawn zone except for OPs
[?] Enable spawn protection? (Y/n):
[*] An OP is the player admin of the server. OPs can run more commands than normal players
[?] OP player name (example, your game name):
[!] You will be able to add an OP user later using /op <player>
[*] The white-list only allows players in it to join.
[?] Do you want to enable the white-list? (y/N):
[!] Query is a protocol used by diferent tools to get information of your server and players logged in.
[!] If you disable it, you won't be able to use server lists.
[?] Do you want to disable Query? (y/N):
[*] RCON is a protocol to remote connect with the server console using a password.
[?] Do you want to enable RCON? (y/N):
[*] Getting your external IP and internal IP
[!] Your external IP is *.*.*.*. You may have to port-forward to your internal *.*.*.*
[!] Be sure to check it, if you have to forward and you skip that, no external players will be able to join. [Press Enter][*] You have finished the set-up wizard correctly
[*] Check the Plugin Repository to add new features, minigames, or advanced protection to your server
[*] PocketMine-MP will now start. Type /help to view the list of available commands.
Everything is now configurated. PocketMine will now start.
.. code-block:: text
19:01:52 [INFO] Starting Minecraft: PE server version v0.9.1 alpha
19:01:52 [INFO] Loading pocketmine.yml...
19:01:52 [INFO] Loading server properties...
19:01:52 [INFO] Starting Minecraft PE server on *:19132
19:01:52 [INFO] This server is running PocketMine-MP version Alpha_1.4dev "絶好(Zekkou)ケーキ(Cake)" (API 1.1.0)
19:01:52 [INFO] PocketMine-MP is distributed under the LGPL License
19:01:52 [NOTICE] Level "world" not found
19:01:52 [INFO] Preparing level "world"
19:01:52 [NOTICE] Spawn terrain for level "world" is being generated in the background
19:01:52 [INFO] Starting GS4 status listener
19:01:52 [INFO] Setting query port to 19132
19:01:52 [INFO] Query running on 0.0.0.0:19132
19:01:52 [INFO] Default game type: SURVIVAL
19:01:52 [INFO] Done (4941.533s)! For help, type "help" or "?"
When there are no errors and you see the same message then the server is started. Now you should be able to join the server!
Server properties
-----------------
.. contents::
:local:
allow-flight
++++++++++++
======= =========
Type Default
======= =========
boolean false
======= =========
Allows users to use flight on your server while in Survival mode, if they have a mod that provides flight installed. If enabled, they will be kicked after flying for 5 seconds. Disabling this will remove the player speed limit.
difficulty
++++++++++
============= =========
Type Default
============= =========
integer (0-3) 1
============= =========
Level of difficulty of the game, Survival/Adventure mode only.
0. Peaceful
1. Easy
2. Normal
3. Hard
enable-query
++++++++++++
======= =========
Type Default
======= =========
boolean true
======= =========
Enables the GameSpy4 UT3 Query Protocol server listener. Used to get information about the server. It'll listen on the same port as the server (using the same UDP interface).
enable-rcon
+++++++++++
======= =========
Type Default
======= =========
boolean false
======= =========
RCON is a protocol to allow remote access to the server console. It'll listen y default on the same port as the server, but using TCP. You can also set the `rcon.port`, `rcon.threads` and `rcon.clients-per-thread` properties, but you'll have to manually add them.
rcon.password
+++++++++++++
====== ============
Type Default
====== ============
string random value
====== ============
The password that RCON will check. And empty string will cause all the requests to be refused.
gamemode
++++++++
============= =========
Type Default
============= =========
integer (0-3) 0
============= =========
Defines the mode of gameplay.
0. Survival
1. Creative
2. Adventure
3. Spectator`
generator-settings
++++++++++++++++++
====== =========
Type Default
====== =========
string blank
====== =========
The settings used to customize Superflat world generation. See `Superflat on the MC Wiki <http://www.minecraftwiki.net/wiki/Superflat>`_ for possible settings and examples.
hardcore
++++++++
======= =========
Type Default
======= =========
boolean false
======= =========
If enabled, players will be permanently banned if they die.
level-name
++++++++++
====== =========
Type Default
====== =========
string world
====== =========
Default world name. If it doesn't exist, the server will create a new one using the Default generator.
level-seed
++++++++++
====== =========
Type Default
====== =========
string blank
====== =========
A seed for your world.
level-type
++++++++++
====== =========
Type Default
====== =========
string DEFAULT
====== =========
Determines the type of map that is generated. `DEFAULT => Standard world, FLAT => A flat world`
max-players
+++++++++++
======= =========
Type Default
======= =========
integer 20
======= =========
The maximum number of players that can play on the server at the same time.
server-type
+++++++++++
====== =========
Type Default
====== =========
string normal
====== =========
Defines server type shown in server list. `normal, minecon`
server-name
+++++++++++
====== ====================
Type Default
====== ====================
string Minecraft: PE Server
====== ====================
Server name in the Client server list.
description
+++++++++++
====== ===============================
Type Default
====== ===============================
string Server made using PocketMine-MP
====== ===============================
Marquee shown in the Client server list.
motd
++++
====== ===============================
Type Default
====== ===============================
string Welcome @player to this server!
====== ===============================
Message that is sent to welcome a player.
pvp
+++
======= =========
Type Default
======= =========
boolean true
======= =========
Enable PvP on the server, allowing players to damage each other directly.
server-port
+++++++++++
================= =========
Type Default
================= =========
integer (1-65534) 19132
================= =========
Port that the server will listen on. Note that the client will only show servers on the range 19132-19135. To be accesible over the internet, this port must be `forwarded <http://en.wikipedia.org/wiki/Portforwarding>`_ if the server is hosted in a network using `NAT <http://en.wikipedia.org/wiki/Networkaddresstranslation>`_ (If you have a home router/firewall).
server-usage
++++++++++++
======= =========
Type Default
======= =========
boolean true
======= =========
Sends anonymous usage data to PocketMine.net, including the release version, online users and OS (Win, Linux, Mac). These are shown `here <http://stats.pocketmine.net/>`_.
spawn-animals
+++++++++++++
======= =========
Type Default
======= =========
boolean true
======= =========
Determines if animals will be able to spawn. Random spawns will be implemented in the future.
spawn-monsters
++++++++++++++
======= =========
Type Default
======= =========
boolean true
======= =========
Determines if monsters will be able to spawn. Random spawns will be implemented in the future.
spawn-protection
++++++++++++++++
======= =========
Type Default
======= =========
integer 16
======= =========
Determines the radius of the spawn protection. Only OPs will be able to place/break blocks inside. Note: Setting this to 0 will not disable spawn protection. 0 will protect the single block at the spawn point. You can disable this using -1 as the value.
view-distance
+++++++++++++
======= =========
Type Default
======= =========
integer 10
======= =========
Sets the amount of world data the server sends the client, measured in chunks in each direction of the player.
white-list
++++++++++
======= =========
Type Default
======= =========
boolean false
======= =========
Enables or disables whitelisting.
upnp-forwarding
+++++++++++++++
======= =========
Type Default
======= =========
boolean false
======= =========
Only available on Windows. Tries UPnP automatic port forwarding.
memory-limit
++++++++++++
========================== =========
Type Default
========================== =========
integer (plus unit suffix) 128M
========================== =========
Maximum memory that the server will allocate. The server won't work correctly with less than 128M
debug.level
+++++++++++
======= =========
Type Default
======= =========
integer 1
======= =========
Changes the log output. Max output level is 4

25
docs/source/developers.rst Normal file
View File

@ -0,0 +1,25 @@
.. _developers:
Developers Information
======================
Contributing Code
-----------------
* Use the `Pull Request system <https://github.com/PocketMine/PocketMine-MP/pull/new>`_, your request will be checked and discussed.
* Create a single branch for that pull request
* Code using the syntax as in PocketMine-MP. See below for an example.
* The code must be clear and written in English, comments included.
:doc:`git`
Check the `Contribution Guidelines <https://github.com/PocketMine/PocketMine-MP/blob/master/CONTRIBUTING.md>`_ on github for more information.
*Thanks for contributing to PocketMine-MP!*
API Documentation
-----------------
Read the documentation on `docs.pocketmine.net <http://docs.pocketmine.net>`_ or the latest on `jenkins.pocketmine.net <http://jenkins.pocketmine.net/job/PocketMine-MP-doc/doxygen/>`_
Extending PocketMine-MP
-----------------------
PocketMine-MP has an API that you can use to add new things. For more information look at the :doc:`plugins <plugins>` page.

71
docs/source/faq.rst Normal file
View File

@ -0,0 +1,71 @@
.. _faq:
FAQ - Frequently Asked Questions
================================
.. contents::
:local:
:depth: 2
Installation
------------
How do I install PHP? / How do I install this Server?
+++++++++++++++++++++++++++++++++++++++++++++++++++++
Check the installation instructions on the :ref:`installation <setup>` page.
Failed loading opcache.so
+++++++++++++++++++++++++
This will fail when you did not use the installer. This can be fixed with a single command.
.. code-block:: sh
sed "s/^zend_extension=.*opcache.so/zend_extension=$(find $(pwd) -name opcache.so | sed 's/\//\\\//g')/g" \
bin/php5/bin/php.ini | tee bin/php5/bin/php.ini
Playing
-------
Can PC Minecraft clients connect to this server
+++++++++++++++++++++++++++++++++++++++++++++++
No
Plugins
-------
How do I install Plugins
++++++++++++++++++++++++
Download the ``.phar`` file and move it to the ``plugins`` folder
Can i use .php files
++++++++++++++++++++
Yes, but only when the `DevTools <http://forums.pocketmine.net/plugins/devtools.515/>`_ plugin is installed and the plugin/PocketMine API versions are both the same
Connecting
----------
How do I connect to the server?
+++++++++++++++++++++++++++++++
* Tap Play -> Edit -> External, then fill in the server details
* If it is in your local network, you will find it highlighted on the play menu, without needing to add it
Can other users connect to my server
++++++++++++++++++++++++++++++++++++
Users on the same network are able to join the server. If you want other people from outside your own network to be able to join then you need to port-forward
Do I have to open ports?
++++++++++++++++++++++++
If you have a firewall setup then you need to allow access to ``UDP port 19132``
.. note::
Do you want to use **RCON** then ``TCP port 19132`` also needs access.
Do I have to configure port forwarding?
+++++++++++++++++++++++++++++++++++++++++++
This is only needed when you want people from outside your network to connect. Check `portforward.com <http://portforward.com/english/routers/port_forwarding/routerindex.htm>`_ or us `Google <http://www.google.com>`_ to find the instructions
.. note::
* UDP port: 19132 for PocketMine and Query
* TCP port: 19132 for RCON

61
docs/source/git.rst Normal file
View File

@ -0,0 +1,61 @@
.. _git:
How to use git
==============
Clone PocketMine-MP
-------------------
Get the clone URL from `PocketMine/PocketMine-MP <https://github.com/PocketMine/PocketMine-MP>`_
.. code-block:: sh
$ git clone git@github.com:PocketMine/PocketMine-MP.git PocketMine-MP.git # clone the original repository into PocketMine-MP.git
$ cd PocketMine-MP.git # change directory to PocketMine-MP.git
How to make a pull request
--------------------------
Go to the `PocketMine/PocketMine-MP <https://github.com/PocketMine/PocketMine-MP>`_ repository and hit the **Fork** button. You should now have a forked repo from **PocketMine/PocketMine-MP** in your own repositories.
.. image:: img/git-fork.png
Get the clone URL from the fork and clone it into another directory:
.. code-block:: sh
$ git clone git clone <YOUR SSH/HTTPS clone URL> PocketMine-MP-Fork.git # clone the original repository into PocketMine-MP-Fork.git
$ git checkout -b feature # create and switch to branch feature (it can be any name)
$ git branch # shows current branch
* feature # current branch
master
Make your changes to the code and commit it:
.. note::
Only commit changes described in the commit message
.. code-block:: sh
$ git status # check the status
$ git add <filename> # add all changed files
$ git commit -m 'description of changes' # make a commit with a message
$ git push origin feature # push to your branch
Take a look at GitHub and make a pull request. If the pull request is accepted and merged you can pull the changes back into your fork.
.. note::
To pull from the original repository you need to add the upstream
``$ git remote add upstream git@github.com:PocketMine/PocketMine-MP.git``
.. code-block:: sh
$ git checkout master # switch back to the master branch
$ git fetch upstream # download latest commits from the upstream
$ git merge upstream/master # merge changes from upstream/master into your master branch
Remove the branch you made with
.. code-block:: sh
$ git branch -d feature # remove the branch to keep it clean

BIN
docs/source/img/PocketMine.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 11 KiB

BIN
docs/source/img/create-issue.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 46 KiB

BIN
docs/source/img/git-clone-url.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 15 KiB

BIN
docs/source/img/git-fork.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

19
docs/source/index.rst Normal file
View File

@ -0,0 +1,19 @@
.. image:: img/PocketMine.png
:align: center
PocketMine Documentation
========================
.. toctree::
:maxdepth: 2
intro
require
setup
config
update
faq
developers
plugins
issues

26
docs/source/intro.rst Normal file
View File

@ -0,0 +1,26 @@
.. _intro:
Introduction
============
.. image:: img/PocketMine.png
:align: center
PocketMine-MP is a server software for Minecraft PE (Pocket Edition).
It has a :doc:`Plugin API <plugins>` that enables a :doc:`developer <developers>` to extend it and add new features, or change default ones.
Supported features
------------------
* Get all your friends in one server. Or run a public server.
* Disables flying, item hack, running & more. With an On/Off switch.
* Extend the game in the way you want, add awesome features.
* Teleport players, whitelist your server, tune the server, Remote Console.
* Load different levels at once, and teleport back and forth.
* Endless features, and we continuously implement new things.
Contact and Support
-------------------
* `@PocketMine <https://twitter.com/PocketMine>`_ on twitter
* `#pocketmine <http://webchat.freenode.net/?channels=pocketmine&uio=d4>`_ for support @ irc.freenode.net
* `#mcpedevs <http://webchat.freenode.net/?channels=mcpedevs&uio=d4>`_ for development @ irc.freenode.net
* Mailing list: `Discussion group <https://groups.google.com/forum/#!forum/pocketmine-user-discussion>`_

20
docs/source/issues.rst Normal file
View File

@ -0,0 +1,20 @@
.. _issues:
Issues
======
Check the following things and update if needed before making a new issue:
* PocketMine-MP version
* PHP binary version
* Plugin versions
When you have the latest version of those files and the problem still occures and you are sure a **plugin** is not the cause then `make an new issue <https://github.com/PocketMine/PocketMine-MP/issues/new>`_ on GitHub.
Give as much information as you can about when or what happened.
.. warning::
Did the server crash and generated it a crash dump? Post it on `pastie <http://pastie.org>`_ or `pastebin <http://pastebin.com>`_ and provide a link to it in your issue.
.. image:: img/create-issue.png

78
docs/source/plugins.rst Normal file
View File

@ -0,0 +1,78 @@
.. plugins:
Plugins
=======
**PocketMine is extendable!**
Plugins are available on the `PocketMine website <http://forums.pocketmine.net/plugins/>`_ or you can make your own plugin.
Below is an skeleton with the minimal needed directories, files and content.
Basic plugin structure
----------------------
.. contents::
:local:
:depth: 2
Directories
+++++++++++
Make sure your base structure looks like this
.. code-block:: sh
Example
├── plugin.yml
└── src
└── Example
└── Main.php
2 directories, 2 files
plugin.yml
++++++++++
This file is required in a plugin. It contains the information used by PocketMine-MP to load this plugin. It's in YAML format (you will use this format for plugin configurations). It has four required fields: name, version, api and main. Each one of these fields (and all the optional ones) are described on the plugin.yml page. Be sure that it is named exactly plugin.yml.
======= ====================================================================================
field data
======= ====================================================================================
name The name for your plugin
main The namespace and classname pointing to your main plugin class. It is case sensitive
version The version string of your plugin
api Minimal PocketMine-MP API version required for your plugin
======= ====================================================================================
.. code-block:: yaml
name: Example
main: Example\Main
version: 1.0.0
api: [1.0.0]
Main.php
++++++++
Now, create the main class file, that will include the PluginBase Class that starts the plugin. You can name it whatever you want, but a common way to name it is like the plugin name or Main.
.. code-block:: php
<?php
namespace Example;
use pocketmine\plugin\PluginBase;
class Main extends PluginBase{
public function onLoad(){
$this->getLogger()->info("onLoad() has been called!");
}
public function onEnable(){
$this->getLogger()->info("onEnable() has been called!");
}
public function onDisable(){
$this->getLogger()->info("onDisable() has been called!");
}
}

35
docs/source/require.rst Normal file
View File

@ -0,0 +1,35 @@
.. _require:
Requirements
============
A few extra extensions are needed to run PocketMine-MP with php. Thats why it does not work on standard php binaries.
You can get the latest versions of the binaries from a few places
Custom PHP binaries
-------------------
* `Windows <PHP-Windows_>`_
* `MacOS <PHP-SourceForge_>`_
* `CentOS <PHP-SourceForge_>`_
* `Linux <PHP-SourceForge_>`_ or `Jenkins <PHP-Jenkins_>`_
* `Linux ARM <PHP-SourceForge_>`_ or `Jenkins <PHP-Jenkins_>`_
* `Android <PHP-SourceForge_>`_ or `Jenkins <PHP-Jenkins_>`_
* `Raspbian <PHP-SourceForge_>`_
Third-party Libraries/Protocols Used
------------------------------------
* `PHP Sockets <http://php.net/manual/en/book.sockets.php>`_
* `PHP SQLite3 <http://php.net/manual/en/book.sqlite3.php>`_
* `PHP BCMath <http://php.net/manual/en/book.bc.php>`_
* `PHP pthreads <http://pthreads.org/>`_ by `krakjoe <https://github.com/krakjoe>`_ : Threading for PHP - Share Nothing, Do Everything.
* `PHP YAML <https://code.google.com/p/php-yaml/>`_ by Bryan Davis: The Yaml PHP Extension provides a wrapper to the LibYAML library.
* `LibYAML <http://pyyaml.org/wiki/LibYAML>`_ by Kirill Simonov: A YAML 1.1 parser and emitter written in C.
* `cURL <http://curl.haxx.se/>`_ : cURL is a command line tool for transferring data with URL syntax
* `Zlib <http://www.zlib.net/>`_ : A Massively Spiffy Yet Delicately Unobtrusive Compression Library
* `Source RCON Protocol <https://developer.valvesoftware.com/wiki/Source_RCON_Protocol>`_
* `UT3 Query Protocol <http://wiki.unrealadmin.org/UT3_query_protocol>`_
.. _PHP-Windows: http://sourceforge.net/projects/pocketmine/files/windows/dev/
.. _PHP-SourceForge: http://sourceforge.net/projects/pocketmine/files/builds/
.. _PHP-Jenkins: http://jenkins.pocketmine.net/
.. _PM-Stable: https://github.com/PocketMine/PocketMine-MP/releases
.. _PM-Dev: http://jenkins.pocketmine.net/job/PocketMine-MP/

74
docs/source/setup.rst Normal file
View File

@ -0,0 +1,74 @@
.. _setup:
Installation
============
Installing on Windows
---------------------
Download the latest version from `sourceforge <http://sourceforge.net/projects/pocketmine/files/windows/dev/>`_
.. warning::
If the provided x64 binary does not work then try the x86 binary!
Installing on Linux
-------------------
Open the terminal
Navigate where you want to install/update PocketMine-MP. You can move around using ``cd [directory]``, and create directories using ``mkdir [name]``
.. code-block:: sh
~/ $ mkdir PocketMine-MP # make new directory
~/ $ cd PocketMine-MP # change to directory
PocketMine-MP/ $
Run the following code. It will download PocketMine-MP, download the PHP binaries or compile it if binaries are not available.
.. code-block:: sh
PocketMine-MP/ $ curl -sL \
https://raw.githubusercontent.com/PocketMine/php-build-scripts/master/installer.sh \
| bash -s - -v development
[INFO] Found PocketMine-MP Alpha_1.4dev (build 289) using API 1.1.0
[INFO] This development build was released on Thu Jul 17 21:31:35 CEST 2014
[INFO] Installing/updating PocketMine-MP on directory ./
[1/3] Cleaning...
[2/3] Downloading PocketMine-MP Alpha_1.4dev-289 phar... done!
[3/3] Obtaining PHP: detecting if build is available...
[3/3] Linux 64-bit PHP build available, downloading PHP_5.5.14_x86-64_Linux.tar.gz... checking... regenerating php.ini... done
[INFO] Everything done! Run ./start.sh to start PocketMine-MP
Installing on OS X
------------------
Open the Terminal.app. (Applications -> Utilities -> Terminal)
Navigate where you want to install/update PocketMine-MP. You can move around using ``cd [directory]``, and create directories using ``mkdir [name]``
.. code-block:: sh
~/ $ mkdir PocketMine-MP # make new directory
~/ $ cd PocketMine-MP # change to directory
PocketMine-MP/ $
Run the following code. It will download PocketMine-MP, download the PHP binaries or compile it if binaries are not available.
.. code-block:: sh
PocketMine-MP/ $ curl -sL \
https://raw.githubusercontent.com/PocketMine/php-build-scripts/master/installer.sh \
| bash -s - -v development
[INFO] Found PocketMine-MP Alpha_1.4dev (build 289) using API 1.1.0
[INFO] This development build was released on Thu Jul 17 21:31:35 CEST 2014
[INFO] Installing/updating PocketMine-MP on directory ./
[1/3] Cleaning...
[2/3] Downloading PocketMine-MP Alpha_1.4dev-289 phar... done!
[3/3] Obtaining PHP: detecting if build is available...
[3/3] MacOS 64-bit PHP build available, downloading PHP_5.5.14_x86-64_MacOS.tar.gz... checking... regenerating php.ini... done
[INFO] Everything done! Run ./start.sh to start PocketMine-MP
Installing on Android
---------------------
Install `PocketMine-MP for Android <https://play.google.com/store/apps/details?id=net.pocketmine.server>`_

37
docs/source/update.rst Normal file
View File

@ -0,0 +1,37 @@
.. _update:
Updating
========
.. contents::
:local:
:depth: 2
Manually update
---------------
Update PHP binary
+++++++++++++++++
Download the PHP binary for your OS:
* `Windows <PHP-Windows_>`_
* `MacOS <PHP-SourceForge_>`_
* `CentOS <PHP-SourceForge_>`_
* `Linux <PHP-SourceForge_>`_ or `Jenkins <PHP-Jenkins_>`_
* `Linux ARM <PHP-SourceForge_>`_ or `Jenkins <PHP-Jenkins_>`_
* `Android <PHP-SourceForge_>`_ or `Jenkins <PHP-Jenkins_>`_
* `Raspbian <PHP-SourceForge_>`_
Update PocketMine-MP
++++++++++++++++++++
Download the latest `stable <PM-Stable_>`_ or `development <PM-Dev_>`_ release .
.. note:: Dont forget to rename the file to ``PocketMine-MP.phar``
.. _PHP-Windows: http://sourceforge.net/projects/pocketmine/files/windows/dev/
.. _PHP-SourceForge: http://sourceforge.net/projects/pocketmine/files/builds/
.. _PHP-Jenkins: http://jenkins.pocketmine.net/
.. _PM-Stable: https://github.com/PocketMine/PocketMine-MP/releases
.. _PM-Dev: http://jenkins.pocketmine.net/job/PocketMine-MP/