docs repo started
This commit is contained in:
47
index.rst
Normal file
47
index.rst
Normal file
@@ -0,0 +1,47 @@
|
||||
========================
|
||||
The Minecraft Overviewer
|
||||
========================
|
||||
|
||||
Introduction
|
||||
============
|
||||
The Minecraft Overviewer is a command-line tool for rendering high-resolution
|
||||
maps of Minecraft worlds. It generates a set of static html and image files and
|
||||
uses the Google Maps API to display a nice interactive map.
|
||||
|
||||
The Overviewer has been in active development for over a year and has many
|
||||
features, including day and night lighting, cave rendering, mineral overlays,
|
||||
and many plugins for even more features! It is written mostly in Python with
|
||||
critical sections in C as an extension module.
|
||||
|
||||
For a simple example of what your renders will look like, head over to `The
|
||||
"Exmaple" Map <http://overviewer.org/example/>`_. For more user-contributed
|
||||
examples, see `The Example Wiki Page <https://github.com/overviewer/Minecraft-Overviewer/wiki/Map-examples>`_.
|
||||
|
||||
Download
|
||||
========
|
||||
The Overviewer works with Linux, Mac, and Windows! We provide Windows and Debian
|
||||
built executables available for download on our `Github Homepage`_.
|
||||
|
||||
To get your copy, head over to our `Github Homepage`_. If you are familiar with Git, you can clone the repository from there. If you would like a Debian or Windows executable, click on the Downloads link, or go `directly there <https://github.com/overviewer/Minecraft-Overviewer/downloads>`_.
|
||||
|
||||
.. _Github Homepage: https://github.com/overviewer/Minecraft-Overviewer
|
||||
|
||||
Documentation
|
||||
=============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
quickstart
|
||||
building
|
||||
running
|
||||
design/designdoc
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
Reference in New Issue
Block a user