vrc-get/vrc-get-gui

ALCOM (experimental)

This folder contains the experimental GUI version of vrc-get, ALCOM.

Homepage (Help Wanted)

Installation

The recommended way to install ALCOM is download from GitHub Releases.

If you want, you may download the HEAD build from GitHub Actions

Requirements (building)

To build ALCOM, you need to have the following installed:

• Node.js LTS — to build the web part of the project
• npm v10 — to install the dependencies of the web part (bundled with node.js so no extra attention needed in most case)
• cargo latest — to build the most part of the project
• cargo-about latest — to generate the licenses json (for development, not required but required for building release binary)
• .NET SDK v8 — to build vrc-get-litedb crate

Please note that ALCOM requires the latest version of cargo and cargo-about at that time. We update the required version of cargo and cargo-about without notice. Therefore, you may need to update them before building the project.

Building

To build the project, run the following command:

npm run tauri build

Development

ALCOM is currently based on tauri and next.js.

Run npm run tauri dev to start the development server and gui.

Contribution

For how to contribute localization to ALCOM (vrc-get-gui): CONTRIBUTING.md (Please read ../CONTRIBUTING.md#configuration-requirements first before you read CONTRIBUTING.md!)