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

https://github.com/lunyaadev/vrcx-vrclist-tools


https://github.com/lunyaadev/vrcx-vrclist-tools

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# VRCX-VRCList-Tools

A (currently small) colletion of tools for [VRCX](https://github.com/vrcx-team/VRCX) and [VRCList](https://vrclist.com).

Current features:
- Automatically set worlds to visited on VRCList when visited

## Installation

Install python using the offical documentation https://www.python.org/downloads/

Install the requirements of this project

```bash
pip install -r requirements.txt
```

Copy the `config.example.cfg` to `config.cfg` and replace the `uuid` value with your VRCList uuid

To get your `uuid`:
1. Go to [vrclist.com](https://vrclist.com)
2. Login and open the BrowserDevTools by pressing `F12`
3. Navigate to the `Application` tab
4. There navigate to `Cookies` and then `https://vrclist.com`
5. Then copy the value of `uuid` and paste it into `config.cfg`
![Get The VRCList uuid](./images/vrclist_get_uuid.png)

## Usage

Start the project using the `start.bat`

or

```bash
python main.py
```

## Setup VRCX Auto-Launch (optional)

When adding the script to the VRCX Auto-Launch, it automatically starts with VRChat.

To add it to the Auto-Launch:
1. Open VRCX and go to Settings
2. Go to the `Advanced` Tab
3. Make sure Auto-Launch is enabled
4. Click on the `Auto-Launch Folder`
5. In the Project folder right click the `start.bat` file and `Create Shortcut`.
6. Move the shortcut file into the VRCX Auto-Launch Folder.
7. Right click the shortcut, go to Properties and change the `Run` mode to `Minimized`
![Open Auto-Launch folder](./images/vrcx_open_auto_launch_folder.png)

## Contributing

Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)