rustplus 6.0.12__tar.gz → 6.1.1__tar.gz

{rustplus-6.0.12/rustplus.egg-info → rustplus-6.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rustplus
-Version: 6.0.12
+Version: 6.1.1
 Summary: A python wrapper for the Rust Plus API
 Home-page: https://github.com/olijeffers0n/rustplus
 Author: olijeffers0n
@@ -18,6 +18,7 @@ Requires-Dist: requests
 Requires-Dist: numpy
 Requires-Dist: scipy
 Requires-Dist: betterproto==2.0.0b7
+Requires-Dist: resvg
 Dynamic: author
 Dynamic: description
 Dynamic: description-content-type
@@ -60,6 +61,8 @@ pip install rustplus
 - Getting the time
 - Using Smart Devices
 - Camera Handling
+- Interacting with clans
+- Getting nexus information
 
 # For information on all the above methods, see the [Wiki](https://rplus.ollieee.xyz)
 

{rustplus-6.0.12 → rustplus-6.1.1}/README.md

@@ -29,6 +29,8 @@ pip install rustplus
 - Getting the time
 - Using Smart Devices
 - Camera Handling
+- Interacting with clans
+- Getting nexus information
 
 # For information on all the above methods, see the [Wiki](https://rplus.ollieee.xyz)
 

{rustplus-6.0.12 → rustplus-6.1.1}/requirements.txt

@@ -7,3 +7,4 @@ requests
 numpy
 scipy
 betterproto==2.0.0b7
+resvg

{rustplus-6.0.12 → rustplus-6.1.1}/rustplus/__init__.py

@@ -14,6 +14,7 @@ from .annotations import (
 )
 from .remote.fcm import FCMListener
 from .remote.camera import MovementControls, CameraMovementOptions
+from .remote.nexus import NexusInterface, Realm
 from .commands import CommandOptions, ChatCommand
 from .events import ChatEventPayload, TeamEventPayload, EntityEventPayload
 from .utils import convert_event_type_to_name, Emoji, convert_coordinates
@@ -21,5 +22,5 @@ from .structs import RustError, RustMarker, Vector
 
 __name__ = "rustplus"
 __author__ = "olijeffers0n"
-__version__ = "6.0.12"
+__version__ = "6.1.1"
 __support__ = "Discord: https://discord.gg/nQqJe8qvP8"

rustplus-6.1.1/rustplus/annotations/chat_event.py

@@ -0,0 +1,34 @@
+from typing import Callable
+
+from .. import ServerDetails
+from ..identification import RegisteredListener
+from ..events import ChatEventPayload as ChatEventManager
+
+
+def ChatEvent(server_details: ServerDetails) -> Callable:
+
+    def wrapper(func) -> RegisteredListener:
+
+        if isinstance(func, RegisteredListener):
+            func = func.get_coro()
+
+        listener = RegisteredListener(func.__name__, func)
+
+        ChatEventManager.HANDLER_LIST.register(listener, server_details)
+
+        return listener
+
+    if not isinstance(server_details, ServerDetails):
+        if callable(server_details):
+            message = (
+                "ChatEvent decorator requires a ServerDetails object as an argument. You have probably "
+                "forgotten the brackets on the decorator to pass the server details object."
+            )
+        else:
+            message = (
+                "ChatEvent decorator requires a ServerDetails object as an argument. Please provide a valid "
+                "ServerDetails instance."
+            )
+        raise TypeError(message)
+
+    return wrapper

rustplus-6.1.1/rustplus/annotations/clan_event.py

@@ -0,0 +1,34 @@
+from typing import Callable
+
+from .. import ServerDetails
+from ..identification import RegisteredListener
+from ..events import ClanInfoEventPayload as ClanInfoEventManager
+
+
+def ClanEvent(server_details: ServerDetails) -> Callable:
+
+    def wrapper(func) -> RegisteredListener:
+
+        if isinstance(func, RegisteredListener):
+            func = func.get_coro()
+
+        listener = RegisteredListener(func.__name__, func)
+
+        ClanInfoEventManager.HANDLER_LIST.register(listener, server_details)
+
+        return listener
+
+    if not isinstance(server_details, ServerDetails):
+        if callable(server_details):
+            message = (
+                "ClanEvent decorator requires a ServerDetails object as an argument. You have probably "
+                "forgotten the brackets on the decorator to pass the server details object."
+            )
+        else:
+            message = (
+                "ClanEvent decorator requires a ServerDetails object as an argument. Please provide a valid "
+                "ServerDetails instance."
+            )
+        raise TypeError(message)
+
+    return wrapper

{rustplus-6.0.12 → rustplus-6.1.1}/rustplus/annotations/command.py

@@ -20,4 +20,17 @@ def Command(
 
         return RegisteredListener(func.__name__, func)
 
+    if not isinstance(server_details, ServerDetails):
+        if callable(server_details):
+            message = (
+                "Command decorator requires a ServerDetails object as an argument. You have probably "
+                "forgotten the brackets on the decorator to pass the server details object."
+            )
+        else:
+            message = (
+                "Command decorator requires a ServerDetails object as an argument. Please provide a valid "
+                "ServerDetails instance."
+            )
+        raise TypeError(message)
+
     return wrapper

rustplus-6.1.1/rustplus/annotations/entity_event.py

@@ -0,0 +1,32 @@
+from typing import Callable
+
+from .. import ServerDetails
+from ..identification import RegisteredListener
+from ..events import EntityEventPayload as EntityEventManager
+
+
+def EntityEvent(server_details: ServerDetails, eid: int) -> Callable:
+    def wrapper(func) -> RegisteredListener:
+        if isinstance(func, RegisteredListener):
+            func = func.get_coro()
+
+        listener = RegisteredListener(str(eid), func)
+
+        EntityEventManager.HANDLER_LIST.register(listener, server_details)
+
+        return listener
+
+    if not isinstance(server_details, ServerDetails):
+        if callable(server_details):
+            message = (
+                "EntityEvent decorator requires a ServerDetails object as an argument. You have probably "
+                "forgotten the brackets on the decorator to pass the server details object."
+            )
+        else:
+            message = (
+                "EntityEvent decorator requires a ServerDetails object as an argument. Please provide a valid "
+                "ServerDetails instance."
+            )
+        raise TypeError(message)
+
+    return wrapper

rustplus-6.1.1/rustplus/annotations/protobuf_event.py

@@ -0,0 +1,32 @@
+from typing import Callable
+
+from .. import ServerDetails
+from ..identification import RegisteredListener
+from ..events import ProtobufEventPayload as ProtobufEventManager
+
+
+def ProtobufEvent(server_details: ServerDetails) -> Callable:
+    def wrapper(func) -> RegisteredListener:
+        if isinstance(func, RegisteredListener):
+            func = func.get_coro()
+
+        listener = RegisteredListener(func.__name__, func)
+
+        ProtobufEventManager.HANDLER_LIST.register(listener, server_details)
+
+        return listener
+
+    if not isinstance(server_details, ServerDetails):
+        if callable(server_details):
+            message = (
+                "ProtobufEvent decorator requires a ServerDetails object as an argument. You have probably "
+                "forgotten the brackets on the decorator to pass the server details object."
+            )
+        else:
+            message = (
+                "ProtobufEvent decorator requires a ServerDetails object as an argument. Please provide a valid "
+                "ServerDetails instance."
+            )
+        raise TypeError(message)
+
+    return wrapper

rustplus-6.1.1/rustplus/annotations/team_event.py

@@ -0,0 +1,32 @@
+from typing import Callable
+
+from .. import ServerDetails
+from ..identification import RegisteredListener
+from ..events import TeamEventPayload as TeamEventManager
+
+
+def TeamEvent(server_details: ServerDetails) -> Callable:
+    def wrapper(func) -> RegisteredListener:
+        if isinstance(func, RegisteredListener):
+            func = func.get_coro()
+
+        listener = RegisteredListener(func.__name__, func)
+
+        TeamEventManager.HANDLER_LIST.register(listener, server_details)
+
+        return listener
+
+    if not isinstance(server_details, ServerDetails):
+        if callable(server_details):
+            message = (
+                "TeamEvent decorator requires a ServerDetails object as an argument. You have probably "
+                "forgotten the brackets on the decorator to pass the server details object."
+            )
+        else:
+            message = (
+                "TeamEvent decorator requires a ServerDetails object as an argument. Please provide a valid "
+                "ServerDetails instance."
+            )
+        raise TypeError(message)
+
+    return wrapper

rustplus-6.1.1/rustplus/remote/camera/camera_constants.py

@@ -0,0 +1,32 @@
+class MovementControls:
+    """
+    Possible inputs for the camera movement.
+    """
+
+    FORWARD = 2
+    BACKWARD = 4
+    LEFT = 8
+    RIGHT = 16
+    JUMP = 32
+    DUCK = 64
+    SPRINT = 128
+    USE = 256
+    FIRE_PRIMARY = 1024
+    FIRE_SECONDARY = 2048
+    RELOAD = 8192
+    FIRE_THIRD = 134217728
+
+
+class CameraMovementOptions:
+    """
+    Indicate which camera controls are active for the camera.
+
+    """
+
+    NONE = 0
+    MOVEMENT = 1
+    MOUSE = 2
+    SPRINT_AND_DUCK = 4
+    FIRE = 8
+    RELOAD = 16
+    CROSSHAIR = 32

{rustplus-6.0.12 → rustplus-6.1.1}/rustplus/remote/camera/camera_manager.py

@@ -58,8 +58,8 @@ class CameraManager:
     async def _create_frame(
         self,
         render_entities: bool = True,
-        entity_render_distance: float = float("inf"),
-        max_entity_amount: int = float("inf"),
+        entity_render_distance: float | int = float("inf"),
+        max_entity_amount: float | int = float("inf"),
     ) -> Union[Image.Image, None]:
         if self._last_packets is None:
             return None
@@ -95,8 +95,8 @@ class CameraManager:
     async def get_frame(
         self,
         render_entities: bool = True,
-        entity_render_distance: float = float("inf"),
-        max_entity_amount: int = float("inf"),
+        entity_render_distance: float | int = float("inf"),
+        max_entity_amount: float | int = float("inf"),
     ) -> Union[Image.Image, None]:
         return await self._create_frame(
             render_entities, entity_render_distance, max_entity_amount

{rustplus-6.0.12 → rustplus-6.1.1}/rustplus/remote/camera/camera_parser.py

@@ -7,7 +7,6 @@ import numpy as np
 from scipy.spatial import ConvexHull
 from PIL import Image, ImageDraw, ImageFont
 
-from .camera_constants import LOOKUP_CONSTANTS
 from .structures import Entity, Vector3
 
 SCIENTIST_COLOUR = "#3098f2"
@@ -44,6 +43,8 @@ class Parser:
         self.entities = []
         self.last_fov = 0
 
+        self.lookup_constants = self._generate_lookup_constants(self.width, self.height)
+
     def reset_output(self) -> None:
         self.colour_output = np.full(
             (self.width * self.scale_factor, self.height * self.scale_factor, 3),
@@ -53,6 +54,42 @@ class Parser:
             (self.width * self.scale_factor, self.height * self.scale_factor)
         )
 
+    @staticmethod
+    def _generate_lookup_constants(width: int, height: int) -> List[int]:
+        instance_count = width * height
+
+        sample_position_buffer = [0] * (instance_count * 2)
+
+        buffer_index = 0
+
+        for y in range(height):
+            for x in range(width):
+                sample_position_buffer[buffer_index] = RNGSource.int32(x)
+                buffer_index += 1
+
+                sample_position_buffer[buffer_index] = RNGSource.int32(y)
+                buffer_index += 1
+
+        rng = RNGSource(1337)
+
+        for current_position in range(instance_count - 1, 0, -1):
+            current_index = 2 * current_position
+            random_position = 2 * rng.next_int(current_position + 1)
+
+            current_x = sample_position_buffer[current_index]
+            current_y = sample_position_buffer[current_index + 1]
+
+            random_x = sample_position_buffer[random_position]
+            random_y = sample_position_buffer[random_position + 1]
+
+            sample_position_buffer[random_position] = current_x
+            sample_position_buffer[random_position + 1] = current_y
+
+            sample_position_buffer[current_index] = random_x
+            sample_position_buffer[current_index + 1] = random_y
+
+        return sample_position_buffer
+
     def handle_camera_ray_data(self, data) -> None:
         if data is None:
             return
@@ -90,9 +127,11 @@ class Parser:
             alignment = ray[1]
             material = ray[2]
 
-            index1 = LOOKUP_CONSTANTS[self._sample_offset]
+            index1 = self.lookup_constants[self._sample_offset]
             self._sample_offset += 1
-            index2 = int(LOOKUP_CONSTANTS[self._sample_offset] * self.width + index1)
+            index2 = int(
+                self.lookup_constants[self._sample_offset] * self.width + index1
+            )
             self._sample_offset += 1
 
             x = (index2 % self.width) * self.scale_factor
@@ -786,3 +825,47 @@ class MathUtils:
 
         # Return the vertices that correspond to the non-zero indices
         return np.array(list(zip(x, y)))
+
+
+class RNGSource:
+    def __init__(self, seed):
+        self.state = self.int32(seed)
+        self.next_state()
+
+    def next_int(self, e):
+        t = self.int32((self.next_state() * self.int32(e)) / 4294967295)
+
+        if t < 0:
+            t = e + t - 1
+
+        return self.int32(t)
+
+    def next_state(self):
+        e = self.state
+        t = e
+
+        e = self.int32(e ^ self.int32(e << 13))
+        e = self.int32(e ^ (self.uint32(e) >> 17))
+        e = self.int32(e ^ self.int32(e << 5))
+
+        self.state = e
+
+        return self.clamp(t)
+
+    @staticmethod
+    def clamp(e):
+        return e if e >= 0 else 4294967295 + e - 1
+
+    @staticmethod
+    def int32(value):
+        value = int(value)
+        value &= 0xFFFFFFFF
+
+        if value >= 0x80000000:
+            value -= 0x100000000
+
+        return value
+
+    @staticmethod
+    def uint32(value):
+        return value & 0xFFFFFFFF

rustplus-6.1.1/rustplus/remote/nexus/__init__.py

@@ -0,0 +1 @@
+from .nexus_interface import NexusInterface, Realm

rustplus-6.1.1/rustplus/remote/nexus/nexus_interface.py

@@ -0,0 +1,45 @@
+from typing import Any
+
+import requests
+import enum
+
+
+class Realm(enum.Enum):
+    Development = 0
+    Staging = 1
+    Production = 2
+
+
+class NexusInterface:
+    def __init__(self, endpoint: str):
+        self.session = requests.Session()
+        self.endpoint = endpoint
+
+    def get_all_nexus(self, public_key: str, realm: Realm) -> Any | None:
+
+        res = self.session.get(
+            f"{self.endpoint}?publicKey={public_key}&realm={realm.value}"
+        )
+
+        if res.status_code == 200:
+            return res.json()
+
+        return None
+
+    def get_nexus_info(self, nexus_id: int) -> Any | None:
+
+        res = self.session.get(f"{self.endpoint}/{nexus_id}")
+
+        if res.status_code == 200:
+            return res.json()
+
+        return None
+
+    def get_nexus_map(self, nexus_id: int) -> Any | None:
+
+        res = self.session.get(f"{self.endpoint}/{nexus_id}/map")
+
+        if res.status_code == 200:
+            return res.content
+
+        return None

{rustplus-6.0.12 → rustplus-6.1.1}/rustplus/rust_api.py

@@ -19,6 +19,7 @@ from .remote.rustplus_proto import (
     AppCameraSubscribe,
     AppMapMonument,
     AppFlag,
+    AppGetNexusAuth,
 )
 from .remote.websocket import RustWebsocket
 from .structs import (
@@ -33,6 +34,7 @@ from .structs import (
     RustItem,
     RustClanInfo,
     RustClanMessage,
+    RustAuthDetails,
 )
 from .structs.rust_error import RustError
 from .utils import (
@@ -42,7 +44,7 @@ from .utils import (
     fetch_avatar_icon,
     format_coord,
     convert_marker,
-    convert_monument,
+    convert_monument_to_image,
 )
 from .remote.ratelimiter import RateLimiter
 from .utils.utils import error_present
@@ -315,6 +317,9 @@ class RustSocket:
                 await self.get_markers() if add_events or add_vending_machines else []
             )
 
+            if isinstance(map_markers, RustError):
+                return map_markers
+
             if add_icons:
                 for monument in monuments:
                     if str(monument.token) == "DungeonBase":
@@ -324,11 +329,12 @@ class RustSocket:
                         # reported as separate markers next to the lab; they aren't
                         # standalone monuments, so don't draw them.
                         continue
-                    icon = convert_monument(monument.token, override_images)
+
                     if monument.token in override_images:
-                        icon = icon.resize((150, 150))
-                    if str(monument.token) == "train_tunnel_display_name":
-                        icon = icon.resize((100, 125))
+                        icon = override_images[monument.token].resize((150, 150))
+                    else:
+                        icon = convert_monument_to_image(monument.token)
+
                     output.paste(
                         icon,
                         (format_coord(int(monument.x), int(monument.y), map_size)),
@@ -634,3 +640,28 @@ class RustSocket:
         packet.set_clan_motd = send_message
 
         await self.ws.send_message(packet, True)
+
+    async def get_nexus_auth(self, app_key: str) -> Union[RustAuthDetails, RustError]:
+        """
+        Gets the auth for a server. Does not require that the player token of this RustSocket is set correctly.
+
+        :param app_key: The app key to use. I do not know how you would get this currently, without owning the server.
+        """
+
+        packet = await self._generate_request()
+        send_message = AppGetNexusAuth()
+        send_message.app_key = app_key
+        packet.get_nexus_auth = send_message
+
+        response = await self.ws.send_and_get(packet)
+
+        if response is None:
+            return RustError("get_nexus_auth", "No response received")
+
+        if error_present(response):
+            return RustError("get_nexus_auth", response.response.error.error)
+
+        return RustAuthDetails(
+            response.response.nexus_auth.server_id,
+            response.response.nexus_auth.player_token,
+        )

{rustplus-6.0.12 → rustplus-6.1.1}/rustplus/structs/__init__.py

@@ -7,6 +7,6 @@ from .rust_team_info import RustTeamInfo, RustTeamMember, RustTeamNote
 from .rust_entity_info import RustEntityInfo
 from .rust_contents import RustContents
 from .rust_item import RustItem
-from .util import Vector
+from .util import Vector, RustAuthDetails
 from .rust_error import RustError
 from .clans import *

{rustplus-6.0.12 → rustplus-6.1.1}/rustplus/structs/util.py

@@ -5,3 +5,9 @@ import dataclasses
 class Vector:
     x: float = 0
     y: float = 0
+
+
+@dataclasses.dataclass
+class RustAuthDetails:
+    server_id: str = ""
+    token: int = -1

{rustplus-6.0.12 → rustplus-6.1.1}/rustplus/utils/__init__.py

@@ -5,7 +5,7 @@ from .utils import (
     fetch_avatar_icon,
     format_coord,
     convert_marker,
-    convert_monument,
+    convert_monument_to_image,
     convert_event_type_to_name,
     convert_coordinates,
 )