Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Fix the readme so it only contains relevant information to the release.
  • Loading branch information
Hotrian committed Jun 23, 2016
1 parent 2d5130c commit ce733ea
Showing 1 changed file with 6 additions and 30 deletions.
36 changes: 6 additions & 30 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,46 +22,22 @@ Note that these demos were taken during development, and do not necessarily repr
- Easily attach Chat to the Screen, a Controller, or drop it in the World.
- Easily snap Controller attached Chat to a set "Base Position".
- Offset Chat positionally and rotationally.
- Custom Inspector with Undo support.
- Basic Gaze Detection and Animation support (Fade In/Out or Scale Up/Down on Gaze).
- Extremely Basic Save/Load Support! Saves Username/Channel but does not save OAuth Key!

**Known Issues:**
- There is no feedback when you type in an incorrect Username, OAuth, or Channel. If you press connect and do not receive messages, double check your spelling!
- SteamVR_ControllerManager.cs doesn't correctly auto-identify controllers for me, so I wrote my own manager, HOTK_TrackedDeviceManager.cs. My Device Manager is super pre-alpha but should correctly identify both Controllers as long as at least one of them is assigned to either the left or right hand, and they are both connected. If neither Controller is assigned to a hand, they are assigned on a first come first serve basis. If only one Controller is connected, and it isn't already assigned, it will be assigned to the right hand.
- If you launch it and nothing happens in VR, check the Data folder for output_log.txt and look for "Connect to VR Server Failed (301)" If you are getting this, try relaunching as Admin and if that doesn't work try launching as Admin in Compatability mode, some users have found that it only works this way, but I am not sure why yet.
- If you launch it and nothing happens in VR, check the Data folder for output_log.txt and look for "Connect to VR Server Failed (301)" if you're getting that error, try restarting your PC, and if that doesn't work [try this solution](https://www.reddit.com/r/Vive/comments/4p9hxg/wip_i_just_released_the_first_build_of_my_cross/d4kmvrj) by /u/GrindheadJim:

>For clarification, what I did was right-click on the .exe file, clicked "Properties", went to the "Compatibility" tab, and checked the box under "Run as Administrator". For the record, I have also done this with Steam and SteamVR. If you're having any issues with any of these programs, I would start there.
**Additional Notes:**
- When attaching Overlays to controllers, the offset is reoriented to match the Base Position's orientation. X+ should always move the Overlay to the Right, Y+ should always move Up, and Z+ should always move Forward, relative to the Overlay.
- The Custom Inspector has custom collapse elements. You can change the default "collapse status" by messing with the defaults for ShowSettingsAppearance, ShowSettingsInput, and ShowSettingsAttachment at the top of HOTK_Overlay.cs.
- Only one Overlay can be 'High Quality' at a time. An Overlay must be 'High Quality' to display Curved or with Anti-Aliasing as per the [OpenVR API](https://github.com/ValveSoftware/openvr/wiki/IVROverlay::SetHighQualityOverlay). 'High Quality' Overlays skip the Compositor and are drawn directly to the display. If you enable multiple HQ Overlays, any additional ones will have HQ toggled off and you'll receive a warning.

**Quick Start** for Unity Editor:
- Download and Install [Unity](https://unity3d.com/get-unity/download?ref=personal) (I'm using version 5.3.5f1)
- Download [the repo as a zip](https://github.com/Hotrian/HeadlessOverlayToolkit/archive/twitchtest.zip) and unzip the folder inside.
- Launch Unity
- [Click 'Open'](http://image.prntscr.com/image/49b79aeea81e4ad48d1b56df76cef5fb.png), select the folder you unzipped, [click 'Select Folder'](http://image.prntscr.com/image/8c851924eacf4d44944498b26dad74ed.png)
- Once Unity Loads the project, [Load up the TwitchChat Demo scene](http://image.prntscr.com/image/1bc9e550f875468bb49558b76cc2d1f9.png)
- [Click Play](http://image.prntscr.com/image/4eba127a9d59427fa1c5b6a06aac8eed.png)
- Once the project starts, enter your Username, OAuth key (this is basically a password, you can [get yours here](https://twitchapps.com/tmi/)), and desired Channel name [into these boxes](http://image.prntscr.com/image/9ba697c9537d431e8f1b58813cb677a0.png) and click "Press to Connect"
- With any luck, your twitch chat should appear behind one of your controllers :D

**If you want to run this headless:**

Check out the [documentation here](http://docs.unity3d.com/Manual/CommandLineArguments.html) on how to run Unity headless. There are a few different ways to do this.

The basic steps to create a shortcut on Windows that launches headless are:
- Build your Application
- Create a Shortcut to your Application
- Right Click the Shortcut > Properties
- Put " -batchmode" at the end of the text in the 'Target' box
- Launch your Shortcut, and your Application should launch hidden
- You can crash your Application through the Task Manager, but be sure to add a graceful way to quit in the future :)

To run the twitchtest variant headless, you'll have to modify the scripts so that they automatically input the correct Username, OAuth, and Channel name, before starting automatically.

**Special Thanks:**

Thanks to Grahnz for the base [TwitchIRC.cs](https://github.com/Grahnz/TwitchIRC-Unity/blob/master/TwitchIRC.cs) script!

Thanks to [Eric Daily](http://tutsplus.com/authors/eric-daily) for the base [SaveLoad](http://gamedevelopment.tutsplus.com/tutorials/how-to-save-and-load-your-players-progress-in-unity--cms-20934) script!
Thanks to [Eric Daily](http://tutsplus.com/authors/eric-daily) for the base [SaveLoad](http://gamedevelopment.tutsplus.com/tutorials/how-to-save-and-load-your-players-progress-in-unity--cms-20934) script!

Thanks to everyone who has tested it so far! The feedback has really helped speed things along!

0 comments on commit ce733ea

Please sign in to comment.