Merge pull request #12 from realitycollective/feature/player-namespac…

…e-fix

Fix player module usings and update branding

CHANGELOG.md

@@ -1,9 +1,3 @@
 # Changelog
-All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [1.0.0] - 2022-05-20
-
-Initial package release.
+Please refer to the package's [Releases GitHub Page](https://github.com/realitycollective/com.realitytoolkit.devicesimulation/releases) for the changelog.

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Reality Collective
+Copyright (c) 2022-2024 Reality Collective
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,42 +1,36 @@
 # Reality Toolkit - Device Simulation
 
-![GitHub](https://user-images.githubusercontent.com/9565734/206028194-d8296dac-888f-49d0-8029-e100a45f9aef.png)
+![com.realitytoolkit.devicesimulation](https://github.com/realitycollective/realitycollective.logo/blob/main/RealityToolkit/RepoBanners/com.realitytoolkit.devicesimulation.png?raw=true)
 
-Development extnsion for the [Reality Toolkit](https://github.com/realitycollective/com.realitytoolkit.core) implementing simulated controller devices and headsets for faster iteration.
+A collection of services, utilities and tools for simulating XR devices when working in the Unity editor using the [Reality Toolkit](https://www.realitytoolkit.io/).
 
-[![openupm](https://img.shields.io/npm/v/com.realitytoolkit.devicesimulation?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.realitytoolkit.devicesimulation/)
+[![openupm](https://img.shields.io/npm/v/com.realitytoolkit.devicesimulation?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.realitytoolkit.devicesimulation/) [![Discord](https://img.shields.io/discord/597064584980987924.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/hF7TtRCFmB)
+[![Publish main branch and increment version](https://github.com/realitycollective/com.realitytoolkit.devicesimulation/actions/workflows/main-publish.yml/badge.svg)](https://github.com/realitycollective/com.realitytoolkit.devicesimulation/actions/workflows/main-publish.yml)
+[![Publish development branch on Merge](https://github.com/realitycollective/com.realitytoolkit.devicesimulation/actions/workflows/development-publish.yml/badge.svg)](https://github.com/realitycollective/com.realitytoolkit.devicesimulation/actions/workflows/development-publish.yml)
+[![Build and test UPM packages for platforms, all branches except main](https://github.com/realitycollective/com.realitytoolkit.devicesimulation/actions/workflows/development-buildandtestupmrelease.yml/badge.svg)](https://github.com/realitycollective/com.realitytoolkit.devicesimulation/actions/workflows/development-buildandtestupmrelease.yml)
 
-[![Discord](https://img.shields.io/discord/597064584980987924.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/KXABVsTa)
+## Installation
 
-## What's included?
+Make sure to always use the same source for all toolkit modules. Avoid using different installation sources within the same project. We provide the following ways to install Reality Toolkit modules:
 
-- Simulated hand tracking input device
-- Simulated generic motion controller input device
+### Method 1: Using Package Manager for git users
 
-## Requirements
+1. Open the Package Manager using the Window menu -> Package Manager
 
-- [RealityToolkit.Core](https://github.com/realitycollective/com.realitytoolkit.core)
+2. Inside the Package Manager, click on the "+" button on the top left and select "Add package from git URL..."
 
-## Getting Started
-
-After you installed the package and imported package assets to your project, add the services you wish to use to your root configuration profile.
-
-### OpenUPM
-
-[![openupm](https://img.shields.io/npm/v/com.realitytoolkit.devicesimulation?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.realitytoolkit.devicesimulation/)
+3. Input the following URL: https://github.com/realitycollective/com.realitytoolkit.devicesimulation.git and click "Add".
 
-The simplest way to get started using the simulation package in your project is via OpenUPM. Visit [OpenUPM](https://openupm.com/docs/) to learn more about it. Once you have the OpenUPM CLI set up use the following command to add the package to your project:
+### Method 2: OpenUPM
 
+```text
+    openupm add com.realitytoolkit.devicesimulation
 ```
-openupm add com.realitytoolkit.devicesimulation
-```
 
-> For more details on using [OpenUPM CLI, check the docs here](https://github.com/openupm/openupm-cli#installation).
+### Method 3: Unity Asset Store
+
+This option will be available soon.
 
-# Build Status
-<!-- Check build status links and details -->
+## Getting Started
 
-| branch | build status |
-| --- | --- |
-| main | [![main](https://github.com/realitycollective/com.realitytoolkit.devicesimulation/actions/workflows/main-publish.yml/badge.svg)](https://github.com/realitycollective/com.realitytoolkit.devicesimulation/actions/workflows/main-publish.yml) |
-| development | [![development](https://github.com/realitycollective/com.realitytoolkit.devicesimulation/actions/workflows/development-buildandtestupmrelease.yml/badge.svg)](https://github.com/realitycollective/com.realitytoolkit.devicesimulation/actions/workflows/development-buildandtestupmrelease.yml)|
+Check the ["Getting Started"](https://www.realitytoolkit.io/) documentation for the Reality Toolkit and to learn more about this module.

Runtime/InputService/HandTracking/SimulatedHandDataConverter.cs

@@ -3,10 +3,10 @@
 
 using RealityCollective.Definitions.Utilities;
 using RealityCollective.ServiceFramework.Services;
-using RealityToolkit.PlayerService.Interfaces;
 using RealityToolkit.Definitions.Devices;
 using RealityToolkit.Input.Hands;
 using RealityToolkit.Input.Hands.Poses;
+using RealityToolkit.Player.Interfaces;
 using RealityToolkit.Utilities;
 using System;
 using System.Collections.Generic;

package.json

@@ -25,8 +25,8 @@
     "url": "https://github.com/realitycollective"
   },
   "dependencies": {
-    "com.realitytoolkit.core": "1.0.0-pre.29",
-    "com.realitytoolkit.player": "1.0.1-pre.5"
+    "com.realitytoolkit.core": "1.0.0-pre.37",
+    "com.realitytoolkit.player": "1.0.3-pre.1"
   },
   "assets": [
     {