Skip to content

README.md

Latest commit

聽

History

History
65 lines (41 loc) 路 1.75 KB

README.md

File metadata and controls

65 lines (41 loc) 路 1.75 KB
Raw

VRCT Documentation

VRChat Chatbox Translation (VRCT) is a tool that enables real-time translation and transcription for VRChat. This repository contains the official documentation website for VRCT.

馃摉 About

VRCT Documentation is built using Docusaurus, a modern static website generator. The documentation covers:

  • Installation & Setup: Getting started with VRCT
  • Feature Guide: Detailed guides for all VRCT features
  • UI Guide: Overview of the main window and configuration options
  • FAQ: Common questions and troubleshooting

馃殌 Quick Start

Prerequisites

  • Node.js 20.0 or higher
  • npm (comes with Node.js)

Installation

git clone https://github.com/misyaguziya/VRCT-Docs.git
cd VRCT-Docs
npm install

Local Development

npx docusaurus start

This command starts a local development server and opens a browser window at http://localhost:3000. Most changes are reflected live without having to restart the server.

Build for Production

npm run build

This command generates static content into the build directory and can be served using any static hosting service.

Serve Built Site Locally

npm run serve

This command serves the built site locally for testing before deployment.

馃搫 License

This documentation is part of the VRCT project. Please refer to the main VRCT repository for license information.

馃敆 Links

馃摓 Support

For issues related to VRCT itself, please visit the main VRCT repository. For documentation-specific issues, please open an issue in this repository.