feat: readme
							parent
							
								
									36bc0f8b0e
								
							
						
					
					
						commit
						2e5fd1ec50
					
				
							
								
								
									
										29
									
								
								README.md
								
								
								
								
							
							
						
						
									
										29
									
								
								README.md
								
								
								
								
							| 
						 | 
					@ -1,3 +1,32 @@
 | 
				
			||||||
# SkyHook-Unity
 | 
					# SkyHook-Unity
 | 
				
			||||||
 | 
					
 | 
				
			||||||
SkyHook for Unity
 | 
					SkyHook for Unity
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Installation
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. Open package manager with `Window -> Package Manager`
 | 
				
			||||||
 | 
					2. Press `+` button and find `Add package from git URL...`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					3. Enter `git+https://git.pikokr.dev/SkyHook/SkyHook-Unity.git` and press `Add` button
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Usage
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Start and stop hook
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```cs
 | 
				
			||||||
 | 
					SkyHookManager.StartHook(); // Start Hook
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					SkyHookManager.StopHook(); // Stop Hook, this is automatically called on exit
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Receive events
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					> NOTE: SkyHook does **NOT** give the correct key code. So you can't know what key the user actually pressed.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```cs
 | 
				
			||||||
 | 
					SkyHookMnager.KeyUpdated.AddListener(ev => {
 | 
				
			||||||
 | 
					  // Your code
 | 
				
			||||||
 | 
					});
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -0,0 +1,8 @@
 | 
				
			||||||
 | 
					fileFormatVersion: 2
 | 
				
			||||||
 | 
					guid: 0b3a9cda97ae65143ad4e6f61a449654
 | 
				
			||||||
 | 
					folderAsset: yes
 | 
				
			||||||
 | 
					DefaultImporter:
 | 
				
			||||||
 | 
					  externalObjects: {}
 | 
				
			||||||
 | 
					  userData: 
 | 
				
			||||||
 | 
					  assetBundleName: 
 | 
				
			||||||
 | 
					  assetBundleVariant: 
 | 
				
			||||||
										
											Binary file not shown.
										
									
								
							| 
		 After Width: | Height: | Size: 9.8 KiB  | 
| 
						 | 
					@ -0,0 +1,123 @@
 | 
				
			||||||
 | 
					fileFormatVersion: 2
 | 
				
			||||||
 | 
					guid: 073fcc6f1259329419e4bb6c3fb8e5ee
 | 
				
			||||||
 | 
					TextureImporter:
 | 
				
			||||||
 | 
					  internalIDToNameTable: []
 | 
				
			||||||
 | 
					  externalObjects: {}
 | 
				
			||||||
 | 
					  serializedVersion: 12
 | 
				
			||||||
 | 
					  mipmaps:
 | 
				
			||||||
 | 
					    mipMapMode: 0
 | 
				
			||||||
 | 
					    enableMipMap: 0
 | 
				
			||||||
 | 
					    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
 | 
				
			||||||
 | 
					  isReadable: 0
 | 
				
			||||||
 | 
					  streamingMipmaps: 0
 | 
				
			||||||
 | 
					  streamingMipmapsPriority: 0
 | 
				
			||||||
 | 
					  vTOnly: 0
 | 
				
			||||||
 | 
					  ignoreMasterTextureLimit: 0
 | 
				
			||||||
 | 
					  grayScaleToAlpha: 0
 | 
				
			||||||
 | 
					  generateCubemap: 6
 | 
				
			||||||
 | 
					  cubemapConvolution: 0
 | 
				
			||||||
 | 
					  seamlessCubemap: 0
 | 
				
			||||||
 | 
					  textureFormat: 1
 | 
				
			||||||
 | 
					  maxTextureSize: 2048
 | 
				
			||||||
 | 
					  textureSettings:
 | 
				
			||||||
 | 
					    serializedVersion: 2
 | 
				
			||||||
 | 
					    filterMode: 1
 | 
				
			||||||
 | 
					    aniso: 1
 | 
				
			||||||
 | 
					    mipBias: 0
 | 
				
			||||||
 | 
					    wrapU: 1
 | 
				
			||||||
 | 
					    wrapV: 1
 | 
				
			||||||
 | 
					    wrapW: 1
 | 
				
			||||||
 | 
					  nPOTScale: 0
 | 
				
			||||||
 | 
					  lightmap: 0
 | 
				
			||||||
 | 
					  compressionQuality: 50
 | 
				
			||||||
 | 
					  spriteMode: 1
 | 
				
			||||||
 | 
					  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: 1
 | 
				
			||||||
 | 
					  spriteTessellationDetail: -1
 | 
				
			||||||
 | 
					  textureType: 8
 | 
				
			||||||
 | 
					  textureShape: 1
 | 
				
			||||||
 | 
					  singleChannelComponent: 0
 | 
				
			||||||
 | 
					  flipbookRows: 1
 | 
				
			||||||
 | 
					  flipbookColumns: 1
 | 
				
			||||||
 | 
					  maxTextureSizeSet: 0
 | 
				
			||||||
 | 
					  compressionQualitySet: 0
 | 
				
			||||||
 | 
					  textureFormatSet: 0
 | 
				
			||||||
 | 
					  ignorePngGamma: 0
 | 
				
			||||||
 | 
					  applyGammaDecoding: 0
 | 
				
			||||||
 | 
					  cookieLightType: 0
 | 
				
			||||||
 | 
					  platformSettings:
 | 
				
			||||||
 | 
					  - serializedVersion: 3
 | 
				
			||||||
 | 
					    buildTarget: DefaultTexturePlatform
 | 
				
			||||||
 | 
					    maxTextureSize: 2048
 | 
				
			||||||
 | 
					    resizeAlgorithm: 0
 | 
				
			||||||
 | 
					    textureFormat: -1
 | 
				
			||||||
 | 
					    textureCompression: 1
 | 
				
			||||||
 | 
					    compressionQuality: 50
 | 
				
			||||||
 | 
					    crunchedCompression: 0
 | 
				
			||||||
 | 
					    allowsAlphaSplitting: 0
 | 
				
			||||||
 | 
					    overridden: 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
 | 
				
			||||||
 | 
					    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
 | 
				
			||||||
 | 
					    androidETC2FallbackOverride: 0
 | 
				
			||||||
 | 
					    forceMaximumCompressionQuality_BC6H_BC7: 0
 | 
				
			||||||
 | 
					  spriteSheet:
 | 
				
			||||||
 | 
					    serializedVersion: 2
 | 
				
			||||||
 | 
					    sprites: []
 | 
				
			||||||
 | 
					    outline: []
 | 
				
			||||||
 | 
					    physicsShape: []
 | 
				
			||||||
 | 
					    bones: []
 | 
				
			||||||
 | 
					    spriteID: 5e97eb03825dee720800000000000000
 | 
				
			||||||
 | 
					    internalID: 0
 | 
				
			||||||
 | 
					    vertices: []
 | 
				
			||||||
 | 
					    indices: 
 | 
				
			||||||
 | 
					    edges: []
 | 
				
			||||||
 | 
					    weights: []
 | 
				
			||||||
 | 
					    secondaryTextures: []
 | 
				
			||||||
 | 
					    nameFileIdTable: {}
 | 
				
			||||||
 | 
					  spritePackingTag: 
 | 
				
			||||||
 | 
					  pSDRemoveMatte: 0
 | 
				
			||||||
 | 
					  pSDShowRemoveMatteOption: 0
 | 
				
			||||||
 | 
					  userData: 
 | 
				
			||||||
 | 
					  assetBundleName: 
 | 
				
			||||||
 | 
					  assetBundleVariant: 
 | 
				
			||||||
		Reference in New Issue