Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/assets/api_client_cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/api_client_cover_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/assets/api_cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/api_cover_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/assets/app_cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/app_cover_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/docs_cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/docs_cover_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/meta_cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/meta_cover_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/assets/monorepo_cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/monorepo_cover_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/social_preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/ui_cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/ui_cover_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/assets/web_cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/web_cover_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 3 additions & 6 deletions COPYING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,11 @@ For detailed information, consult each package's COPYING.md, LICENSE.txt, or LIC

The use of Modrinth branding elements, including but not limited to the wrench-in-labyrinth logo, the landing image, and any variations thereof, is strictly prohibited without explicit written permission from Rinth, Inc. This includes trademarks, logos, or other branding elements.

> All rights reserved. © 2020-2025 Rinth, Inc.
> All rights reserved. © 2020-2026 Rinth, Inc.

This includes, but may not be limited to, the following files:
This includes, but may not be limited to, the following files or directories:

- .idea/icon.svg
- .github/api_cover.png
- .github/app_cover.png
- .github/monorepo_cover.png
- .github/web_cover.png
- .github/assets/

If you fork this repository, you must remove all Modrinth branding assets from your fork.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# ![Modrinth Monorepo Cover](/.github/assets/monorepo_cover.png)
<picture>
<source media="(prefers-color-scheme: light)" srcset=".github/assets/monorepo_cover_light.png">
<img alt="Modrinth Monorepo Cover" src=".github/assets/monorepo_cover.png">
</picture>

![Issues](https://img.shields.io/github/issues-raw/Modrinth/code?color=c78aff&label=issues&style=for-the-badge)
![Pull Requests](https://img.shields.io/github/issues-pr-raw/Modrinth/code?color=c78aff&label=PRs&style=for-the-badge)
Expand All @@ -9,16 +12,23 @@

## Modrinth Monorepo

Welcome to the Modrinth Monorepo, the primary codebase for the Modrinth web interface and app. It contains ![Lines of code](https://img.shields.io/endpoint?url=https://loctopus.creeperkatze.dev/github/modrinth/code/badge%3Fformat%3Dhuman&logoColor=white&color=black&label=) lines of code and has ![Contributors](https://img.shields.io/github/contributors/Modrinth/code?color=black&label=) contributors!
Welcome to the Modrinth Monorepo, the primary codebase for the Modrinth website, app, API and documentation. It contains ![Lines of code](https://img.shields.io/endpoint?url=https://loctopus.creeperkatze.dev/github/modrinth/code/badge%3Fformat%3Dhuman&logoColor=white&color=black&label=) lines of code and has ![Contributors](https://img.shields.io/github/contributors/Modrinth/code?color=black&label=) contributors!

If you're not a developer and you've stumbled upon this repository, you can access the web interface on the [Modrinth website](https://modrinth.com) and download the latest release of the app [here](https://modrinth.com/app).

## Development

This repository contains two primary packages. For detailed development information, please refer to their respective guides:
This repository contains several projects. For detailed development information, please refer to their respective guides:

- [Website frontend](https://docs.modrinth.com/contributing/knossos/)
- [Desktop app](https://docs.modrinth.com/contributing/theseus/)
| Project | Directory | Guide |
| ------------- | ---------------------- | --------------------------------------------------------- |
| Website | `apps/frontend` | [Guide](https://docs.modrinth.com/contributing/knossos/) |
| App | `apps/app` | [Guide](https://docs.modrinth.com/contributing/theseus/) |
| API | `apps/labrinth` | [Guide](https://docs.modrinth.com/contributing/labrinth/) |
| Meta | `apps/daedalus_client` | [Guide](https://docs.modrinth.com/contributing/daedalus/) |
| Documentation | `apps/docs` | [Guide](https://docs.modrinth.com/contributing/docs/) |

Shared libraries live in `packages/`.

## Contributing

Expand All @@ -36,4 +46,4 @@ If you need help with the Modrinth web interface or app, please visit our [suppo

## License

All packages in this repository are licensed under their respective licenses. Refer to the LICENSE file in each package for more information.
All packages in this repository are licensed under their respective licenses. See the [copying guidelines](COPYING.md) for details, including restrictions on Modrinth branding.
5 changes: 4 additions & 1 deletion apps/app/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# ![Modrinth App](/.github/assets/app_cover.png)
<picture>
<source media="(prefers-color-scheme: light)" srcset="../../.github/assets/app_cover_light.png">
<img alt="Modrinth App Cover" src="../../.github/assets/app_cover.png">
</picture>

## Modrinth App

Expand Down
5 changes: 5 additions & 0 deletions apps/daedalus_client/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<picture>
<source media="(prefers-color-scheme: light)" srcset="../../.github/assets/meta_cover_light.png">
<img alt="Modrinth Meta Cover" src="../../.github/assets/meta_cover.png">
</picture>

# Daedalus

Daedalus is a powerful tool which queries and generates metadata for the Minecraft (and other games in the future!) game
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<picture>
<source media="(prefers-color-scheme: light)" srcset="../../.github/assets/docs_cover_light.png">
<img alt="Modrinth Docs Cover" src="../../.github/assets/docs_cover.png">
</picture>

# Modrinth Documentation

Welcome to the Modrinth documentation!
Expand Down
5 changes: 4 additions & 1 deletion apps/frontend/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# ![Frontend Cover](/.github/assets/web_cover.png)
<picture>
<source media="(prefers-color-scheme: light)" srcset="../../.github/assets/web_cover_light.png">
<img alt="Modrinth Website Cover" src="../../.github/assets/web_cover.png">
</picture>

# Modrinth Web Interface

Expand Down
5 changes: 4 additions & 1 deletion apps/labrinth/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
![labrinth banner](/.github/assets/api_cover.png)
<picture>
<source media="(prefers-color-scheme: light)" srcset="../../.github/assets/api_cover_light.png">
<img alt="Modrinth API Cover" src="../../.github/assets/api_cover.png">
</picture>

## Modrinth's laboratory for its backend service & API!

Expand Down
5 changes: 5 additions & 0 deletions packages/api-client/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<picture>
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/modrinth/code/main/.github/assets/api_client_cover_light.png">
<img alt="Modrinth API Client Cover" src="https://raw.githubusercontent.com/modrinth/code/main/.github/assets/api_client_cover.png">
</picture>

# @modrinth/api-client

[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-c78aff?style=for-the-badge)](https://www.typescriptlang.org/)
Expand Down
5 changes: 5 additions & 0 deletions packages/daedalus/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<picture>
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/modrinth/code/main/.github/assets/meta_cover_light.png">
<img alt="Modrinth Meta Cover" src="https://raw.githubusercontent.com/modrinth/code/main/.github/assets/meta_cover.png">
</picture>

# Daedalus

Daedalus (the rust library) is a library providing model structs and methods for requesting and parsing things
Expand Down
36 changes: 36 additions & 0 deletions packages/ui/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<picture>
<source media="(prefers-color-scheme: light)" srcset="../../.github/assets/ui_cover_light.png">
<img alt="Modrinth UI Cover" src="../../.github/assets/ui_cover.png">
</picture>

# @modrinth/ui

The shared Vue 3 component library used by both the [Modrinth Website](../../apps/frontend) and the [Modrinth App](../../apps/app-frontend). Components are platform-agnostic, with platform-specific behavior provided through dependency injection.

## Structure

```
src/
├── components/ # Vue components, grouped by feature
├── composables/ # Composition API hooks
├── layouts/ # Page layouts shared between the website and app
├── providers/ # Dependency injection contexts
├── utils/ # Utility functions and constants
├── locales/ # Translations
├── styles/ # Tailwind CSS utilities
└── stories/ # Storybook stories
```

Everything public is re-exported from [`index.ts`](./index.ts).

## Development

Browse and develop components in isolation with Storybook, from the repository root:

```bash
pnpm storybook
```

## License

Licensed under the GNU General Public License v3. Modrinth branding is excluded, see [COPYING.md](./COPYING.md) for details.
Loading