sm-blueprint-lib 0.0.4__tar.gz → 0.0.6__tar.gz

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/.gitignore

@@ -16,7 +16,6 @@ eggs/
 .eggs/
 lib/
 lib64/
-parts/
 sdist/
 var/
 wheels/

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sm_blueprint_lib
-Version: 0.0.4
+Version: 0.0.6
 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

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sm_blueprint_lib"
-version = "0.0.4"
+version = "0.0.6"
 dependencies = ["numpy"]
 authors = [
   { name="Maurice", email="mauriciotorrez00@gmail.com" },

sm_blueprint_lib-0.0.6/src/sm_blueprint_lib/__init__.py

@@ -0,0 +1,10 @@
+from .blueprint import Blueprint
+from .body import *
+from .bounds import *
+from .constants import *
+from .id import *
+from .pos import *
+from .utils import *
+
+from .parts import *
+from .prebuilds import *

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/bases/controllers/basecontroller.py

@@ -1,8 +1,8 @@
 from dataclasses import dataclass, field
 from typing import Any, Optional
 
-from sm_blueprint_lib.constants import get_new_id
-from sm_blueprint_lib.id import ID
+from ...constants import get_new_id
+from ...id import ID
 
 
 @dataclass

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/bases/controllers/baselogiccontroller.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 
-from sm_blueprint_lib.bases.controllers.basecontroller import BaseController
+from .basecontroller import BaseController
 
 
 @dataclass

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/bases/controllers/logicgatecontroller.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 
-from sm_blueprint_lib.bases.controllers.baselogiccontroller import BaseLogicController
+from .baselogiccontroller import BaseLogicController
 
 
 @dataclass

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/bases/controllers/sensorcontroller.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 
-from sm_blueprint_lib.bases.controllers.basecontroller import BaseController
+from .basecontroller import BaseController
 
 
 @dataclass

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/bases/controllers/timercontroller.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 
-from sm_blueprint_lib.bases.controllers.baselogiccontroller import BaseLogicController
+from .baselogiccontroller import BaseLogicController
 
 
 @dataclass

sm_blueprint_lib-0.0.6/src/sm_blueprint_lib/bases/parts/baseboundablepart.py

@@ -0,0 +1,23 @@
+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)
+
+    def __post_init__(self):
+        super().__post_init__()
+        if not isinstance(self.bounds, Bounds):
+            try:
+                self.bounds = Bounds(**self.bounds)
+            except TypeError:
+                self.bounds = Bounds(
+                    self.bounds[0], self.bounds[1], self.bounds[2])

sm_blueprint_lib-0.0.6/src/sm_blueprint_lib/bases/parts/baseinteractablepart.py

@@ -0,0 +1,19 @@
+from dataclasses import dataclass, field
+
+from ..controllers.basecontroller import BaseController
+from .basepart import BasePart
+from ...id import ID
+
+
+@dataclass
+class BaseInteractablePart(BasePart):
+    """Base class for Interactable parts
+    """
+    controller: BaseController = field(default_factory=BaseController)
+
+    def connect(self, o: "BaseInteractablePart"):
+        if not self.controller.controllers:
+            self.controller.controllers = []
+            
+        self.controller.controllers.append(ID(o.controller.id))
+        return o

sm_blueprint_lib-0.0.6/src/sm_blueprint_lib/bases/parts/baselogicpart.py

@@ -0,0 +1,13 @@
+from dataclasses import dataclass, field
+
+from .baseinteractablepart import BaseInteractablePart
+from ..controllers.baselogiccontroller import BaseLogicController
+
+
+@dataclass
+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)

sm_blueprint_lib-0.0.6/src/sm_blueprint_lib/bases/parts/basepart.py

@@ -0,0 +1,34 @@
+from dataclasses import dataclass, field
+
+from ...constants import AXIS, SHAPEID
+from ...pos import Pos
+
+
+@dataclass
+class BasePart:
+    """Base class for all in-game parts
+    """
+    shapeId: str
+    pos: Pos
+    color: str
+    xaxis: int = field(kw_only=True, default=AXIS.DEFAULT_XAXIS)
+    zaxis: int = field(kw_only=True, default=AXIS.DEFAULT_ZAXIS)
+
+    def __post_init__(self):
+        # if pos given as {"x": ..., "y": ..., "z": ...} or (x, y, z) then convert to Pos class
+        if not isinstance(self.pos, Pos):
+            try:
+                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])
+
+    def __init_subclass__(cls):
+        super().__init_subclass__()
+        try:
+            SHAPEID.SHAPEID_TO_CLASS[cls.shapeId.default] = cls
+        except AttributeError:
+            pass

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/blueprint.py

@@ -1,8 +1,8 @@
 from dataclasses import dataclass, field
 
-from sm_blueprint_lib.bases.parts.basepart import BasePart
-from sm_blueprint_lib.body import Body
-from sm_blueprint_lib.constants import VERSION
+from .bases.parts.basepart import BasePart
+from .body import Body
+from .constants import VERSION
 
 
 @dataclass

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/body.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass, field
 
-from sm_blueprint_lib.bases.parts.basepart import BasePart
-from sm_blueprint_lib.constants import SHAPEID
+from .bases.parts.basepart import BasePart
+from .constants import SHAPEID
 
 
 @dataclass

sm_blueprint_lib-0.0.6/src/sm_blueprint_lib/parts/barrierblock.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass, field
+
+from ..bases.parts.baseboundablepart import BaseBoundablePart
+from ..constants import SHAPEID
+
+
+@dataclass
+class BarrierBlock(BaseBoundablePart):
+    shapeId: str = field(kw_only=True, default=SHAPEID.BARRIER_BLOCK)

sm_blueprint_lib-0.0.6/src/sm_blueprint_lib/parts/logicgate.py

@@ -0,0 +1,24 @@
+from dataclasses import dataclass, field
+
+from ..bases.parts.baselogicpart import BaseLogicPart
+from ..bases.controllers.logicgatecontroller import LogicGateController
+from ..constants import SHAPEID
+
+
+@dataclass
+class LogicGate(BaseLogicPart):
+    controller: LogicGateController = field(
+        default_factory=LogicGateController)
+    shapeId: str = field(kw_only=True, default=SHAPEID.LOGIC_GATE)
+
+    def __post_init__(self):
+        super().__post_init__()
+        # Can specify mode as a dict, a tuple (mode,) or just the parameter mode
+        if not isinstance(self.controller, LogicGateController):
+            try:
+                self.controller = LogicGateController(**self.controller)
+            except TypeError:
+                try:
+                    self.controller = LogicGateController(*self.controller)
+                except TypeError:
+                    self.controller = LogicGateController(self.controller)

sm_blueprint_lib-0.0.6/src/sm_blueprint_lib/parts/sensor.py

@@ -0,0 +1,24 @@
+from dataclasses import dataclass, field
+
+from ..bases.controllers.sensorcontroller import SensorController
+from ..bases.parts.baseinteractablepart import BaseInteractablePart
+from ..constants import SHAPEID
+
+
+@dataclass
+class Sensor5(BaseInteractablePart):
+    controller: SensorController = field(
+        default_factory=SensorController)
+    shapeId: str = field(kw_only=True, default=SHAPEID.SENSOR5)
+
+    def __post_init__(self):
+        super().__post_init__()
+        # Can specify sensor controller as a dict, a tuple (audioEnable, buttonMode, color, colorMode, range) or just the parameter mode
+        if not isinstance(self.controller, SensorController):
+            try:
+                self.controller = SensorController(**self.controller)
+            except TypeError:
+                try:
+                    self.controller = SensorController(*self.controller)
+                except TypeError:
+                    self.controller = SensorController(self.controller)

sm_blueprint_lib-0.0.6/src/sm_blueprint_lib/parts/switch.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass, field
+
+from ..bases.parts.baseinteractablepart import BaseInteractablePart
+from ..constants import SHAPEID
+
+
+@dataclass
+class Switch(BaseInteractablePart):
+    raise NotImplemented

sm_blueprint_lib-0.0.6/src/sm_blueprint_lib/parts/timer.py

@@ -0,0 +1,20 @@
+from dataclasses import dataclass, field
+
+from ..bases.controllers.timercontroller import TimerController
+from ..bases.parts.baselogicpart import BaseLogicPart
+from ..constants import SHAPEID
+
+
+@dataclass
+class Timer(BaseLogicPart):
+    controller: TimerController = field(default_factory=TimerController)
+    shapeId: str = field(kw_only=True, default=SHAPEID.TIMER)
+
+    def __post_init__(self):
+        super().__post_init__()
+        # Can provide seconds and ticks as a the TimerController class itself, a dict or a tuple (seconds, tick)
+        if not isinstance(self.controller, TimerController):
+            try:
+                self.controller = TimerController(**self.controller)
+            except TypeError:
+                self.controller = TimerController(*self.controller)

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/prebuilds/adder.py

@@ -1,9 +1,9 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
 
 
 def simple_adder_subtractor(bp: Blueprint,

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/prebuilds/barrel_shifter.py

@@ -1,9 +1,9 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
 
 
 def barrel_shifter(bp: Blueprint, bit_length: int, num_bit_shift: int, pos: Pos | Sequence = (0, 0, 0)):

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/prebuilds/clock40hz.py

@@ -1,9 +1,9 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
 
 
 def clock40hz(bp: Blueprint, bit_length: int, pos: Pos | Sequence = (0, 0, 0)):

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/prebuilds/comparator.py

@@ -1,9 +1,9 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import check_pos, connect
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
+from ..utils import check_pos, connect
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
 
 
 def comparator(bp: Blueprint,

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/prebuilds/counter.py

@@ -1,9 +1,9 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
 
 
 def counter(bp: Blueprint,

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/prebuilds/decoder.py

@@ -1,9 +1,9 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
 
 
 def decoder(bp: Blueprint, num_address: int, pos: Pos | Sequence = (0, 0, 0),

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/prebuilds/distance_sensor.py

@@ -1,11 +1,11 @@
 from typing import Sequence
 from numpy import array, ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.parts.sensor import Sensor5
-from sm_blueprint_lib.parts.timer import Timer
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..parts.sensor import Sensor5
+from ..parts.timer import Timer
+from ..pos import Pos
 
 
 def distance_sensor(bp: Blueprint,

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/prebuilds/ram.py

@@ -1,11 +1,11 @@
 from itertools import cycle
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
-from sm_blueprint_lib.prebuilds.decoder import decoder
+from ..utils import get_bits_required, check_pos, connect
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
+from ..prebuilds.decoder import decoder
 
 
 def ram(bp: Blueprint, bit_length: int, num_address: int, pos: Pos | Sequence = (0, 0, 0),

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/prebuilds/register.py

@@ -1,10 +1,10 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import check_pos
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
-from sm_blueprint_lib.prebuilds.counter import counter, counter_decrement
+from ..utils import check_pos
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
+from ..prebuilds.counter import counter, counter_decrement
 
 
 def register(bp: Blueprint,

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/prebuilds/rom.py

@@ -2,12 +2,12 @@ from itertools import batched, cycle
 from math import ceil
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.prebuilds.decoder import decoder
-from sm_blueprint_lib.parts.timer import Timer
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..prebuilds.decoder import decoder
+from ..parts.timer import Timer
+from ..pos import Pos
 
 
 def rom(

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/prebuilds/timer_ram_cached.py

@@ -1,19 +1,19 @@
 from itertools import cycle
 from typing import Sequence
 from numpy import array, clip, ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.bases.parts.baseinteractablepart import BaseInteractablePart
-from sm_blueprint_lib.bases.parts.baselogicpart import BaseLogicPart
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.constants import TICKS_PER_SECOND
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.parts.timer import Timer
-from sm_blueprint_lib.pos import Pos
-from sm_blueprint_lib.prebuilds.clock40hz import clock40hz
-from sm_blueprint_lib.prebuilds.counter import counter
-from sm_blueprint_lib.prebuilds.decoder import decoder
-from sm_blueprint_lib.prebuilds.ram import ram
-from sm_blueprint_lib.prebuilds.register import register
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..bases.parts.baseinteractablepart import BaseInteractablePart
+from ..bases.parts.baselogicpart import BaseLogicPart
+from ..blueprint import Blueprint
+from ..constants import TICKS_PER_SECOND
+from ..parts.logicgate import LogicGate
+from ..parts.timer import Timer
+from ..pos import Pos
+from ..prebuilds.clock40hz import clock40hz
+from ..prebuilds.counter import counter
+from ..prebuilds.decoder import decoder
+from ..prebuilds.ram import ram
+from ..prebuilds.register import register
 
 
 def timer_ram_cached(

{sm_blueprint_lib-0.0.4 → sm_blueprint_lib-0.0.6}/src/sm_blueprint_lib/prebuilds/timer_ram_multiclient.py

@@ -1,14 +1,14 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.parts.timer import Timer
-from sm_blueprint_lib.pos import Pos
-from sm_blueprint_lib.prebuilds.clock40hz import clock40hz
-from sm_blueprint_lib.prebuilds.decoder import decoder
-from sm_blueprint_lib.prebuilds.ram import ram
-from sm_blueprint_lib.prebuilds.register import register
+from ..utils import get_bits_required, check_pos, connect
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..parts.timer import Timer
+from ..pos import Pos
+from ..prebuilds.clock40hz import clock40hz
+from ..prebuilds.decoder import decoder
+from ..prebuilds.ram import ram
+from ..prebuilds.register import register
 
 
 def timer_ram_multiclient(bp: Blueprint, bit_length: int, num_address: int, num_clients=1, pos: Pos | Sequence = (0, 0, 0)):

sm_blueprint_lib-0.0.4/src/sm_blueprint_lib/__init__.py → sm_blueprint_lib-0.0.6/src/sm_blueprint_lib/utils.py

@@ -4,12 +4,12 @@ from math import ceil, log2
 
 from numpy import ndarray
 
-from sm_blueprint_lib.bases.parts.baseinteractablepart import BaseInteractablePart
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.barrierblock import BarrierBlock
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.parts.timer import Timer
-from sm_blueprint_lib.pos import Pos
+from .bases.parts.baseinteractablepart import BaseInteractablePart
+from .blueprint import Blueprint
+from .parts.barrierblock import BarrierBlock
+from .parts.logicgate import LogicGate
+from .parts.timer import Timer
+from .pos import Pos
 
 
 def load_blueprint(path):