Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ajedi32/echovr-tray-tool

A small background application for enhancing your experience with Echo VR
https://github.com/ajedi32/echovr-tray-tool

discord echo-vr virtual-reality

Last synced: about 3 hours ago
JSON representation

A small background application for enhancing your experience with Echo VR

Host: GitHub
URL: https://github.com/ajedi32/echovr-tray-tool
Owner: Ajedi32
License: mit
Created: 2018-12-05T04:33:12.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2018-12-26T22:50:12.000Z (almost 6 years ago)
Last Synced: 2024-10-24T04:26:13.161Z (13 days ago)
Topics: discord, echo-vr, virtual-reality
Language: Python
Size: 97.7 KB
Stars: 2
Watchers: 2
Forks: 2
Open Issues: 3
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Echo VR Tray Tool

Echo VR Tray Tool is a small, unofficial utility designed to run continuously in the background and provide various services to enhance your experience with Echo VR.

![Screenshot. Discord status: Connected. Echo VR client status: Connected.](docs/images/main_window_screenshot.png)

Right now, it only provides one service: Discord Rich Presence integration. In the future, more functionality such as stat tracking, party management, and streaming client integration may be provided. If you'd like to help add a service, see [Contributing](#contributing) below. For feature requests, file an issue or ask on the [Echo VR Discord server](https://discord.gg/bPB7v8d).

## Features

### Integration with Discord Rich Presence

Display your current in-game status on Discord when Echo VR is running:

![Screenshot of Discord Rich Presence with the Echo VR Tray Tool](docs/images/discord_presence_screenshot.png)

## Usage

Right now, getting the tool running requires a bit of technical skill. In the future, a PyPi package (and possibly even an installer) may be provided, which will make installation significantly easier.

First, [install Python](https://www.python.org/downloads/) 3.7 and [Poetry](https://github.com/sdispater/poetry#installation). Next, download the Echo VR Tray Tool source code [via zip file](https://github.com/Ajedi32/echovr-tray-tool/releases) or with git (definitely the latter if you're planning to modify the source).

Next, open the directory containing the source in a command line terminal and run:

```
poetry install --no-dev
poetry run python -m echovr_tray_tool
```

The application should start. If you don't see it immediately, check the system tray in the bottom-right.

### Connecting to Echo VR

In order for the Echo VR Tray Tool to communicate with Echo VR, you will need to launch Echo VR via the command line and pass it the `-http` flag. Since this is rather inconvenient, we recommend that you modify the Oculus desktop client configuration to do this for you automatically.

To do this, go to the location where Oculus Desktop is installed (usually `C:\Program Files\Oculus`) and then go under Software > Manifests. Find the files `ready-at-dawn-echo-arena.json` and `ready-at-dawn-echo-arena.json.mini`. First, **make backup copies of each of these files in case something goes wrong**. Next, go to the very end of each file, find the section that says `"launchParameters":`, replace the part immediately following that that says `null,` with `"-http",` (including the quotes). Then save the files and restart Oculus Desktop (Settings -> Beta -> Restart).

If, after saving the files your Oculus desktop client will no longer start, restore the files from the backup copies you made and reboot your computer. This should fix the problem and allow you Oculus desktop to start. You're now free to either try again (make sure you follow the instructions above exactly), or file an issue in this repository or ask for help in the [Echo VR Discord Server](https://discord.gg/bPB7v8d).

Once you've modified the files and restarted Oculus desktop, launch Echo VR. Open the Echo VR Tray Tool and check that it shows the client status as "Connected". If this works, you should be good to go.

Note that the configuration changes you made in this step might get undone when Echo VR releases an update, so if in the future you find that the Echo VR Tray tool is no longer connecting, you might need to run through this again.

In the future, we may provide functionality within the Tray Tool itself to handle reconfiguring the Oculus Desktop client automatically.

### Generating a Shortcut

Once you have installed all dependencies (see above) you can generate a shortcut to make it easier to launch the Echo VR Tray tool in the future. Simply right-click on the `create_shortut.ps1` file in the Tray Tool's source directory and click "Run with PowerShell". That script should then create a `Echo VR Tray Tool.lnk` file in the source directory that you can move anywhere you want (such as to your desktop or start menu).

### Running on start up

Once you have installed all dependencies (see above) you can configure the Echo VR tray tool to run automatically when you start your computer. This will allow features like Discord Presence and (in the future) stat tracking to work passively in the background without requiring any conscious effort on your part.

To set this up, simply right-click on the `install_startup.ps1` file in the Tray Tool's source directory and click "Run with PowerShell". That script should then create a `Echo VR Tray Tool.lnk` shortcut in your system's start up folder (`%APPDATA%\Microsoft\Windows\Start Menu\Programs\Startup`).

To uninstall, right-click on the `uninstall_startup.ps1` file in the Tray Tool's source directory and click "Run with PowerShell". (Or just remove the `%APPDATA%\Microsoft\Windows\Start Menu\Programs\Startup\Echo VR Tray Tool.lnk` file manually.)

In the future, we may provide functionality within the Tray Tool to let you run it on start-up with a single click.

## Contributing

First, [install Python](https://www.python.org/downloads/) 3.7 and [Poetry](https://github.com/sdispater/poetry#installation), and [git](https://git-scm.com/). Clone the repository with git, then open the downloaded directory in a command line (preferably git bash, which comes with git) and run:

```
poetry install
```

You can run your version of the Tray Tool with:

```
poetry run python -m echovr_tray_tool
```

### License

The Echo VR Tray Tool's source code and associated files are freely available under the [MIT License](./MIT_LICENSE). All Echo VR logos and game assets are property of Ready At Dawn Studios® (who are unaffiliated with this project). All other dependencies of the Echo VR Tray Tool (including Python, Qt, and all required Python packages) are distributed under their respective licenses.