Welcome to ArcLock Project
ArcLock Project is a set of React components and small TypeScript libraries, published as separate npm packages. Each package can be used on its own.
Packages
| Package | What it is | Docs |
|---|---|---|
@arclockproject/common | Reusable React components and small libraries. | Guides · API |
@arclockproject/mmd-player | An MMD (MikuMikuDance) loader and player. | Guides · API |
Getting started
Open a package's page to see how to install it. Each guide page lists anything else it needs.
How are these docs organised?
- Guides (under each package in the sidebar) explain what something is for and have live examples. Click Show code on an example to see and edit its code, and the result updates as you type.
- API pages list every prop, function, method and type. They are generated from the code, so they are always up to date.
- Roadmap lists what is planned next.
Help and contributing
- Found a bug or have a question? Open an issue.
- Want to contribute? Read the contributing guide.