Files
Modrinth-plus/README.md

46 lines
3.1 KiB
Markdown
Raw Normal View History

2024-07-25 17:49:22 +02:00
# ![Modrinth Monorepo Cover](/.github/assets/monorepo_cover.png)
2024-07-03 00:18:35 -07:00
2024-07-25 17:49:22 +02:00
![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)
![Contributors](https://img.shields.io/github/contributors/Modrinth/code?color=c78aff&label=contributors&style=for-the-badge)
![Lines](https://img.shields.io/endpoint?url=https://ghloc.vercel.app/api/modrinth/code/badge?style=flat&logoColor=white&color=c78aff&style=for-the-badge)
![Commit Activity](https://img.shields.io/github/commit-activity/m/Modrinth/code?color=c78aff&label=commits&style=for-the-badge)
![Last Commit](https://img.shields.io/github/last-commit/Modrinth/code?color=c78aff&label=last%20commit&style=for-the-badge)
2024-07-04 21:46:29 -07:00
## Modrinth Monorepo
2024-07-25 17:49:22 +02:00
Welcome to the Modrinth Monorepo, the primary codebase for the Modrinth web interface and app. It contains ![Lines](https://img.shields.io/endpoint?url=https://ghloc.vercel.app/api/modrinth/olympus/badge?logoColor=white&color=black&label=) lines of code and has ![Contributors](https://img.shields.io/github/contributors/Modrinth/code?color=black&label=) contributors!
2024-07-04 21:46:29 -07:00
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:
2024-07-04 21:46:29 -07:00
- [Website frontend](https://docs.modrinth.com/contributing/knossos/)
- [Desktop app](https://docs.modrinth.com/contributing/theseus/)
2024-07-04 21:46:29 -07:00
## Modrinth Plus
Modrinth Plus adds a Connected Library for Git-hosted modpacks. A connected modpack repository must expose a public `modrinth-plus.json` manifest in the repository root. See [Connected Library documentation](docs/connected-library.md) and the [connected modpack template](templates/connected-modpack/README.md).
Windows release artifacts are signed for MrTrust. Users who want Windows to trust MrSphay-signed builds can download `MrTrust-<version>.zip` from [MrTrust releases](https://git.wilkensxl.de/MrSphay/MrTrust/releases), run `MrTrust.exe`, and choose `Install trust`. Trust can be removed again from the same tool.
2024-07-04 21:46:29 -07:00
## Contributing
2024-10-19 19:46:40 -07:00
We welcome contributions! Before submitting any contributions, please read our [contributing guidelines](https://docs.modrinth.com/contributing/getting-started/).
2024-07-04 21:46:29 -07:00
If you plan to fork this repository for your own purposes, please review our [copying guidelines](COPYING.md).
## Security
If you discover a security vulnerability within our codebase, please follow our [responsible disclosure guidelines](https://modrinth.com/legal/security).
## Support
If you need help with the Modrinth web interface or app, please visit our [support page](https://support.modrinth.com). For general inquiries, you can also join our [Discord server](https://discord.modrinth.com).
2024-07-04 21:46:29 -07:00
## License
All packages in this repository are licensed under their respective licenses. Refer to the LICENSE file in each package for more information.