luanti_cli 2.0.4__tar.gz

luanti_cli-2.0.4/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

luanti_cli-2.0.4/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: luanti_cli
+Version: 2.0.4
+Summary: 📦️ LuCI - Luanti Commandline Interface
+License: LGPL
+License-File: COPYING.LESSER
+Author: Christian Decker
+Author-email: christian.decker@lookslikematrix.de
+Requires-Python: >=3.13,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: click (>=8.4.1,<9.0.0)
+Requires-Dist: miney (>=0.5.8,<0.6.0)
+Requires-Dist: numpy (>=2.4.6,<3.0.0)
+Requires-Dist: trimesh[easy] (>=4.12.2,<5.0.0)
+Description-Content-Type: text/markdown
+
+# 📦️ LuCI - Luanti Commandline Interface
+
+This Commandline Interface allows you to build CAD-Objects in [**luanti**](https://www.luanti.org/). For example the benchy from here: https://www.thingiverse.com/thing:763622. The game used to be called minetest, but now it's called luanti, so this description is a mixture of minetest and luanti.
+
+![Benchy](assets/benchy.png)
+
+It's depending on [`miney`](https://miney.readthedocs.io/en/latest/) a python interface for luanti. 
+
+## Usage
+
+Getting help.
+
+```bash
+luci --help
+```
+
+Build a CAD-Object in the STL format with `luci`.
+
+```bash
+luci build --help
+luci build data/some_stl_file.stl
+# get all wool blocks
+luci blocks --filter wool
+# build object with green wool
+luci build data/some_stl_file.stl --block-type wool:green
+# scale by factor 2
+luci build data/some_stl_file.stl --scale 2
+# build object at exact position. Default is at the players position.
+luci build data/some_stl_file.stl -x 100 -y 150 -z 50
+```
+
+Erase this CAD-Object.
+
+```bash
+luci erase --help
+luci erase data/some_stl_file.stl
+# erase scale by factor 2
+luci erase data/some_stl_file.stl --scale 2
+```
+
+
+## Installation
+
+If you like to use `luci` you have to follow this steps.
+
+1. Install **luanti** (see here: https://www.luanti.org/downloads/) and the `miney` mod. I use Debian and therefore install it like this:
+
+    ```bash
+    sudo apt update
+    sudo apt install luanti -y
+    ```
+
+    You should now be possible to start luanti.
+
+    ```bash
+    luanti
+    ```
+
+2. Install `luci` with pipx.
+
+    ```bash
+    sudo apt install pipx -y
+    pipx ensurepath
+    pipx install git+https://github.com/lookslikematrix/luci.git
+    pipx upgrade luci
+    ```
+
+3. (Optional) Install `Minetest Game` as the classic game. This is required in newer versions of `luanti`.
+
+    ![Install game](assets/install_game.png)
+
+    ![Minetest game](assets/install_minetest_game.png)
+
+    ![Install Button](assets/install_button.png)
+
+    You now can click twice *Back* and are ready to play `luanti` without `luci`.
+
+4. Create game, install `miney` mod, enable `miney` mod, enable server and start game.
+
+    ![New game](assets/new_game.png)
+
+    ![Create game](assets/create_game.png)
+
+    ![Select mods](assets/select_mods.png)
+
+    ![Find and install miney](assets/find_and_install_miney.png)
+
+    ![Select miney and save](assets/select_miney.png)
+
+    ![Enable host and start](assets/enable_host.png)
+
+5. Grant player `luci` all privileges.
+
+    - *Shift* + */*
+
+    - Type `/grant luci all`
+
+    - Hit enter.
+
+5. Build a STL-Object.
+
+    ```bash
+    luci build data/some_stl_file.stl
+    # and erase it
+    luci erase data/some_stl_file.stl
+    ```
+
+## Development
+
+```bash
+git clone https://github.com/lookslikematrix/luci
+cd luci
+sudo apt install pipx
+pipx install poetry
+poetry install
+poetry shell
+```
+
+---
+
+❤️ A thousand thanks to the developers of [`miney`](https://github.com/miney-py/miney) Python interface: https://github.com/miney-py
+
+❤️ Everyone is welcome to make a contribution to this project.
+

luanti_cli-2.0.4/README.md

@@ -0,0 +1,123 @@
+# 📦️ LuCI - Luanti Commandline Interface
+
+This Commandline Interface allows you to build CAD-Objects in [**luanti**](https://www.luanti.org/). For example the benchy from here: https://www.thingiverse.com/thing:763622. The game used to be called minetest, but now it's called luanti, so this description is a mixture of minetest and luanti.
+
+![Benchy](assets/benchy.png)
+
+It's depending on [`miney`](https://miney.readthedocs.io/en/latest/) a python interface for luanti. 
+
+## Usage
+
+Getting help.
+
+```bash
+luci --help
+```
+
+Build a CAD-Object in the STL format with `luci`.
+
+```bash
+luci build --help
+luci build data/some_stl_file.stl
+# get all wool blocks
+luci blocks --filter wool
+# build object with green wool
+luci build data/some_stl_file.stl --block-type wool:green
+# scale by factor 2
+luci build data/some_stl_file.stl --scale 2
+# build object at exact position. Default is at the players position.
+luci build data/some_stl_file.stl -x 100 -y 150 -z 50
+```
+
+Erase this CAD-Object.
+
+```bash
+luci erase --help
+luci erase data/some_stl_file.stl
+# erase scale by factor 2
+luci erase data/some_stl_file.stl --scale 2
+```
+
+
+## Installation
+
+If you like to use `luci` you have to follow this steps.
+
+1. Install **luanti** (see here: https://www.luanti.org/downloads/) and the `miney` mod. I use Debian and therefore install it like this:
+
+    ```bash
+    sudo apt update
+    sudo apt install luanti -y
+    ```
+
+    You should now be possible to start luanti.
+
+    ```bash
+    luanti
+    ```
+
+2. Install `luci` with pipx.
+
+    ```bash
+    sudo apt install pipx -y
+    pipx ensurepath
+    pipx install git+https://github.com/lookslikematrix/luci.git
+    pipx upgrade luci
+    ```
+
+3. (Optional) Install `Minetest Game` as the classic game. This is required in newer versions of `luanti`.
+
+    ![Install game](assets/install_game.png)
+
+    ![Minetest game](assets/install_minetest_game.png)
+
+    ![Install Button](assets/install_button.png)
+
+    You now can click twice *Back* and are ready to play `luanti` without `luci`.
+
+4. Create game, install `miney` mod, enable `miney` mod, enable server and start game.
+
+    ![New game](assets/new_game.png)
+
+    ![Create game](assets/create_game.png)
+
+    ![Select mods](assets/select_mods.png)
+
+    ![Find and install miney](assets/find_and_install_miney.png)
+
+    ![Select miney and save](assets/select_miney.png)
+
+    ![Enable host and start](assets/enable_host.png)
+
+5. Grant player `luci` all privileges.
+
+    - *Shift* + */*
+
+    - Type `/grant luci all`
+
+    - Hit enter.
+
+5. Build a STL-Object.
+
+    ```bash
+    luci build data/some_stl_file.stl
+    # and erase it
+    luci erase data/some_stl_file.stl
+    ```
+
+## Development
+
+```bash
+git clone https://github.com/lookslikematrix/luci
+cd luci
+sudo apt install pipx
+pipx install poetry
+poetry install
+poetry shell
+```
+
+---
+
+❤️ A thousand thanks to the developers of [`miney`](https://github.com/miney-py/miney) Python interface: https://github.com/miney-py
+
+❤️ Everyone is welcome to make a contribution to this project.

luanti_cli-2.0.4/luci/__main__.py

@@ -0,0 +1,237 @@
+import logging
+
+from pathlib import Path
+
+import click
+import trimesh
+import miney
+import numpy as np
+
+def get_object_matrix(filename: str, scale: float):
+    stl_file = Path(filename)
+    click.echo("[%s] 📃 Read STL file." % stl_file.absolute())
+    stl_mesh = trimesh.load_mesh(stl_file)
+
+    click.echo("🎲 Create a matrix from the STL file.")
+    if scale == 0:
+        raise ValueError("[%s] scale could not be zero." % scale)
+    logging.debug("[%s] scale value." % scale)
+    voxel_size = 1 / scale
+    voxelized = stl_mesh.voxelized(voxel_size)
+    voxel_matrix = voxelized.matrix
+
+    click.echo("🌍️ Object shape: %s, %s, %s (x, y, z)." % (voxel_matrix.shape))
+    x_dim = voxel_matrix.shape[0]
+    y_dim = voxel_matrix.shape[1]
+    z_dim = voxel_matrix.shape[2]
+    pixels = x_dim * y_dim * z_dim
+    click.echo("🧪 We have to check %s pixels." % pixels)
+
+    # create a 4xN matrix
+    x_coords, y_coords, z_coords = np.indices((x_dim, y_dim, z_dim))
+    x_flat = x_coords.flatten()
+    y_flat = y_coords.flatten()
+    z_flat = z_coords.flatten()
+    values_flat = voxel_matrix.flatten()
+    four_x_n_marix = np.vstack((x_flat, y_flat, z_flat, values_flat))
+
+    # create rotation matrix
+    rotation_matrix = np.matrix([
+        [1, 0, 0],
+        [0, 0, -1],
+        [0, 1, 0]
+    ])
+
+    # multiply with rotation matrix
+    rotated_three_x_n_matrix = np.dot(four_x_n_marix[:3].T, rotation_matrix).T
+
+    # separate air and object
+    object_values = four_x_n_marix[3, :]
+    # Find indices where the value is 1
+    object_indices = np.where(object_values == 1)[0]
+
+    object_matrix = rotated_three_x_n_matrix[:3, object_indices]
+    click.echo("[ %s ] object pixels." % len(object_indices))
+    return object_matrix
+
+def build_voxels(lt, position: miney.Point, matrix, block_type):
+    x = round(position.x)
+    y = round(position.y)
+    z = round (position.z)
+    batch_size = 8000
+    batches = list()
+    batch_index = 0
+    max_batches = matrix.T.shape[0] // batch_size + 1
+    click.echo("[ %s ] block type." % block_type )
+    for object_pixel in matrix.T:
+        if len(batches) > batch_size:
+            batch_index += 1
+            click.echo("[ %s/%s ] batch index." % (batch_index, max_batches))
+            lt.nodes.set(batches)
+            batches = list()
+        node = miney.Node(
+            int(object_pixel[0, 0] + x),
+            int(object_pixel[0, 1] + y),
+            int(object_pixel[0, 2] + z),
+            name=block_type
+        )
+        batches.append(node)
+    batch_index += 1
+    click.echo("[ %s/%s ] batch index." % (batch_index, max_batches))
+    lt.nodes.set(batches)
+
+@click.group()
+@click.option(
+    "--loglevel",
+    help="Set loglevel (default: WARNING)"
+)
+def cli(loglevel):
+    """📦️ LuCI - Luanti Commandline Interface 📦️
+
+    Read here for further information:\n
+        https://github.com/lookslikematrix/luci
+
+    If you've any issues report them here:\n
+        https://github.com/lookslikematrix/luci/issues/new
+    """
+    if loglevel:
+        logging.basicConfig(encoding='utf-8', level=loglevel)
+    else:
+        logging.disable(logging.CRITICAL)
+
+@cli.command()
+@click.argument('filename')
+@click.option(
+    "-s", "--scale",
+    help="Specifies how the object should be scaled.",
+    default=1,
+    show_default=True
+)
+@click.option(
+    "-b", "--block-type",
+    help="Specifies which block-type should be used for building.",
+    default="default:goldblock",
+    show_default=True
+)
+@click.option(
+    "-x",
+    type=int,
+    help="Specifies x-axes to start building."
+)
+@click.option(
+    "-y",
+    type=int,
+    help="Specifies y-axes to start building."
+)
+@click.option(
+    "-z",
+    type=int,
+    help="Specifies z-axes to start building."
+)
+def build(filename: str, scale: float, block_type: str, x: int, y:int, z: int):
+    """Build a STL file into Luanti.
+
+Example:
+
+    Build a STL file.
+        luci build path_to_stl_file.stl
+    """
+    object_matrix = get_object_matrix(filename, scale)
+    with miney.Luanti() as lt:
+        position = lt.players["luci"].position
+        if x is not None:
+            position.x = x
+        if y is not None:
+            position.y = y
+        if z is not None:
+            position.z = z
+        build_voxels(lt, position, object_matrix, block_type)
+
+
+@cli.command()
+@click.argument('filename')
+@click.option(
+    "-s", "--scale",
+    help="Specifies how the object should be scaled.",
+    default=1,
+    show_default=True
+)
+@click.option(
+    "-x",
+    type=int,
+    help="Specifies x-axes to start building."
+)
+@click.option(
+    "-y",
+    type=int,
+    help="Specifies y-axes to start building."
+)
+@click.option(
+    "-z",
+    type=int,
+    help="Specifies z-axes to start building."
+)
+def erase(filename: str, scale: float, x: int, y:int, z: int):
+    """Erase a STL file from Luanti.
+
+Example:
+
+    Erase a STL file.
+        luci erase path_to_stl_file.stl
+    """
+    object_matrix = get_object_matrix(filename, scale)
+    with miney.Luanti() as lt:
+        position = lt.players["luci"].position
+        if x is not None:
+            position.x = x
+        if y is not None:
+            position.y = y
+        if z is not None:
+            position.z = z
+        build_voxels(lt, position, object_matrix, "air")
+
+
+@cli.command()
+@click.option(
+    "-f", "--filter",
+    help="Defines a filter to reduce the output.",
+    default="default",
+    show_default=True
+)
+def blocks(filter):
+    """Get all block types from current Luanti game.
+
+Example:
+
+    Get all default blocks.
+        luci blocks
+
+    Get all blocks.
+        luci blocks --filter ""
+
+    Get all wools.
+        luci blocks --filter "wool"
+    """
+    with miney.Luanti() as lt:
+        for node_type in lt.nodes.names:
+            if filter in node_type:
+                click.echo("[ %s ] node type." % node_type)
+
+
+@cli.command()
+def info():
+    """Get info.
+
+Example:
+
+    Get infos.
+        luci info
+    """
+    with miney.Luanti() as lt:
+        position = lt.players["luci"].position
+        click.echo(f"x | {position.x}")
+        click.echo(f"y | {position.y}")
+        click.echo(f"z | {position.z}")
+
+if __name__ == '__main__':
+    cli()

luanti_cli-2.0.4/pyproject.toml

@@ -0,0 +1,22 @@
+[tool.poetry]
+name = "luanti_cli"
+packages = [{include = "*", from="luci"}]
+version = "2.0.4"
+description = "📦️ LuCI - Luanti Commandline Interface"
+authors = ["Christian Decker <christian.decker@lookslikematrix.de>"]
+license = "LGPL"
+readme = "README.md"
+
+[tool.poetry.scripts]
+luci = "luci.__main__:cli"
+
+[tool.poetry.dependencies]
+python = "^3.13"
+miney = "^0.5.8"
+numpy = "^2.4.6"
+trimesh = {extras = ["easy"], version = "^4.12.2"}
+click = "^8.4.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"