.. image:: miney-logo.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 `Luanti <https://www.luanti.org/>`_.

First goal is to have fun with a 3D sandbox for Python.

**Do whatever you like:**

* Play and fiddle around while learning python
* Visualize data in unusual ways
* Automate things with bots
* Connect Luanti to external services like discord, twitch or whatsoever
* Do whatever you want!

.. raw:: html

   <a href="https://discord.gg/jCzZ7qs6ZT" class="sd-card sd-bg-primary sd-p-2 d-block" style="text-decoration: none; max-width: 250px; margin: 1em auto;">
      <div style="display: flex; align-items: center; justify-content: center; text-align: center;">
         <img src="_static/discord-logo.svg" alt="Discord Logo" width="40" style="margin: 10px;">
         <strong style="color: white;">Join the Miney community on Discord</strong>
      </div>
   </a>

.. important::

   For the best way to get everything running, take a look at the :doc:`getting_started/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 450.000 users!


Why Luanti?
---------------
.. image:: minetest-logo.png
   :alt: Luanti logo
   :align: left

Why not Minecraft? Luanti is free. Not only you don't have to pay for Luanti (consider to `donate <https://www.luanti.org/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 Luanti. 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 Luanti modding in Lua is easy: no compilation, a official API and all game logic is also in Lua.

Support Miney
---------------------

.. raw:: html

    <center><script type="text/javascript" src="https://cdnjs.buymeacoffee.com/1.0.0/button.prod.min.js" data-name="bmc-button" data-slug="miney" data-color="#FF5F5F" data-emoji=""  data-font="Lato" data-text="Buy me a coffee" data-outline-color="#000000" data-font-color="#ffffff" data-coffee-color="#FFDD00" ></script></center>

Table of Contents
-----------------

.. toctree::
   :caption: Getting started

   getting_started/quickstart
   getting_started/basics

.. toctree::
   :caption: Examples

   examples

.. toctree::
   :caption: Reference

   api/index
   changelog
   tech_background

Miney version: |release|