Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 1.49 KB

README.md

File metadata and controls

46 lines (29 loc) · 1.49 KB
Raw

ALCOM (experimental)

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

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 v20 (to build the web part of the project)
  • npm (to install the dependencies of the web part)
  • cargo (to build the Rust part of the project)
  • cargo-about (to generate the licenses json)
  • .NET SDK v8 (to build vrc-get-litedb crate)

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!)