alt:V JavaScript Guide

Click to Open Documents

A set of documentation that will help you understand alt:V and writing JavaScript code for it.

It is not an API reference and is meant to teach some of the lingo and details about alt:V.

Unofficial alt:V Documentation Discord

Development / Testing

$ npm install

$ npm run dev

Creating Translations

We recommend that each individual file you update has its own commit.

This keeps the history for commits clean and easy to track backwards.

Creating a New Locale / Translation

It's a pretty short process but requires some work.

0. Fork the Repository

1. Copy en.js from src/.vuepress/locales/en.js.

2. Rename it to your two letter ISO-639-1 Code.

3. Edit the titles and translate them. Follow instructions in the copied code. We left comments for you.

4. Copy the folder en from the src directory.

5. Rename it to your ISO-639-1 Code for your Country / Language.

6. Begin converting documents from English to your language.

7. Test locally! It's very important!

8. Make a pull request.