Initial

Author: Python1320

.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python.formatting.provider": "autopep8"
+}

README.md

@@ -0,0 +1,47 @@
+# VRCJoyCon
+
+Link Nintendo Switch Joy-Cons to VRChat! Uses the new [OSC system](https://docs.vrchat.com/docs/osc-overview). 
+
+For now, only simple on/off rumble haptics are supported!
+
+# Requirements
+
+ - Nintendo Switch Joy-Con controller(s). **Only tested with knockoffs from Aliexpress.**
+ - A customisable avatar or a compatible avatar 
+ - Unity editor
+ - `vrcjoycon.exe` from this repository's Releases
+
+# TODO
+ - Example haptics avatar
+ - Debug help
+ - Button input
+
+# Haptics: Setting Up / Usage
+
+**Unity**
+  1. Position one or multiple [Contact Receivers](https://docs.vrchat.com/docs/contacts#vrccontactreceiver) components to your chosen avatar bone
+     1. Choose at least some collision tags or you will receive no contacts 
+     2. Haptics can be set to `local only`. `Allow Self` is recommended for testing.
+     3. Select `Proximity` from `Receiver Type`.
+     4. Set target parameter to `joyconrumble1`. For right controller choose `joyconrumble2`. 
+
+        ![componentdetails](images/help2.png)
+     5. Add the above parameters to your [animator parameters](https://docs.vrchat.com/docs/animator-parameters) with default float value of 0.0. This is used by OSC to relay the status to VRCJoyCon.
+        
+        ![animator](images/help1.png)
+
+**VRChat**
+  1. Put controllers into pairing mode.
+  2. Pair controllers manually over Bluetooth with Windows
+  3. Launch vrcjoycon.exe
+  4. When pairing is successful, the controllers should vibrate a few times
+  5. In case of trouble, test with other joycon software first
+  6. Launch **VRChat** if not already launched
+     1. From the VRChat's **circular menu**, inside **settings**, inside **OSC**, choose **Enable** OSC. Additional help [here](https://docs.vrchat.com/docs/osc-overview#enabling-it).
+      (*If the haptics do not work, try reset configuration option in the same menu* **ATTN.** The OSC Debug menu does not help you with debugging haptics, only output)
+
+# Credits / components used
+ - [joycon-python](https://github.com/tocoteron/joycon-python) library
+
+# License
+TODO

images/app.ico

@@ -0,0 +1,3 @@
+hidapi
+pyglm
+pythonosc

images/help1.png

@@ -0,0 +1,136 @@
+
+from pyjoycon import JoyCon, get_R_id, get_L_id, joycon
+import logging,sys,os,threading,time
+from pythonosc import dispatcher
+from pythonosc import osc_server
+
+from os import system
+system("title VRChat Joy-Con OSC Connector")
+
+joyconrumble = [False, False]
+joycons=[False,False]
+lock = threading.Lock()
+
+def headpatter_thread(conGetter, conid):
+	for i in range(13):
+		joycon_id = False
+
+		while True:
+			with lock:
+				joycon_id = conGetter()
+			if joycon_id and joycon_id[0]:
+				break
+			time.sleep(0.4)
+
+		id = conid-1
+		name = conid == 1 and "LEFT" or "RIGHT"
+		with lock:
+			joycon = JoyCon(*joycon_id)
+			joycons[id]=joycon
+
+		print("\nFound JoyCon", name,"\n")
+		with lock:
+			joycon.set_player_lamp_on(conid) # required to keep controller running
+
+		logging.debug("Testing vibration")
+		time.sleep(1)
+		with lock:
+			joycon.rumble_simple()
+		time.sleep(1.5)
+		with lock:
+			joycon.rumble_simple()
+		time.sleep(0.5)
+		with lock:
+			joycon.rumble_stop()
+		logging.debug("Vibrated")
+
+		while joycon.connected():
+			time.sleep(0.4) # TODO: Signaling, sleep otherwise
+			pat_status = joyconrumble[id]
+			if pat_status:
+				with lock:
+					joycon.rumble_simple()
+				print("Vibrating", name)
+
+			elif pat_status is not False:
+				joyconrumble[id] = False
+				print("STOP", name)
+				with lock:
+					joycon.rumble_stop()
+		print("LOST JOYCON",name)
+		with lock:
+			del joycon
+			joycons[id]=False
+	print("TOO MANY FAILURES, CLOSING")
+
+threads = []
+server: osc_server.ThreadingOSCUDPServer = None
+
+def startOSC():
+	global server
+	def joyconrumble_1_handler(address, *args):
+		logging.debug("joyconrumble_1_handler %s %s", str(address), str(args))
+		joyconrumble[0] = args[0]
+
+	def joyconrumble_2_handler(address, *args):
+		logging.debug("joyconrumble_2_handler %s %s", str(address), str(args))
+		joyconrumble[1] = args[0]
+
+	d = dispatcher.Dispatcher()
+	d.map("/avatar/parameters/joyconrumble1", joyconrumble_1_handler)
+	d.map("/avatar/parameters/joyconrumble2", joyconrumble_2_handler)
+	server = osc_server.ThreadingOSCUDPServer(
+		("127.0.0.1", 9001), d)
+	print("Listening on default OSC port 8991 at {}".format(server.server_address))
+	print("")
+
+def watchdog():
+	while True:
+		anyAlive=False
+		for t in threads:
+			t.join(0.2)
+			if t.is_alive():
+				anyAlive=True
+		if not anyAlive:
+			server.shutdown()
+			print("\nFATAL: Lost all JoyCon threads\n")
+			return
+		"""
+		
+		hadAny=False
+		anyAlive=False
+		for id,c in enumerate(joycons):
+			if c==False:
+				continue
+			hadAny=True
+
+			# TODO: Race condition here?
+			c._update_input_report_thread.join(0.2)
+			if c._update_input_report_thread.is_alive():
+				anyAlive=True
+
+		if hadAny and not anyAlive:
+			server.shutdown()
+			print("\nFATAL: Lost all JoyCons\n")
+			return
+		
+		"""
+
+def startJoyCons():
+	print("Attempting to locate joycons")
+	for conGetter, id in [(get_L_id, 1), (get_R_id, 2)]:
+		x = threading.Thread(target=headpatter_thread,
+							 args=(conGetter, id), daemon=True,name="joyconController"+str(id))
+		x.start()
+		threads.append(x)
+
+	# Watchdog
+	x = threading.Thread(target=watchdog,
+							args=(), daemon=True,name="watchdog")
+	x.start()
+
+if __name__ == "__main__":
+	startOSC()
+	startJoyCons()
+	server.serve_forever()
+	input("SHUTTING DOWN. PRESS ENTER TO CLOSE.")

images/help2.png

@@ -0,0 +1,25 @@
+from .joycon import JoyCon
+from .wrappers import PythonicJoyCon  # as JoyCon
+from .gyro import GyroTrackingJoyCon
+from .event import ButtonEventJoyCon
+from .device import get_device_ids, get_ids_of_type
+from .device import is_id_L
+from .device import get_R_ids, get_L_ids
+from .device import get_R_id, get_L_id
+
+
+__version__ = "0.2.4"
+
+__all__ = [
+    "ButtonEventJoyCon",
+    "GyroTrackingJoyCon",
+    "JoyCon",
+    "PythonicJoyCon",
+    "get_L_id",
+    "get_L_ids",
+    "get_R_id",
+    "get_R_ids",
+    "get_device_ids",
+    "get_ids_of_type",
+    "is_id_L",
+]

requirements.txt

@@ -0,0 +1,4 @@
+JOYCON_VENDOR_ID    = 0x057E
+JOYCON_L_PRODUCT_ID = 0x2006
+JOYCON_R_PRODUCT_ID = 0x2007
+JOYCON_PRODUCT_IDS = (JOYCON_L_PRODUCT_ID, JOYCON_R_PRODUCT_ID)