sm-blueprint-lib 0.0.11__tar.gz → 0.0.13__tar.gz

{sm_blueprint_lib-0.0.11 → sm_blueprint_lib-0.0.13}/PKG-INFO

@@ -1,10 +1,11 @@
 Metadata-Version: 2.4
 Name: sm_blueprint_lib
-Version: 0.0.11
+Version: 0.0.13
 Summary: Scrap Mechanic Library for Blueprint manipulation.
 Project-URL: Homepage, https://github.com/MauriceTZ/sm_blueprint_lib
 Project-URL: Issues, https://github.com/MauriceTZ/sm_blueprint_lib/issues
-Author-email: Maurice <mauriciotorrez00@gmail.com>
+Author: niknal357
+Author-email: Maurice <mauriciotorrez00@gmail.com>, lnventorsteve <dylanv60431@gmail.com>
 License-Expression: MIT
 License-File: LICENSE
 Classifier: Operating System :: OS Independent
@@ -20,6 +21,10 @@ Description-Content-Type: text/markdown
 ```sh
 pip install sm_blueprint_lib
 ```
+## Updating version
+```sh
+pip install --upgrade sm_blueprint_lib
+```
 ## Usage
 ```python
 import numpy as np

{sm_blueprint_lib-0.0.11 → sm_blueprint_lib-0.0.13}/README.md

@@ -5,6 +5,10 @@
 ```sh
 pip install sm_blueprint_lib
 ```
+## Updating version
+```sh
+pip install --upgrade sm_blueprint_lib
+```
 ## Usage
 ```python
 import numpy as np

sm_blueprint_lib-0.0.13/block_test.py

@@ -0,0 +1,16 @@
+from src.sm_blueprint_lib import *
+
+bp = Blueprint()
+
+
+ship = Block(SHAPEID.Spaceship_Block,(0,0,0),COLOR.Spaceship_Block)
+
+print(ship.color)
+print(ship.shapeId)
+print(ship.pos)
+
+wood = Block(SHAPEID.Wood_Block_1,(1,0,0),COLOR.Wood_Block_1)
+
+print(wood.color)
+print(wood.shapeId)
+print(wood.pos)

{sm_blueprint_lib-0.0.11 → sm_blueprint_lib-0.0.13}/pyproject.toml

@@ -4,10 +4,12 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sm_blueprint_lib"
-version = "0.0.11"
+version = "0.0.13"
 dependencies = ["numpy"]
 authors = [
   { name="Maurice", email="mauriciotorrez00@gmail.com" },
+  { name="lnventorsteve", email="dylanv60431@gmail.com" },
+  { name="niknal357" },
 ]
 description = "Scrap Mechanic Library for Blueprint manipulation."
 readme = "README.md"

sm_blueprint_lib-0.0.13/rot_tests.py

@@ -0,0 +1,27 @@
+from pprint import pp
+
+from src.sm_blueprint_lib import *
+
+bp = Blueprint()
+
+g0 = LogicGate((1, 0, 0), "ffffff")  # .rotate("up", "right")
+g1 = LogicGate((2, 0, 0), "ffffff").rotate("up", "left")
+g2 = LogicGate((3, 0, 0), "ffffff").rotate("up", "up")
+g3 = LogicGate((4, 0, 0), "ffffff").rotate("up", "down")
+g4 = LogicGate((5, 0, 0), "ffffff").rotate("up", "right")
+
+bp.add(g0,
+       g1,
+       g2,
+       g3,
+       g4,
+       # show the axis just for debugging
+       BarrierBlock((0, 0, -1), "ffffff", (1, 1, 1)),
+       BarrierBlock((1, -1, -1), "ff0000", (5, 3, 1)),
+       BarrierBlock((0, 1, -1), "00ff00", (1, 3, 1)),
+       BarrierBlock((0, 0, 0), "0000ff", (1, 1, 5)),
+       )
+path = r"C:\Users\mauri\AppData\Roaming\Axolot Games\Scrap Mechanic\User\User_76561198400983548\Blueprints\c35f6e4e-52cb-4b00-8afa-f0ffd3fbb012\blueprint.json"
+
+pp(bp)
+save_blueprint(bp, path)

{sm_blueprint_lib-0.0.11 → sm_blueprint_lib-0.0.13}/src/sm_blueprint_lib/__init__.py

@@ -1,3 +1,8 @@
+"""
+# sm_blueprint_lib
+asdasdasdasds
+"""
+
 from .blueprint import *
 from .body import *
 from .bounds import *
@@ -8,3 +13,5 @@ from .utils import *
 
 from .parts import *
 from .prebuilds import *
+from .rot import *
+from .bases import *

sm_blueprint_lib-0.0.13/src/sm_blueprint_lib/bases/__init__.py

@@ -0,0 +1,3 @@
+from .controllers import *
+from .joints import *
+from .parts import *

sm_blueprint_lib-0.0.13/src/sm_blueprint_lib/bases/controllers/__init__.py

@@ -0,0 +1,5 @@
+from .basecontroller import *
+from .baselogiccontroller import *
+from .logicgatecontroller import *
+from .sensorcontroller import *
+from .timercontroller import *

{sm_blueprint_lib-0.0.11 → sm_blueprint_lib-0.0.13}/src/sm_blueprint_lib/bases/controllers/sensorcontroller.py

@@ -7,7 +7,7 @@ from .basecontroller import BaseController
 class SensorController(BaseController):
     """Sensor's Controller
     """
-    audioEnable: bool
+    audioEnabled: bool
     buttonMode: bool
     color: str
     colorMode: bool
@@ -19,6 +19,6 @@ class SensorController(BaseController):
         if not isinstance(self.color, str):
             self.color = "%02X%02X%02X" % (
                 self.color[0], self.color[1], self.color[2])
-        self.audioEnable = bool(self.audioEnable)
+        self.audioEnabled = bool(self.audioEnabled)
         self.buttonMode = bool(self.buttonMode)
         self.colorMode = bool(self.colorMode)

sm_blueprint_lib-0.0.13/src/sm_blueprint_lib/bases/joints/__init__.py

@@ -0,0 +1,6 @@
+from .basejoint import *
+from .basejointcontroller import *
+from .pistonjoint import *
+from .pistonjointcontroller import *
+from .suspensionjoint import *
+from .suspensionjointcontroller import *

{sm_blueprint_lib-0.0.11 → sm_blueprint_lib-0.0.13}/src/sm_blueprint_lib/bases/joints/pistonjoint.py

@@ -10,4 +10,5 @@ class PistonJoint(BaseJoint):
 
     def __post_init__(self):
         super().__post_init__()
-        self.controller = PistonJointController(**self.controller)
+        if not isinstance(self.controller, PistonJointController):
+            self.controller = PistonJointController(**self.controller)

{sm_blueprint_lib-0.0.11 → sm_blueprint_lib-0.0.13}/src/sm_blueprint_lib/bases/joints/suspensionjoint.py

@@ -10,4 +10,5 @@ class SuspensionJoin(BaseJoint):
 
     def __post_init__(self):
         super().__post_init__()
-        self.controller = SuspensionJointController(**self.controller)
+        if not isinstance(self.controller, SuspensionJointController):
+            self.controller = SuspensionJointController(**self.controller)

sm_blueprint_lib-0.0.13/src/sm_blueprint_lib/bases/parts/__init__.py

@@ -0,0 +1,4 @@
+from .baseboundablepart import *
+from .baseinteractablepart import *
+from .baselogicpart import *
+from .basepart import *

{sm_blueprint_lib-0.0.11 → sm_blueprint_lib-0.0.13}/src/sm_blueprint_lib/bases/parts/baseboundablepart.py

@@ -2,16 +2,13 @@ from dataclasses import dataclass, field
 
 from .basepart import BasePart
 from ...bounds import Bounds
-from ...constants import AXIS
 
 
 @dataclass
 class BaseBoundablePart(BasePart):
     """Base class for all Boundable parts (those that are draggable)
     """
-    bounds: Bounds
-    xaxis: int = field(kw_only=True, default=AXIS.DEFAULT_XAXIS)
-    zaxis: int = field(kw_only=True, default=AXIS.DEFAULT_ZAXIS)
+    bounds: Bounds = field(kw_only=True, default=(1,1,1))
 
     def __post_init__(self):
         super().__post_init__()

{sm_blueprint_lib-0.0.11 → sm_blueprint_lib-0.0.13}/src/sm_blueprint_lib/bases/parts/baseinteractablepart.py

@@ -3,6 +3,7 @@ from dataclasses import dataclass, field
 from ..controllers.basecontroller import BaseController
 from .basepart import BasePart
 from ...id import ID
+from ...constants import AXIS
 
 
 @dataclass
@@ -10,6 +11,8 @@ class BaseInteractablePart(BasePart):
     """Base class for Interactable parts
     """
     controller: BaseController = field(default_factory=BaseController)
+    xaxis: int = field(kw_only=True, default=AXIS.DEFAULT_XAXIS_INTERACTABLE)
+    zaxis: int = field(kw_only=True, default=AXIS.DEFAULT_ZAXIS_INTERACTABLE)
 
     def connect(self, o: "BaseInteractablePart"):
         if not self.controller.controllers:

{sm_blueprint_lib-0.0.11 → sm_blueprint_lib-0.0.13}/src/sm_blueprint_lib/bases/parts/baselogicpart.py

@@ -8,6 +8,4 @@ from ..controllers.baselogiccontroller import BaseLogicController
 class BaseLogicPart(BaseInteractablePart):
     """Base class for Logic parts with active state (mostly Logic Gate and Timer)
     """
-    controller: BaseLogicController = field(default_factory=BaseLogicController)
-    xaxis: int = field(kw_only=True, default=1)
-    zaxis: int = field(kw_only=True, default=-2)
+    controller: BaseLogicController = field(default_factory=BaseLogicController)

{sm_blueprint_lib-0.0.11 → sm_blueprint_lib-0.0.13}/src/sm_blueprint_lib/bases/parts/basepart.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass, field
 from typing import Optional
 
-from ...constants import AXIS, SHAPEID
+from ...constants import ROTATION, SHAPEID, AXIS, COLOR
 from ...pos import Pos
 from ...id import ID
 
@@ -12,7 +12,7 @@ class BasePart:
     """
     shapeId: str
     pos: Pos
-    color: str
+    color: str = field(kw_only=True, default=COLOR.DEFAULT)
     joints: Optional[list[ID]] = field(kw_only=True, default=None)
     xaxis: int = field(kw_only=True, default=AXIS.DEFAULT_XAXIS)
     zaxis: int = field(kw_only=True, default=AXIS.DEFAULT_ZAXIS)
@@ -24,12 +24,16 @@ class BasePart:
                 self.pos = Pos(**self.pos)
             except TypeError:
                 self.pos = Pos(self.pos[0], self.pos[1], self.pos[2])
+
         # if color given as (r, g, b) then convert to hex string
         if not isinstance(self.color, str):
             self.color = "%02X%02X%02X" % (
                 self.color[0], self.color[1], self.color[2])
         if self.joints:
-            self.joints = [ID(**id) for id in self.joints]
+            self.joints = [ID(**id)
+                           if not isinstance(id, ID) else
+                           id
+                           for id in self.joints]
 
     def __init_subclass__(cls):
         super().__init_subclass__()
@@ -37,3 +41,18 @@ class BasePart:
             SHAPEID.SHAPEID_TO_CLASS[cls.shapeId.default] = cls
         except AttributeError:
             pass
+
+    def rotate(self, facing: ROTATION.FACING, rotated: ROTATION.ROTATED):
+        """Sets the rotation of a Part.
+
+        Args:
+            facing (ROTATION.FACING): String indicating facing direction of the Part.
+            rotated (ROTATION.ROTATED): String indicating rotated direction of the face.
+        """
+        x, y, z, x_axis, z_axis = ROTATION.ROTATION_TABLE[facing][rotated]
+        self.pos.x += x
+        self.pos.y += y
+        self.pos.z += z
+        self.xaxis = x_axis
+        self.zaxis = z_axis
+        return self

{sm_blueprint_lib-0.0.11 → sm_blueprint_lib-0.0.13}/src/sm_blueprint_lib/blueprint.py

@@ -9,14 +9,24 @@ from .constants import VERSION, SHAPEID
 
 @dataclass
 class Blueprint:
+    """Class that represents a Blueprint structure.
+    It is type hinted, meaning you can access its members
+    with the dot syntax instead of direcly indexing a JSON object.
+    """
     bodies: list[Body] = field(default_factory=lambda: [{}])
     joints: Optional[list[BaseJoint]] = None
     version: int = VERSION.BLUEPRINT_VERSION
 
     def __post_init__(self):
-        self.bodies = [Body(**body) for body in self.bodies]
+        self.bodies = [Body(**body)
+                       if not isinstance(body, Body) else
+                       body
+                       for body in self.bodies]
         if self.joints:
-            self.joints = [SHAPEID.JOINT_TO_CLASS[j["shapeId"]](**j) for j in self.joints]
+            self.joints = [SHAPEID.JOINT_TO_CLASS[j["shapeId"]](**j)
+                           if not isinstance(j, BaseJoint) else
+                           j
+                           for j in self.joints]
 
     def add(self, *obj, body=0):
         """Adds the object(s) to the blueprint.

{sm_blueprint_lib-0.0.11 → sm_blueprint_lib-0.0.13}/src/sm_blueprint_lib/body.py

@@ -6,8 +6,12 @@ from .constants import SHAPEID
 
 @dataclass
 class Body:
+    """Class that represents a Body inside a Blueprint, each Joint defines a new Body.
+    """
     childs: list[BasePart] = field(default_factory=list)
 
     def __post_init__(self):
         self.childs = [SHAPEID.SHAPEID_TO_CLASS[child["shapeId"]](**child)
+                       if not isinstance(child, BasePart) else
+                       child
                        for child in self.childs]