mc-shell 0.7.2__tar.gz → 0.8.1__tar.gz

{mc_shell-0.7.2 → mc_shell-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mc-shell
-Version: 0.7.2
+Version: 0.8.1
 Summary: An interactive shell and editor for controlling Minecraft servers and creating powers.
 License-File: LICENSE
 Author: Jeff
@@ -13,9 +13,8 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: beautifulsoup4
-Requires-Dist: blockapily
+Requires-Dist: blockapily (>=0.3.1,<0.4.0)
 Requires-Dist: click
-Requires-Dist: eventlet (>=0.40.2,<0.41.0)
 Requires-Dist: flask
 Requires-Dist: flask-cors
 Requires-Dist: flask-socketio
@@ -69,7 +68,7 @@ This guide will get you running in just a few minutes. Each step is linked to a
 ### Installation
 
 Before you begin, you will need a few things installed on your system (Linux, macOS, or Windows Subsystem for Linux):
-* **Python** (version 3.9 or higher)
+* **Python** (version 3.10 or higher)
 
 Once the prerequisites are met, run the following commands in your terminal to download and install the project and all its dependencies. Note the recommended  
 `--user` option: this will install in `~/.local/bin` so make sure your `PATH` includes this directory! And notice the package is called `mc-shell` but the
@@ -104,11 +103,25 @@ This section covers all the `%pp_` commands for managing your personal Paper ser
 
 ### Creating and Listing Worlds
 
-To create a new, self-contained world, use the `%pp_create_world` command. This will create a new folder in your home directory (`~/mc-worlds`), download the appropriate Paper server, and set up all the necessary configuration files. The current default version (which the client must match) is `1.21.4`.
+To create a new, self-contained world, use the `%pp_create_world` command. This will create a new folder in your home directory (`~/mc-worlds`), download the appropriate Paper server, and set up all the necessary configuration files. The current default version (which the client must match) is `1.21.11` but you can specify any version you want with the `--version` option, for example `1.21.4`.
 ```ipython
 %pp_create_world my_creative_build --version=1.21.4
 ```
 
+You can apply any set of datapacks that appear in your `~/mc-worlds/datapacks-library` directory. `mc-shell` ships with three datapacks: `flat_world`,`void_world` and a version of *OneBlock* by [IJAMinecraft](https://ijaminecraft.com/map/oneblock/) called `oneblock`. 
+
+To create a totally flat world, use the following command:
+```ipython
+%pp_create_world my_flat_creative_build --datapacks=flat_world
+```
+To create a *OneBlock* world, use the following command. Note we overlay the void datapack to clear the world.
+```ipython
+%pp_create_world my_OneBlock --datapacks=void_world,oneblock
+```
+You can download and apply any datapack you want by unzip it to a folder inside `~/mc-worlds/datapacks-library` and then passing the name of the folder to the `--datapacks` option as described above.
+
+You can also add *PaperMC* plugins to your `~/mc-worlds/<world_name>/plugins` folder.
+
 To see a list of all the worlds you have created, use the `%pp_list_worlds` command.
 
 ### Starting and Stopping Worlds
@@ -164,6 +177,6 @@ The Control Panel is a touch-friendly UI for executing your saved powers in-game
 
 The interface has two modes:
 
-  * **Run Mode:** The main grid displays your power "widgets." If a power has parameters, the widget will have interactive controls like sliders or pickers. Simply set the parameters and click "Execute."
+  * **Run Mode:** The main grid displays your power "widgets." If a power has parameters, a long press on the widget will make interactive controls like sliders or pickers appear. Simply set the parameters and click 'Load Configuration.' Then a quick press of the widget will execute that power.
   * **Edit Mode:** Click "Edit Layout" to customize your grid. You can open a library of all your saved powers, add them as new widgets to your grid, and drag-and-drop them to arrange your layout.
 

{mc_shell-0.7.2 → mc_shell-0.8.1}/README.md

@@ -34,7 +34,7 @@ This guide will get you running in just a few minutes. Each step is linked to a
 ### Installation
 
 Before you begin, you will need a few things installed on your system (Linux, macOS, or Windows Subsystem for Linux):
-* **Python** (version 3.9 or higher)
+* **Python** (version 3.10 or higher)
 
 Once the prerequisites are met, run the following commands in your terminal to download and install the project and all its dependencies. Note the recommended  
 `--user` option: this will install in `~/.local/bin` so make sure your `PATH` includes this directory! And notice the package is called `mc-shell` but the
@@ -69,11 +69,25 @@ This section covers all the `%pp_` commands for managing your personal Paper ser
 
 ### Creating and Listing Worlds
 
-To create a new, self-contained world, use the `%pp_create_world` command. This will create a new folder in your home directory (`~/mc-worlds`), download the appropriate Paper server, and set up all the necessary configuration files. The current default version (which the client must match) is `1.21.4`.
+To create a new, self-contained world, use the `%pp_create_world` command. This will create a new folder in your home directory (`~/mc-worlds`), download the appropriate Paper server, and set up all the necessary configuration files. The current default version (which the client must match) is `1.21.11` but you can specify any version you want with the `--version` option, for example `1.21.4`.
 ```ipython
 %pp_create_world my_creative_build --version=1.21.4
 ```
 
+You can apply any set of datapacks that appear in your `~/mc-worlds/datapacks-library` directory. `mc-shell` ships with three datapacks: `flat_world`,`void_world` and a version of *OneBlock* by [IJAMinecraft](https://ijaminecraft.com/map/oneblock/) called `oneblock`. 
+
+To create a totally flat world, use the following command:
+```ipython
+%pp_create_world my_flat_creative_build --datapacks=flat_world
+```
+To create a *OneBlock* world, use the following command. Note we overlay the void datapack to clear the world.
+```ipython
+%pp_create_world my_OneBlock --datapacks=void_world,oneblock
+```
+You can download and apply any datapack you want by unzip it to a folder inside `~/mc-worlds/datapacks-library` and then passing the name of the folder to the `--datapacks` option as described above.
+
+You can also add *PaperMC* plugins to your `~/mc-worlds/<world_name>/plugins` folder.
+
 To see a list of all the worlds you have created, use the `%pp_list_worlds` command.
 
 ### Starting and Stopping Worlds
@@ -129,5 +143,5 @@ The Control Panel is a touch-friendly UI for executing your saved powers in-game
 
 The interface has two modes:
 
-  * **Run Mode:** The main grid displays your power "widgets." If a power has parameters, the widget will have interactive controls like sliders or pickers. Simply set the parameters and click "Execute."
+  * **Run Mode:** The main grid displays your power "widgets." If a power has parameters, a long press on the widget will make interactive controls like sliders or pickers appear. Simply set the parameters and click 'Load Configuration.' Then a quick press of the widget will execute that power.
   * **Edit Mode:** Click "Edit Layout" to customize your grid. You can open a library of all your saved powers, add them as new widgets to your grid, and drag-and-drop them to arrange your layout.

{mc_shell-0.7.2 → mc_shell-0.8.1}/mcshell/Vec3.py

@@ -49,6 +49,9 @@ class Vec3:
     def __iter__(self):
         return iter((self.x, self.y, self.z))
 
+    def clone(self):
+        return Vec3(self.x, self.y, self.z)
+
     def to_tuple(self):
         return self.x,self.y,self.z
 

{mc_shell-0.7.2 → mc_shell-0.8.1}/mcshell/__init__.py

@@ -1,6 +1,5 @@
 import socket
 from pprint import pprint
-from threading import Thread,Event
 
 import IPython
 import getpass
@@ -21,6 +20,7 @@ from mcshell.mcserver import stop_app_server
 from mcshell.mcplayer import MCPlayer
 
 import atexit
+from threading import Thread,Event
 
 @magics_class
 class MCShell(Magics):
@@ -31,7 +31,8 @@ class MCShell(Magics):
         self.ip = IPython.get_ipython()
 
         try:
-            _mc_cmd_docs = pickle.load(MC_DOC_PATH.open('rb'))
+            with MC_DOC_PATH.open('rb') as f:
+                _mc_cmd_docs = pickle.load(f)
         except FileNotFoundError:
             from mcshell.mcscraper import make_docs
             _mc_cmd_docs = make_docs()
@@ -157,7 +158,7 @@ class MCShell(Magics):
             # Capturing strings first ensures we don't crash on int('')
             resp_port = Prompt.ask('Server Port:', default=str(self.server_data['port']))
             resp_rcon = Prompt.ask('RCON Port:', default=str(self.server_data['rcon_port']))
-            resp_fj   = Prompt.ask('FruitJuice Port:', default=str(self.server_data['fj_port']))
+            resp_fj   = Prompt.ask('McJuice Port:', default=str(self.server_data['fj_port']))
             resp_app  = Prompt.ask('Application Port:', default=str(self.server_data['app_port']))
 
             # Robust casting logic
@@ -226,12 +227,6 @@ class MCShell(Magics):
                 "rcon.password": self.server_data.get('password'),
                 "enable-command-block":'true',
             },
-            "FruitJuice" : {
-                "hostname": "0.0.0.0",
-                "port": self.server_data.get('fj_port',FJ_PLUGIN_PORT),
-                "location": "ABSOLUTE",
-                "hitclick": "LEFT",
-            },
             "paper": {
                 "packet-limiter": {
                     "all-packets": {
@@ -257,8 +252,8 @@ class MCShell(Magics):
             print(f"Error: Could not write world_manifest.json file. {e}")
             return
 
-        # Always install FruitJuice from bundled version
-        plugins_dir.joinpath(FJ_JAR_PATH.name).symlink_to(FJ_JAR_PATH)
+        # Always install McJuice from bundled version
+        plugins_dir.joinpath(MC_JUICE_JAR_PATH.name).symlink_to(MC_JUICE_JAR_PATH)
 
         # Install the plugins listed in the manifest
         plugin_urls = manifest.get("plugins", [])
@@ -894,57 +889,90 @@ class MCShell(Magics):
     @line_magic
     def mc_debug_and_define(self, line):
         """
-        Receives code and metadata from the editor, and starts it in a
-        background thread for debugging.
+        Receives code and metadata from the editor, dynamically imports it,
+        constructs the execution context, and runs it safely in a background thread.
         """
         try:
+            # 1. Parse JSON payload from the editor
             payload = json.loads(line)
             code_to_execute = payload.get("code")
             metadata = payload.get("metadata", {})
 
-            try:
-                # Create a unique filename for the power
-                power_dir = pathlib.Path("./powers/blockcode")
-                power_dir.mkdir(parents=True, exist_ok=True)
-
-                # Generate a unique suffix for the filename
-                file_hash = uuid.uuid4().hex[:6]
-                filename = f"power_{file_hash}.py"
-                filepath = power_dir / filename
+            # 2. Setup the directory and file
+            power_dir = pathlib.Path("./powers/blockcode")
+            power_dir.mkdir(parents=True, exist_ok=True)
+            (power_dir / "__init__.py").touch(exist_ok=True)
 
-                with open(filepath, 'w') as f:
-                    f.write(code_to_execute)
+            file_hash = uuid.uuid4().hex[:6]
+            filename = f"power_{file_hash}.py"
+            filepath = power_dir / filename
 
-                print(f"Successfully saved power to: {filepath}")
-                print(f"To use it, you can now run:\nfrom powers.blockcode.{filename.replace('.py','')} import *")
+            # 3. Save the generated code
+            with open(filepath, 'w') as f:
+                f.write(code_to_execute)
 
-            except Exception as e:
-                print(f"Error saving script: {e}")
+            print(f"Successfully saved power to: {filepath}")
+            print(f"To use it, you can now run:\nfrom powers.blockcode.{filename.replace('.py','')} import *")
 
+            # 4. Initialize Player & Context
             player_name = self._get_mc_name()
-            server_data = self.server_data
+            player = self._get_player(player_name)
 
-            # --- Start the power in a background thread ---
-            execution_id = f"debug_{uuid.uuid4().hex[:6]}" # Special ID for debug runs
-            cancel_event = Event()
+            # Setup cancellation support and bind to the player for blocking operations
+            cancel_event = threading.Event()
+            player.cancel_event = cancel_event
 
-            thread = Thread(target=execute_power_in_thread, args=(
-                f"user-power-{execution_id}",execution_id, code_to_execute, player_name, server_data, {}, cancel_event
-            ))
-            thread.daemon = True
-            thread.start()
+            actions = MCActions(player)
 
-            RUNNING_POWERS[execution_id] = {'thread': thread, 'cancel_event': cancel_event}
+            # 5. Dynamically Import the Module
+            module_name = f"powers.blockcode.power_{file_hash}"
+            if module_name in sys.modules:
+                module = sys.modules[module_name]
+                importlib.reload(module)
+            else:
+                module = importlib.import_module(module_name)
 
-            if RUNNING_POWERS:
-                print(f"--- Power '{metadata.get('function_name')}' metadata defined/updated. ---")
-                print(f"--- Started debug execution with ID: {execution_id} ---")
-                # ADD THIS LINE: A specific prefix for the frontend to find
-                print(f"MCED_EXECUTION_ID:{execution_id}")
-                print("--- To stop it, run: %mc_cancel_power " + execution_id + " ---")
+            # 6. Instantiate the Runner
+            runner = module.BlocklyProgramRunner(actions, cancel_event=cancel_event)
+
+            # 7. Define the Thread Execution Wrapper
+            execution_id = f"debug_{file_hash}"
+            def run_task():
+                try:
+                    runner.run_program()
+                except Exception as e:
+                    # Ignore PowerCancelledException which is a normal, clean exit
+                    if type(e).__name__ != "PowerCancelledException":
+                        import traceback
+                        print(f"\n--- Error executing {execution_id}: {e} ---")
+                        traceback.print_exc()
+                finally:
+                    # Automatically remove from running registry when done
+                    if execution_id in RUNNING_POWERS:
+                        del RUNNING_POWERS[execution_id]
+
+            # 8. Start Thread and Update Registry
+            thread = threading.Thread(target=run_task, daemon=True)
+
+            RUNNING_POWERS[execution_id] = {
+                'thread': thread,
+                'cancel_event': cancel_event,
+                'power_id': metadata.get('id', file_hash),
+                'start_time': time.time()
+            }
+
+            thread.start()
+
+            print(f"--- Power '{metadata.get('function_name', 'None')}' metadata defined/updated. ---")
+            print(f"--- Started debug execution with ID: {execution_id} ---")
+            # The editor explicitly looks for this string format to hook its STOP button
+            print(f"MCED_EXECUTION_ID:{execution_id}")
+            print(f"--- To stop it, run: %mc_cancel_power {execution_id} ---")
 
         except Exception as e:
-            print(f"An unexpected error occurred: {e}")
+            import traceback
+            print(f"An unexpected error occurred during execution setup: {e}")
+            traceback.print_exc()
 
     def _complete_mc_cancel_power(self, ipyshell, event):
         text = event.symbol
@@ -967,29 +995,18 @@ class MCShell(Magics):
         execution_id = line.strip()
         if not execution_id:
             print("Usage: %mc_cancel_power <execution_id>")
-            print("Currently running powers:", list(RUNNING_POWERS.keys()))
+            if RUNNING_POWERS:
+                print("Currently running powers:", list(RUNNING_POWERS.keys()))
             return
 
-        # Lookup the execution metadata in the global registry
         power_metadata = RUNNING_POWERS.get(execution_id)
-
         if power_metadata:
             print(f"Sending cancellation signal to power: {execution_id}")
-            # Corrected Key: Simply 'cancel_event'
+            # Corrected attribute access (removed paste garbage)
             power_metadata['cancel_event'].set()
         else:
             print(f"Error: No running power found with ID: {execution_id}")
 
-        # @line_magic
-        # def mc_start_debug(self, line):
-        #     """Starts the debug mcserver in a separate thread."""
-        #     start_debug_server()
-        #
-        # @line_magic
-        # def mc_stop_debug(self, line):
-        #     """Stops the debug mcserver thread."""
-        #     stop_debug_server()
-
     def _get_mc_name(self) -> Optional[str]:
         """
         Determines and caches the Minecraft username for the current session.

{mc_shell-0.7.2 → mc_shell-0.8.1}/mcshell/blueprints/powers_api.py

@@ -2,18 +2,11 @@ import os
 import json
 from flask import Blueprint, request, jsonify, make_response, current_app, render_template_string, session, send_file
 
-from mcshell.constants import MC_CONTROL_LAYOUT_PATH
+# from mcshell.constants import MC_CONTROL_LAYOUT_PATH
 
 # 1. Create a Blueprint instance.
-#    'powers_api' is the name of the blueprint.
-#    __name__ helps Flask locate the blueprint.
-#    url_prefix='/api' automatically prepends '/api' to all routes in this file.
 powers_bp = Blueprint('powers_api', __name__, url_prefix='/api')
 
-
-# 2. Move your power-related routes here.
-#    Note that the decorator is now @powers_bp.route(...) instead of @app.route(...)
-
 @powers_bp.route('/powers', methods=['POST'])
 def save_new_power():
     """Saves a new power or updates an existing one."""
@@ -34,62 +27,44 @@ def save_new_power():
             "closeSaveModal": True
         }
         headers = {"HX-Trigger": json.dumps(trigger_data)}
-        return jsonify({"success": True, "power_id": power_id}), 201, headers
+        return "", 204, headers
     except Exception as e:
-        print(f"Error saving power for player {player_id}: {e}")
-        return jsonify({"error": "An internal error occurred while saving the power."}), 500
-
-# NEW ENDPOINT TO SERVE THE LAYOUT DEFINITION
-@powers_bp.route('/control/layout', methods=['GET'])
-def get_control_layout():
-    # In a real app, this would load the layout for the specific player
-    # For now, it reads a static file.
-    try:
-        # Assuming control_layout.json is in the project root
-        return send_file(MC_CONTROL_LAYOUT_PATH, mimetype='application/json')
-    except FileNotFoundError:
-        print(f"{MC_CONTROL_LAYOUT_PATH} not found!")
-        # Return a default empty layout if the file doesn't exist
-        return jsonify({"grid": {"columns": 4}, "widgets": []})
-
+        print(f"Error saving power: {e}")
+        return jsonify({"error": "Internal error"}), 500
 
 @powers_bp.route('/powers', methods=['GET'])
-def get_powers_list():
-    """
-    Gets the list of saved powers and renders the appropriate HTML fragment
-    based on the 'view' query parameter ('editor' or 'control').
-    """
-    view_type = request.args.get('view', 'editor')
-
-    player_id = current_app.config.get('MINECRAFT_PLAYER_NAME')
+def get_powers():
+    """Returns powers either as JSON dict or as HTMX-ready HTML based on request args."""
     power_repo = current_app.config.get('POWER_REPO')
-
+    player_id = current_app.config.get('MINECRAFT_PLAYER_NAME')
+    
     if not player_id or not power_repo:
         return "<p>Error: Not authorized</p>", 401
 
-    powers_summary_list = power_repo.list_powers()
-
-    # Group powers by category (logic remains the same)
-    powers_by_category = {}
-    for power in powers_summary_list:
-        category = power.get('category', 'Uncategorized')
-        if category not in powers_by_category:
-            powers_by_category[category] = []
-        powers_by_category[category].append(power)
+    view_type = request.args.get('view', 'editor')
 
-    # --- Select the correct template based on the view type ---
     if view_type == 'control':
-
-        # Call the new method to get all data needed for the control UI
+        # Serve JSON payload for the Control Deck UI
         all_powers_list = power_repo.list_full_powers()
-        # Convert the list into a dictionary keyed by power_id for easy lookup on the client
         powers_dict = {p['power_id']: p for p in all_powers_list if 'power_id' in p}
-
         print(f"Serving full power data dictionary for player '{player_id}' for control UI.")
         return jsonify(powers_dict)
 
-    else:  # Default to the 'editor' view
-        # Use the detailed template for the editor sidebar
+    else:
+        # Default to serving the detailed HTML list for the Editor Sidebar
+        powers_summary_list = power_repo.list_powers()
+
+        if not powers_summary_list:
+            return "<p style='padding: 0 8px; color: #888;'>No powers found.</p>"
+
+        # Group powers by category to support the Editor's sidebar template
+        categories = {}
+        for power in powers_summary_list:
+            category = power.get('category', 'Uncategorized')
+            if category not in categories:
+                categories[category] = []
+            categories[category].append(power)
+
         template_string = """
         {% for category, powers in categories.items()|sort %}
           <div class="power-category" x-data="{ open: true }">
@@ -125,7 +100,7 @@ def get_powers_list():
                       <button class="btn-small btn-danger"
                               @click="$dispatch('open-delete-confirm', {
                                   powerId: '{{ power.power_id }}',
-                                  powerName: '{{ power.name | replace("'", "\\'") }}'
+                                  powerName: '{{ power.name | replace(\"'\", \"\\\\'\") }}'
                               })">
                           Delete
                       </button>
@@ -137,59 +112,30 @@ def get_powers_list():
           </div>
         {% endfor %}
         """
-        html_response_string = render_template_string(template_string, categories=powers_by_category)
-
-    # Create the final response with no-cache headers
-    response = make_response(html_response_string)
-    response.headers['Cache-Control'] = 'no-cache, no-store, must-revalidate'
-    response.headers['Expires'] = '0'
-    return response
-
+        return render_template_string(template_string, categories=categories)
 
 @powers_bp.route('/power/<power_id>', methods=['GET'])
-def get_power_detail(power_id):
-    """
-    Gets the full JSON data for a single power, used by the editor to load
-    a workspace. The data is returned in an HX-Trigger header.
-    """
-    mode = request.args.get('mode', 'replace')
-
-    player_id = current_app.config.get('MINECRAFT_PLAYER_NAME')
+def get_power_by_id(power_id):
+    """Fetches a single power's details and triggers a load event in the frontend via HTMX."""
     power_repo = current_app.config.get('POWER_REPO')
+    if not power_repo:
+        return jsonify({"error": "Repository not configured"}), 500
 
-    if not player_id or not power_repo:
-        # Handle error case
-        err_trigger = {"showError": {"errorMessage": "Server or player not configured."}}
-        return make_response("", 401, {"HX-Trigger": json.dumps(err_trigger)})
-
-    full_power_data = power_repo.get_full_power(power_id)
-
-    if not full_power_data:
-        err_trigger = {"showError": {"errorMessage": f"Power with ID {power_id} not found."}}
-        return make_response("", 404, {"HX-Trigger": json.dumps(err_trigger)})
-
-    # --- NEW: If replacing, set this as the current power in the session ---
-    if mode == 'replace':
-        session['current_power'] = {
-            "power_id": power_id,
-            "name": full_power_data.get("name"),
-            "description": full_power_data.get("description"),
-            "category": full_power_data.get("category")
-        }
-    # --- The Htmx Event Trigger Response ---
-    # We are defining a custom event 'loadPower' and passing the full power data
-    # and the loading 'mode' inside the event's detail.
+    power_data = power_repo.get_full_power(power_id)
+    if not power_data:
+        return jsonify({"error": "Power not found"}), 404
+
+    mode = request.args.get('mode', 'replace')
+    
+    # Send the full blockly data back as an HX-Trigger event parameter
     trigger_data = {
         "loadPower": {
-            "powerData": full_power_data,
-            "mode": mode # Signal to the client to replace the workspace
+            "powerData": power_data,
+            "mode": mode
         }
     }
-
     headers = {"HX-Trigger": json.dumps(trigger_data)}
-
-    # We don't need to send a body, just the trigger header. Status 204 No Content is perfect.
-    return "", 204, headers
+    return "", 200, headers
 
 
 @powers_bp.route('/power/<power_id>', methods=['DELETE'])
@@ -204,11 +150,8 @@ def delete_power_by_id(power_id):
     try:
         success = power_repo.delete_power(power_id)
         if success:
-            # Instead of an empty response, we now trigger the 'library-changed' event.
             trigger_data = {"library-changed": f"Power {power_id} was deleted."}
             headers = {"HX-Trigger": json.dumps(trigger_data)}
-
-            # Return a 200 OK. The body can be empty. The header does the work.
             return "", 200, headers
         else:
             return jsonify({"error": "Power not found"}), 404
@@ -218,9 +161,7 @@ def delete_power_by_id(power_id):
 
 @powers_bp.route('/powers/categories', methods=['GET'])
 def get_categories():
-    # Ensure you are accessing the repository instance assigned during mc_start_app
-    from flask import current_app
-    repo = current_app.config.get('REPO')
+    repo = current_app.config.get('POWER_REPO') 
     if not repo:
         return jsonify(["Powers", "Workspaces"])
     return jsonify(repo.list_categories())