diff --git a/Docs/CustomLayout.png b/Docs/CustomLayout.png new file mode 100644 index 0000000..4982de4 Binary files /dev/null and b/Docs/CustomLayout.png differ diff --git a/Docs/DefaultLayout.png b/Docs/DefaultLayout.png new file mode 100644 index 0000000..f19d642 Binary files /dev/null and b/Docs/DefaultLayout.png differ diff --git a/Packages/MagicLeapXRKeyboard/Docs.meta b/Packages/MagicLeapXRKeyboard/Docs.meta new file mode 100644 index 0000000..3878ae2 --- /dev/null +++ b/Packages/MagicLeapXRKeyboard/Docs.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: 7bc5af8207e8c0f40b1a69da08ba393b +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Packages/MagicLeapXRKeyboard/Docs/CustomLayout.png b/Packages/MagicLeapXRKeyboard/Docs/CustomLayout.png new file mode 100644 index 0000000..4982de4 Binary files /dev/null and b/Packages/MagicLeapXRKeyboard/Docs/CustomLayout.png differ diff --git a/Packages/MagicLeapXRKeyboard/Docs/CustomLayout.png.meta b/Packages/MagicLeapXRKeyboard/Docs/CustomLayout.png.meta new file mode 100644 index 0000000..08fb4a8 --- /dev/null +++ b/Packages/MagicLeapXRKeyboard/Docs/CustomLayout.png.meta @@ -0,0 +1,140 @@ +fileFormatVersion: 2 +guid: 269ba67137ec62c4db715ba751343a28 +TextureImporter: + internalIDToNameTable: [] + externalObjects: {} + serializedVersion: 12 + mipmaps: + mipMapMode: 0 + enableMipMap: 1 + sRGBTexture: 1 + linearTexture: 0 + fadeOut: 0 + borderMipMap: 0 + mipMapsPreserveCoverage: 0 + alphaTestReferenceValue: 0.5 + mipMapFadeDistanceStart: 1 + mipMapFadeDistanceEnd: 3 + bumpmap: + convertToNormalMap: 0 + externalNormalMap: 0 + heightScale: 0.25 + normalMapFilter: 0 + flipGreenChannel: 0 + isReadable: 0 + streamingMipmaps: 0 + streamingMipmapsPriority: 0 + vTOnly: 0 + ignoreMipmapLimit: 0 + grayScaleToAlpha: 0 + generateCubemap: 6 + cubemapConvolution: 0 + seamlessCubemap: 0 + textureFormat: 1 + maxTextureSize: 2048 + textureSettings: + serializedVersion: 2 + filterMode: 1 + aniso: 1 + mipBias: 0 + wrapU: 0 + wrapV: 0 + wrapW: 0 + nPOTScale: 1 + lightmap: 0 + compressionQuality: 50 + spriteMode: 0 + spriteExtrude: 1 + spriteMeshType: 1 + alignment: 0 + spritePivot: {x: 0.5, y: 0.5} + spritePixelsToUnits: 100 + spriteBorder: {x: 0, y: 0, z: 0, w: 0} + spriteGenerateFallbackPhysicsShape: 1 + alphaUsage: 1 + alphaIsTransparency: 0 + spriteTessellationDetail: -1 + textureType: 0 + textureShape: 1 + singleChannelComponent: 0 + flipbookRows: 1 + flipbookColumns: 1 + maxTextureSizeSet: 0 + compressionQualitySet: 0 + textureFormatSet: 0 + ignorePngGamma: 0 + applyGammaDecoding: 0 + swizzle: 50462976 + cookieLightType: 0 + platformSettings: + - serializedVersion: 3 + buildTarget: DefaultTexturePlatform + maxTextureSize: 2048 + resizeAlgorithm: 0 + textureFormat: -1 + textureCompression: 1 + compressionQuality: 50 + crunchedCompression: 0 + allowsAlphaSplitting: 0 + overridden: 0 + ignorePlatformSupport: 0 + androidETC2FallbackOverride: 0 + forceMaximumCompressionQuality_BC6H_BC7: 0 + - serializedVersion: 3 + buildTarget: Standalone + maxTextureSize: 2048 + resizeAlgorithm: 0 + textureFormat: -1 + textureCompression: 1 + compressionQuality: 50 + crunchedCompression: 0 + allowsAlphaSplitting: 0 + overridden: 0 + ignorePlatformSupport: 0 + androidETC2FallbackOverride: 0 + forceMaximumCompressionQuality_BC6H_BC7: 0 + - serializedVersion: 3 + buildTarget: Android + maxTextureSize: 2048 + resizeAlgorithm: 0 + textureFormat: -1 + textureCompression: 1 + compressionQuality: 50 + crunchedCompression: 0 + allowsAlphaSplitting: 0 + overridden: 0 + ignorePlatformSupport: 0 + androidETC2FallbackOverride: 0 + forceMaximumCompressionQuality_BC6H_BC7: 0 + - serializedVersion: 3 + buildTarget: Server + maxTextureSize: 2048 + resizeAlgorithm: 0 + textureFormat: -1 + textureCompression: 1 + compressionQuality: 50 + crunchedCompression: 0 + allowsAlphaSplitting: 0 + overridden: 0 + ignorePlatformSupport: 0 + androidETC2FallbackOverride: 0 + forceMaximumCompressionQuality_BC6H_BC7: 0 + spriteSheet: + serializedVersion: 2 + sprites: [] + outline: [] + physicsShape: [] + bones: [] + spriteID: + internalID: 0 + vertices: [] + indices: + edges: [] + weights: [] + secondaryTextures: [] + nameFileIdTable: {} + mipmapLimitGroupName: + pSDRemoveMatte: 0 + userData: + assetBundleName: + assetBundleVariant: diff --git a/Packages/MagicLeapXRKeyboard/Docs/DefaultLayout.png b/Packages/MagicLeapXRKeyboard/Docs/DefaultLayout.png new file mode 100644 index 0000000..f19d642 Binary files /dev/null and b/Packages/MagicLeapXRKeyboard/Docs/DefaultLayout.png differ diff --git a/Packages/MagicLeapXRKeyboard/Docs/DefaultLayout.png.meta b/Packages/MagicLeapXRKeyboard/Docs/DefaultLayout.png.meta new file mode 100644 index 0000000..5df4c28 --- /dev/null +++ b/Packages/MagicLeapXRKeyboard/Docs/DefaultLayout.png.meta @@ -0,0 +1,140 @@ +fileFormatVersion: 2 +guid: 6707b79793737f44588f7ae8d427012e +TextureImporter: + internalIDToNameTable: [] + externalObjects: {} + serializedVersion: 12 + mipmaps: + mipMapMode: 0 + enableMipMap: 1 + sRGBTexture: 1 + linearTexture: 0 + fadeOut: 0 + borderMipMap: 0 + mipMapsPreserveCoverage: 0 + alphaTestReferenceValue: 0.5 + mipMapFadeDistanceStart: 1 + mipMapFadeDistanceEnd: 3 + bumpmap: + convertToNormalMap: 0 + externalNormalMap: 0 + heightScale: 0.25 + normalMapFilter: 0 + flipGreenChannel: 0 + isReadable: 0 + streamingMipmaps: 0 + streamingMipmapsPriority: 0 + vTOnly: 0 + ignoreMipmapLimit: 0 + grayScaleToAlpha: 0 + generateCubemap: 6 + cubemapConvolution: 0 + seamlessCubemap: 0 + textureFormat: 1 + maxTextureSize: 2048 + textureSettings: + serializedVersion: 2 + filterMode: 1 + aniso: 1 + mipBias: 0 + wrapU: 0 + wrapV: 0 + wrapW: 0 + nPOTScale: 1 + lightmap: 0 + compressionQuality: 50 + spriteMode: 0 + spriteExtrude: 1 + spriteMeshType: 1 + alignment: 0 + spritePivot: {x: 0.5, y: 0.5} + spritePixelsToUnits: 100 + spriteBorder: {x: 0, y: 0, z: 0, w: 0} + spriteGenerateFallbackPhysicsShape: 1 + alphaUsage: 1 + alphaIsTransparency: 0 + spriteTessellationDetail: -1 + textureType: 0 + textureShape: 1 + singleChannelComponent: 0 + flipbookRows: 1 + flipbookColumns: 1 + maxTextureSizeSet: 0 + compressionQualitySet: 0 + textureFormatSet: 0 + ignorePngGamma: 0 + applyGammaDecoding: 0 + swizzle: 50462976 + cookieLightType: 0 + platformSettings: + - serializedVersion: 3 + buildTarget: DefaultTexturePlatform + maxTextureSize: 2048 + resizeAlgorithm: 0 + textureFormat: -1 + textureCompression: 1 + compressionQuality: 50 + crunchedCompression: 0 + allowsAlphaSplitting: 0 + overridden: 0 + ignorePlatformSupport: 0 + androidETC2FallbackOverride: 0 + forceMaximumCompressionQuality_BC6H_BC7: 0 + - serializedVersion: 3 + buildTarget: Standalone + maxTextureSize: 2048 + resizeAlgorithm: 0 + textureFormat: -1 + textureCompression: 1 + compressionQuality: 50 + crunchedCompression: 0 + allowsAlphaSplitting: 0 + overridden: 0 + ignorePlatformSupport: 0 + androidETC2FallbackOverride: 0 + forceMaximumCompressionQuality_BC6H_BC7: 0 + - serializedVersion: 3 + buildTarget: Android + maxTextureSize: 2048 + resizeAlgorithm: 0 + textureFormat: -1 + textureCompression: 1 + compressionQuality: 50 + crunchedCompression: 0 + allowsAlphaSplitting: 0 + overridden: 0 + ignorePlatformSupport: 0 + androidETC2FallbackOverride: 0 + forceMaximumCompressionQuality_BC6H_BC7: 0 + - serializedVersion: 3 + buildTarget: Server + maxTextureSize: 2048 + resizeAlgorithm: 0 + textureFormat: -1 + textureCompression: 1 + compressionQuality: 50 + crunchedCompression: 0 + allowsAlphaSplitting: 0 + overridden: 0 + ignorePlatformSupport: 0 + androidETC2FallbackOverride: 0 + forceMaximumCompressionQuality_BC6H_BC7: 0 + spriteSheet: + serializedVersion: 2 + sprites: [] + outline: [] + physicsShape: [] + bones: [] + spriteID: + internalID: 0 + vertices: [] + indices: + edges: [] + weights: [] + secondaryTextures: [] + nameFileIdTable: {} + mipmapLimitGroupName: + pSDRemoveMatte: 0 + userData: + assetBundleName: + assetBundleVariant: diff --git a/Packages/MagicLeapXRKeyboard/README.md b/Packages/MagicLeapXRKeyboard/README.md index a55e2ab..740b569 100644 --- a/Packages/MagicLeapXRKeyboard/README.md +++ b/Packages/MagicLeapXRKeyboard/README.md @@ -2,11 +2,20 @@ A keyboard that can be used in any project that supports Unity's XR Interaction Toolkit. Demo scene can be found in the samples folder. -Make sure to set the input option in **Player Settings** to `new`. +## Standard Layouts + +![Image of XR Keyboard Layout](Docs/DefaultLayout.png) +![Image of custom XR Keyboard Layout](Docs/CustomLayout.png) +**Learn how to create cusom layouts [here](#editing-layout)** + + ## Getting Started +Make sure to set the input option in **Player Settings** to `new`. + + ### Keyboard - Place the Keyboard prefab from `Runtime/Prefabs/Keyboard Manager.prefab` into the scene diff --git a/README.md b/README.md index e0c5144..d878492 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ # Magic Leap XR Keyboard - A keyboard that can be used in any project that supports Unity's XR Interaction Toolkit. Demo scene can be found in `Assets/MagicLeap/Runtime/KeyboardExample/Scenes/XRKeyboardExample.unity` -Make sure to set the input option in **Player Settings** to `new`. +## Standard Layouts + +![Image of XR Keyboard Layout](Docs/DefaultLayout.png) +![Image of custom XR Keyboard Layout](Docs/CustomLayout.png) +**Learn how to create cusom layouts [here](#editing-layout)** + ## Getting Started +Make sure to set the input option in **Player Settings** to `new`. ### Keyboard - Place the Keyboard prefab from `Packages/Magic Leap XR Keyboard/Runtime/Prefabs/Keyboard Manager.prefab` into the scene