styly-netsync-server 0.0.4__tar.gz

styly_netsync_server-0.0.4/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 STYLY, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

styly_netsync_server-0.0.4/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: styly-netsync-server
+Version: 0.0.4
+Summary: STYLY NetSync Server - Multiplayer framework for Location-Based Entertainment VR/MR experiences
+Author-email: "STYLY, Inc." <info@styly.inc>
+License: Apache-2.0
+Project-URL: Homepage, https://styly.inc
+Project-URL: Repository, https://github.com/styly-dev/STYLY-NetSync
+Project-URL: Documentation, https://github.com/styly-dev/STYLY-NetSync/blob/main/README.md
+Project-URL: Issues, https://github.com/styly-dev/STYLY-NetSync/issues
+Keywords: unity,multiplayer,vr,mr,location-based-entertainment,real-time,zeromq,networking
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyzmq>=26.0.0
+Requires-Dist: typing-extensions>=4.0.0; python_version < "3.10"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+# STYLY NetSync Server
+
+A Unity-based multiplayer framework for Location-Based Entertainment (LBE) VR/AR experiences. Provides real-time synchronization of player positions, hand tracking, and virtual objects using a Python server with ZeroMQ networking and binary serialization.
+
+## Installation
+
+### From PyPI (when published)
+```bash
+pip install styly-netsync-server
+```
+
+### From Source
+```bash
+# Clone the repository
+git clone https://github.com/PsychicVRLab/STYLY-LBE-Multiplayer.git
+cd STYLY-LBE-Multiplayer/STYLY-NetSync-Server
+
+# Install in development mode
+pip install -e .
+```
+
+### Using uv (recommended)
+```bash
+# Run without installing (one-time use)
+uvx styly-netsync-server
+
+# Run with custom options
+uvx styly-netsync-server --dealer-port 5555 --pub-port 5556
+
+# Run with uv (automatically installs dependencies)
+uv run dev  # Convenience script for development
+```
+
+## Usage
+
+### Command Line
+
+Start the server with default settings:
+```bash
+styly-netsync-server
+```
+
+Start with custom configuration:
+```bash
+styly-netsync-server --dealer-port 5555 --pub-port 5556 --beacon-port 9999 --name "My-Server"
+```
+
+Disable UDP discovery:
+```bash
+styly-netsync-server --no-beacon
+```
+
+### Programmatic Usage
+
+```python
+from styly_netsync import NetSyncServer
+import time
+
+# Create and start server
+server = NetSyncServer(
+    dealer_port=5555,
+    pub_port=5556,
+    enable_beacon=True,
+    beacon_port=9999,
+    server_name="STYLY-NetSync-Server"
+)
+
+try:
+    server.start()
+    # Keep server running
+    while True:
+        time.sleep(1)
+except KeyboardInterrupt:
+    server.stop()
+```
+
+### Client Simulator
+
+Test the server with simulated clients:
+```bash
+# Simulate 100 clients
+styly-netsync-simulator --clients 100
+
+# Custom server and room
+styly-netsync-simulator --server tcp://localhost --room my_room --clients 50
+```
+
+## Architecture
+
+- **Binary Protocol**: Efficient ZeroMQ-based networking with ~60% bandwidth reduction vs JSON
+- **Threading Model**: Separate threads for receive, periodic broadcast, and cleanup operations
+- **Client Management**: Device ID to client number mapping with automatic cleanup
+- **Network Variables**: Synchronized key-value storage with conflict resolution
+- **RPC System**: Remote procedure calls for custom game logic
+
+## Dependencies
+
+- Python 3.8+
+- pyzmq >= 26.0.0
+
+## Development
+
+### Testing During Development
+
+There are several ways to test the server during development:
+
+#### 1. Install in Development Mode
+```bash
+# Install the package in editable mode
+pip install -e .
+
+# Run the server
+styly-netsync-server
+```
+
+#### 2. Run Directly as Python Module
+```bash
+# From the project root
+python -m styly_netsync
+
+# With custom options
+python -m styly_netsync --dealer-port 6000 --pub-port 6001
+```
+
+#### 3. Use uv for Development
+```bash
+# Run using convenience script (automatically installs dependencies)
+uv run dev
+
+# Run with custom options
+uv run dev --dealer-port 6000 --pub-port 6001
+
+# Use uvx for one-time execution without installation
+uvx --from . styly-netsync-server
+
+# Test with client simulator
+uvx --from . styly-netsync-simulator --clients 50
+```
+
+#### 4. Create Test Scripts
+```python
+# test_server.py
+from src.styly_netsync import NetSyncServer
+
+server = NetSyncServer(dealer_port=5555, pub_port=5556)
+try:
+    server.start()
+    print("Server is running. Press Ctrl+C to stop.")
+    while True:
+        pass
+except KeyboardInterrupt:
+    server.stop()
+```
+
+#### 5. Use the Test Client
+```bash
+# Start the server first
+styly-netsync-server
+
+# In another terminal, run the test client
+python test_client.py
+```
+
+#### 6. Load Testing with Client Simulator
+```bash
+# Start server
+styly-netsync-server
+
+# In another terminal, simulate multiple clients
+styly-netsync-simulator --clients 100 --room test_room
+
+# Monitor server logs for performance metrics
+```
+
+### Code Quality
+
+```bash
+# Install development dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Format code
+black src/ tests/
+
+# Lint code
+ruff src/ tests/
+
+# Type check
+mypy src/
+```

styly_netsync_server-0.0.4/README.md

@@ -0,0 +1,192 @@
+# STYLY NetSync Server
+
+A Unity-based multiplayer framework for Location-Based Entertainment (LBE) VR/AR experiences. Provides real-time synchronization of player positions, hand tracking, and virtual objects using a Python server with ZeroMQ networking and binary serialization.
+
+## Installation
+
+### From PyPI (when published)
+```bash
+pip install styly-netsync-server
+```
+
+### From Source
+```bash
+# Clone the repository
+git clone https://github.com/PsychicVRLab/STYLY-LBE-Multiplayer.git
+cd STYLY-LBE-Multiplayer/STYLY-NetSync-Server
+
+# Install in development mode
+pip install -e .
+```
+
+### Using uv (recommended)
+```bash
+# Run without installing (one-time use)
+uvx styly-netsync-server
+
+# Run with custom options
+uvx styly-netsync-server --dealer-port 5555 --pub-port 5556
+
+# Run with uv (automatically installs dependencies)
+uv run dev  # Convenience script for development
+```
+
+## Usage
+
+### Command Line
+
+Start the server with default settings:
+```bash
+styly-netsync-server
+```
+
+Start with custom configuration:
+```bash
+styly-netsync-server --dealer-port 5555 --pub-port 5556 --beacon-port 9999 --name "My-Server"
+```
+
+Disable UDP discovery:
+```bash
+styly-netsync-server --no-beacon
+```
+
+### Programmatic Usage
+
+```python
+from styly_netsync import NetSyncServer
+import time
+
+# Create and start server
+server = NetSyncServer(
+    dealer_port=5555,
+    pub_port=5556,
+    enable_beacon=True,
+    beacon_port=9999,
+    server_name="STYLY-NetSync-Server"
+)
+
+try:
+    server.start()
+    # Keep server running
+    while True:
+        time.sleep(1)
+except KeyboardInterrupt:
+    server.stop()
+```
+
+### Client Simulator
+
+Test the server with simulated clients:
+```bash
+# Simulate 100 clients
+styly-netsync-simulator --clients 100
+
+# Custom server and room
+styly-netsync-simulator --server tcp://localhost --room my_room --clients 50
+```
+
+## Architecture
+
+- **Binary Protocol**: Efficient ZeroMQ-based networking with ~60% bandwidth reduction vs JSON
+- **Threading Model**: Separate threads for receive, periodic broadcast, and cleanup operations
+- **Client Management**: Device ID to client number mapping with automatic cleanup
+- **Network Variables**: Synchronized key-value storage with conflict resolution
+- **RPC System**: Remote procedure calls for custom game logic
+
+## Dependencies
+
+- Python 3.8+
+- pyzmq >= 26.0.0
+
+## Development
+
+### Testing During Development
+
+There are several ways to test the server during development:
+
+#### 1. Install in Development Mode
+```bash
+# Install the package in editable mode
+pip install -e .
+
+# Run the server
+styly-netsync-server
+```
+
+#### 2. Run Directly as Python Module
+```bash
+# From the project root
+python -m styly_netsync
+
+# With custom options
+python -m styly_netsync --dealer-port 6000 --pub-port 6001
+```
+
+#### 3. Use uv for Development
+```bash
+# Run using convenience script (automatically installs dependencies)
+uv run dev
+
+# Run with custom options
+uv run dev --dealer-port 6000 --pub-port 6001
+
+# Use uvx for one-time execution without installation
+uvx --from . styly-netsync-server
+
+# Test with client simulator
+uvx --from . styly-netsync-simulator --clients 50
+```
+
+#### 4. Create Test Scripts
+```python
+# test_server.py
+from src.styly_netsync import NetSyncServer
+
+server = NetSyncServer(dealer_port=5555, pub_port=5556)
+try:
+    server.start()
+    print("Server is running. Press Ctrl+C to stop.")
+    while True:
+        pass
+except KeyboardInterrupt:
+    server.stop()
+```
+
+#### 5. Use the Test Client
+```bash
+# Start the server first
+styly-netsync-server
+
+# In another terminal, run the test client
+python test_client.py
+```
+
+#### 6. Load Testing with Client Simulator
+```bash
+# Start server
+styly-netsync-server
+
+# In another terminal, simulate multiple clients
+styly-netsync-simulator --clients 100 --room test_room
+
+# Monitor server logs for performance metrics
+```
+
+### Code Quality
+
+```bash
+# Install development dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Format code
+black src/ tests/
+
+# Lint code
+ruff src/ tests/
+
+# Type check
+mypy src/
+```