81 lines
2.2 KiB
ReStructuredText
81 lines
2.2 KiB
ReStructuredText
|
.. image:: miney-slogan.png
|
||
|
|
:alt: Miney logo
|
||
|
|
:align: center
|
||
|
|
:class: miney-logo-mainpage
|
||
|
|
|
||
|
|
|
||
|
|
Welcome to the Miney documentation!
|
||
|
|
====================================
|
||
|
|
|
||
|
|
Miney provides an `Python <https://www.python.org/>`_ interface to `Minetest <https://www.minetest.net/>`_.
|
||
|
|
|
||
|
|
First goal is to have fun with a sandbox for Python.
|
||
|
|
|
||
|
|
**Do whatever you like:**
|
||
|
|
|
||
|
|
* Play and fiddle around while learning python
|
||
|
|
* Visualize data in unusual ways
|
||
|
|
* Automate things with bots
|
||
|
|
* Connect minetest to external services like twitter, ebay or whatsoever
|
||
|
|
* Do whatever you want!
|
||
|
|
|
||
|
|
.. important::
|
||
|
|
|
||
|
|
For the best way to get everything running, take a look at the :doc:`quickstart` page.
|
||
|
|
|
||
|
|
.. warning::
|
||
|
|
|
||
|
|
Miney is currently in beta, so it's usable but the API may change at any point.
|
||
|
|
|
||
|
|
Why Python?
|
||
|
|
-------------
|
||
|
|
|
||
|
|
.. image:: python-logo.png
|
||
|
|
:alt: Python logo
|
||
|
|
:align: right
|
||
|
|
Some marketing text from the `Python website <https://www.python.org/about/>`_:
|
||
|
|
|
||
|
|
| Python is powerful... and fast;
|
||
|
|
| plays well with others;
|
||
|
|
| runs everywhere;
|
||
|
|
| is friendly & easy to learn;
|
||
|
|
| is Open.
|
||
|
|
|
||
|
|
These are some of the reasons people who use Python would rather not use anything else.
|
||
|
|
|
||
|
|
And it's popular! And cause of that it has a `giant package index <https://pypi.org/>`_ filled by over 400.000 users!
|
||
|
|
|
||
|
|
|
||
|
|
Why Minetest?
|
||
|
|
---------------
|
||
|
|
.. image:: minetest-logo.png
|
||
|
|
:alt: Python logo
|
||
|
|
:align: left
|
||
|
|
|
||
|
|
Why not Minecraft? Minetest is free. Not only you don't have to pay for Minetest (consider to `donate <https://www.minetest.net/get-involved/#donate>`_!), it's also open source!
|
||
|
|
That's a big point, if you try to use this for example in a classroom.
|
||
|
|
|
||
|
|
Also modding for minecraft isn't that easy, cause there is no official API or an embedded scripting language like Lua
|
||
|
|
in Minetest. Mods have to be written in Java, but have to be recompiled on every Minecraft update.
|
||
|
|
Cause of that many attempt for APIs appeared and disappeared in recent years.
|
||
|
|
|
||
|
|
In contrast Minetest modding in Lua is easy: no compilation, a official API and all game logic is also in Lua.
|
||
|
|
|
||
|
|
Table of Contents
|
||
|
|
-----------------
|
||
|
|
|
||
|
|
.. toctree::
|
||
|
|
:maxdepth: 1
|
||
|
|
:caption: Getting started
|
||
|
|
|
||
|
|
quickstart
|
||
|
|
|
||
|
|
.. toctree::
|
||
|
|
:maxdepth: 1
|
||
|
|
:caption: Reference
|
||
|
|
|
||
|
|
objects/index
|
||
|
|
helpers
|
||
|
|
tech_background
|
||
|
|
|
||
|
|
Miney version: |release|
|