Faithful Studio

Web application for managing Faithful user-created content and profiles with ease.

---

Requirements

• Node.js v22+ (https://nodejs.org)
• pnpm (corepack enable + corepack prepare pnpm@latest --activate)

Running

pnpm install

pnpm dev

Building

pnpm build

You can preview the production build with pnpm preview.

If you're using Apache to serve the site, make sure to set FallbackResource to point to ./dist/index.html so Vue routing works properly.

<VirtualHost *:80>
  DocumentRoot /your/site/path/here/dist
  FallbackResource /index.html
</VirtualHost>

API Reference

This project uses the Faithful API for retrieving and writing most dynamic data, such as texture information, user contributions, and available resource packs. Check out our API reference for documentation about each API endpoint, its associated types, and user authentication.

Translating

Many messages shown throughout the site can be translated into users' native languages for easier usage. Our translation service is powered by Crowdin, and you can start translating there by clicking on your language in the list. Please contact us on our Discord server if a language you want to translate isn't listed.