sm-blueprint-lib 0.0.7__tar.gz → 0.0.9__tar.gz

sm_blueprint_lib-0.0.9/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: sm_blueprint_lib
+Version: 0.0.9
+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>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: numpy
+Description-Content-Type: text/markdown
+
+# sm_blueprint_lib
+ Scrap Mechanic Library for Blueprint manipulation.
+
+## Instalation
+```sh
+pip install sm_blueprint_lib
+```
+## Usage
+```python
+import numpy as np
+
+import sm_blueprint_lib as sm
+
+# Create a Blueprint object to store your parts
+bp = sm.Blueprint()
+
+# Define your stuff as you like, ID's are generated automatically or u can create them manually
+# The controller argument is converted to the needed LogicGateController class
+# 0: and, 1: or, 2: xor, 3: nand, 4: nor, 5: xnor
+single_and = sm.LogicGate(pos=(0, 0, 0), color="1122ff", controller=0)
+single_or = sm.LogicGate(sm.Pos(0, 2, 0), "3322ff", 1)
+single_self_wired_xor = sm.LogicGate(
+    pos=sm.Pos(0, 4, 0),
+    color="5522ff",
+    # Or define it explicitly
+    controller=sm.LogicGateController(mode=2, id=9999999, controllers=[sm.ID(9999999)])
+)
+
+# Create multiple gates at the same time
+row_0 = [sm.LogicGate((x, 6, 0), "ffffff", 0) for x in range(10)]
+row_1 = [sm.LogicGate((-1, 6, z + 1), "ffffff", 0) for z in range(10)]
+# Define matrices using numpy
+matrix = np.ndarray((10, 10), dtype=sm.LogicGate)
+for x in range(10):
+    for z in range(10):
+        # Define custom rotation (xaxis, zaxis)
+        matrix[x, z] = sm.LogicGate(
+            (x, 8, z + 1), "000000", 5, xaxis=1, zaxis=2)
+
+single_nor = sm.LogicGate(sm.Pos(0, 11, 0), "ee22ff", 4)
+
+row_2 = [sm.LogicGate((x, 13, 0), "ffffff", 0) for x in range(10)]
+row_3 = [sm.LogicGate((-1, 13, z + 1), "ffffff", 0) for z in range(10)]
+
+# Simple Timer loop
+loop = [sm.LogicGate((4, 0, 0), "987654"),
+        # TimerController can be passed as (seconds, ticks)
+        sm.Timer((5, 0, 0), "3210ff", (1, 0)),
+        sm.LogicGate((6, 0, 0), "eeddcc", 3)]
+
+# Connect stuff
+# 1 to 1
+sm.connect(single_and, single_or)
+sm.connect(single_or, single_self_wired_xor)
+sm.connect(row_0, row_1)    # With parallel=True (ie row to row)
+# 1 to many
+sm.connect(single_self_wired_xor, row_0)
+sm.connect(row_0, matrix)
+# Many to 1
+sm.connect(matrix, single_nor)
+# Many to many
+# With parallel=False (ie everything connects to everything)
+sm.connect(row_2, row_3, parallel=False)
+# You can also chain single gate connections
+loop[0].connect(loop[1]).connect(loop[2]).connect(loop[0])
+
+# Put all parts into the blueprint
+# Note that it doesn't care if it's a single gate or arrays
+bp.add(single_and, single_or, single_self_wired_xor,
+       row_0, row_1, matrix, single_nor, row_2, row_3, loop)
+
+# Finally, save the blueprint into a file or dump it as a string
+print(sm.dump_string_from_blueprint(bp))
+path = "path/to/your/blueprint/folder/blueprint.json"
+sm.save_blueprint(bp, path)
+```
+
+### Results
+#### 1 to 1 and loop
+![1 to 1 and loop](1to1andloop.png)
+#### Row to row and 1 to many
+![row to row and 1 to many](rowtorowand1tomany.png)
+#### Many to 1 and many to many
+![many to 1 and many to many](manytooneandmanytomany.png)

sm_blueprint_lib-0.0.9/README.md

@@ -0,0 +1,84 @@
+# sm_blueprint_lib
+ Scrap Mechanic Library for Blueprint manipulation.
+
+## Instalation
+```sh
+pip install sm_blueprint_lib
+```
+## Usage
+```python
+import numpy as np
+
+import sm_blueprint_lib as sm
+
+# Create a Blueprint object to store your parts
+bp = sm.Blueprint()
+
+# Define your stuff as you like, ID's are generated automatically or u can create them manually
+# The controller argument is converted to the needed LogicGateController class
+# 0: and, 1: or, 2: xor, 3: nand, 4: nor, 5: xnor
+single_and = sm.LogicGate(pos=(0, 0, 0), color="1122ff", controller=0)
+single_or = sm.LogicGate(sm.Pos(0, 2, 0), "3322ff", 1)
+single_self_wired_xor = sm.LogicGate(
+    pos=sm.Pos(0, 4, 0),
+    color="5522ff",
+    # Or define it explicitly
+    controller=sm.LogicGateController(mode=2, id=9999999, controllers=[sm.ID(9999999)])
+)
+
+# Create multiple gates at the same time
+row_0 = [sm.LogicGate((x, 6, 0), "ffffff", 0) for x in range(10)]
+row_1 = [sm.LogicGate((-1, 6, z + 1), "ffffff", 0) for z in range(10)]
+# Define matrices using numpy
+matrix = np.ndarray((10, 10), dtype=sm.LogicGate)
+for x in range(10):
+    for z in range(10):
+        # Define custom rotation (xaxis, zaxis)
+        matrix[x, z] = sm.LogicGate(
+            (x, 8, z + 1), "000000", 5, xaxis=1, zaxis=2)
+
+single_nor = sm.LogicGate(sm.Pos(0, 11, 0), "ee22ff", 4)
+
+row_2 = [sm.LogicGate((x, 13, 0), "ffffff", 0) for x in range(10)]
+row_3 = [sm.LogicGate((-1, 13, z + 1), "ffffff", 0) for z in range(10)]
+
+# Simple Timer loop
+loop = [sm.LogicGate((4, 0, 0), "987654"),
+        # TimerController can be passed as (seconds, ticks)
+        sm.Timer((5, 0, 0), "3210ff", (1, 0)),
+        sm.LogicGate((6, 0, 0), "eeddcc", 3)]
+
+# Connect stuff
+# 1 to 1
+sm.connect(single_and, single_or)
+sm.connect(single_or, single_self_wired_xor)
+sm.connect(row_0, row_1)    # With parallel=True (ie row to row)
+# 1 to many
+sm.connect(single_self_wired_xor, row_0)
+sm.connect(row_0, matrix)
+# Many to 1
+sm.connect(matrix, single_nor)
+# Many to many
+# With parallel=False (ie everything connects to everything)
+sm.connect(row_2, row_3, parallel=False)
+# You can also chain single gate connections
+loop[0].connect(loop[1]).connect(loop[2]).connect(loop[0])
+
+# Put all parts into the blueprint
+# Note that it doesn't care if it's a single gate or arrays
+bp.add(single_and, single_or, single_self_wired_xor,
+       row_0, row_1, matrix, single_nor, row_2, row_3, loop)
+
+# Finally, save the blueprint into a file or dump it as a string
+print(sm.dump_string_from_blueprint(bp))
+path = "path/to/your/blueprint/folder/blueprint.json"
+sm.save_blueprint(bp, path)
+```
+
+### Results
+#### 1 to 1 and loop
+![1 to 1 and loop](1to1andloop.png)
+#### Row to row and 1 to many
+![row to row and 1 to many](rowtorowand1tomany.png)
+#### Many to 1 and many to many
+![many to 1 and many to many](manytooneandmanytomany.png)

{sm_blueprint_lib-0.0.7 → sm_blueprint_lib-0.0.9}/pyproject.toml

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

{sm_blueprint_lib-0.0.7 → sm_blueprint_lib-0.0.9}/src/sm_blueprint_lib/constants.py

@@ -4,6 +4,7 @@ class SHAPEID:
     TIMER = "8f7fd0e7-c46e-4944-a414-7ce2437bb30f"
     SENSOR5 = "20dcd41c-0a11-4668-9b00-97f278ce21af"
     SWITCH = "7cf717d7-d167-4f2d-a6e7-6b2c70aa3986"
+    BUTTON = "1e8d93a4-506b-470d-9ada-9c0a321e2db5"
     SHAPEID_TO_CLASS = {}
 
 

{sm_blueprint_lib-0.0.7 → sm_blueprint_lib-0.0.9}/src/sm_blueprint_lib/parts/__init__.py

@@ -1,5 +1,6 @@
 from .barrierblock import *
 from .logicgate import *
 from .sensor import *
-# from .switch import * # not finished
+from .switch import *
+from .button import *
 from .timer import *

sm_blueprint_lib-0.0.9/src/sm_blueprint_lib/parts/button.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass, field
+
+from ..bases.parts.baseinteractablepart import BaseInteractablePart
+from ..constants import SHAPEID, AXIS
+
+
+@dataclass
+class Button(BaseInteractablePart):
+    shapeId: str = field(kw_only=True, default=SHAPEID.BUTTON)

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

@@ -0,0 +1,9 @@
+from dataclasses import dataclass, field
+
+from ..bases.parts.baselogicpart import BaseLogicPart
+from ..constants import SHAPEID
+
+
+@dataclass
+class Switch(BaseLogicPart):
+    shapeId: str = field(kw_only=True, default=SHAPEID.SWITCH)

{sm_blueprint_lib-0.0.7 → sm_blueprint_lib-0.0.9}/src/sm_blueprint_lib/utils.py

@@ -88,22 +88,27 @@ def connect(_from, _to, *, parallel=True):
     if isinstance(_from, BaseInteractablePart) and isinstance(_to, BaseInteractablePart):
         _from.connect(_to)
         return
-    if parallel:    # Try connect things row-by-row if possible (one to one, one to many, many to many)
-        if not isinstance(_from, BaseInteractablePart) and not isinstance(_to, BaseInteractablePart):   # Assume both are sequence of parts
+    # Try connect things row-by-row if possible (one to one, one to many, many to many)
+    if parallel:
+        # Assume both are sequence of parts
+        if not isinstance(_from, BaseInteractablePart) and not isinstance(_to, BaseInteractablePart):
             for subfrom, subto in zip(_from, _to):
                 connect(subfrom, subto, parallel=parallel)
-        elif not isinstance(_from, BaseInteractablePart):   # Assume _from is a sequence of parts
+        # Assume _from is a sequence of parts
+        elif not isinstance(_from, BaseInteractablePart):
             for subfrom in _from:
                 connect(subfrom, _to, parallel=parallel)
         else:                                               # Assume _to is a sequence of parts
             for subto in _to:
                 connect(_from, subto, parallel=parallel)
     else:           # Just connect everything to everything lol
-        if not isinstance(_from, BaseInteractablePart) and not isinstance(_to, BaseInteractablePart):   # Assume both are sequence of parts
+        # Assume both are sequence of parts
+        if not isinstance(_from, BaseInteractablePart) and not isinstance(_to, BaseInteractablePart):
             for subfrom in _from:
                 for subto in _to:
                     connect(subfrom, subto, parallel=parallel)
-        elif not isinstance(_from, BaseInteractablePart):   # Assume _from is a sequence of parts
+        # Assume _from is a sequence of parts
+        elif not isinstance(_from, BaseInteractablePart):
             for subfrom in _from:
                 connect(subfrom, _to, parallel=parallel)
         else:                                               # Assume _to is a sequence of parts

{sm_blueprint_lib-0.0.7 → sm_blueprint_lib-0.0.9}/test_connections.py

@@ -2,7 +2,7 @@ from pprint import pp
 
 from numpy import ndarray
 
-from src.sm_blueprint_lib import Timer, LogicGate, BarrierBlock, Blueprint, save_blueprint, dump_string_from_blueprint, connect
+from src.sm_blueprint_lib import Timer, LogicGate, BarrierBlock, Switch, Button, Blueprint, save_blueprint, dump_string_from_blueprint, connect
 
 size = 10
 l0 = [
@@ -31,15 +31,19 @@ for x in range(size):
 base = BarrierBlock((0, -1, -1), "000000", (size+1, size+1, 1))
 zero = BarrierBlock((0, -1, 0), "000000", (1, 1, 1))
 
+s = Switch((10, 10, 0), "ff0000")
+b = Button((9, 9, 0), "ff0000")
+
 bp = Blueprint()
 
+connect(s, l1)
 connect(l0, l1)
 connect(l0, l3)
 connect(l3, l2[-1])
 connect(l1, l2, parallel=False)
 connect(l3.T, l1)
 
-bp.add(l0, l1, l2, base, zero, l3)
+bp.add(l0, l1, l2, base, zero, l3, s, b)
 
 # bp.add(l0)
 # bp.add(l1)

sm_blueprint_lib-0.0.7/PKG-INFO

@@ -1,17 +0,0 @@
-Metadata-Version: 2.4
-Name: sm_blueprint_lib
-Version: 0.0.7
-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>
-License-Expression: MIT
-License-File: LICENSE
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.8
-Requires-Dist: numpy
-Description-Content-Type: text/markdown
-
-# sm_blueprint_lib
- Scrap Mechanic Library for Blueprint manipulation.

sm_blueprint_lib-0.0.7/README.md

@@ -1,2 +0,0 @@
-# sm_blueprint_lib
- Scrap Mechanic Library for Blueprint manipulation.

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

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