Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reviversmc/modget-manifests
Manifest repository for Modget
https://github.com/reviversmc/modget-manifests
Last synced: 4 days ago
JSON representation
Manifest repository for Modget
- Host: GitHub
- URL: https://github.com/reviversmc/modget-manifests
- Owner: ReviversMC
- License: agpl-3.0
- Created: 2021-06-07T11:32:46.000Z (over 3 years ago)
- Default Branch: v4
- Last Pushed: 2022-04-14T17:29:11.000Z (over 2 years ago)
- Last Synced: 2023-07-14T00:23:39.974Z (over 1 year ago)
- Homepage:
- Size: 1.37 MB
- Stars: 9
- Watchers: 1
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Modget Manifest Repository
This repository contains the manifest files for the **Modget** default source. You are highly encouraged to submit manifests for your favorite mod.
[**Modget**](https://github.com/ReviversMC/modget-minecraft) is an open source Minecraft mod package manager.
# Contributing
This project welcomes contributions and suggestions.
For the avoidance of doubt, you may not make any submissions linking to third party materials if such submission is prohibited by the applicable third party and/or otherwise violates such third party's rights.
# Submitting a Package
To submit a package to this repository, you should follow these steps:
1. Follow the contribution guidelines above.
2. [Author](#authoring-a-manifest) a manifest.
3. [Test](#testing-your-manifest) your manifest.
4. [Add](#adding-your-package-to-the-lookup-table) your manifest to the lookup table.
5. [Submit](#submitting-your-pr) your pull request (PR).
6. Respond to any feedback in your PR.
> Note: Please check the package's manifest you intend to submit does not already exist in the repository, and there are no open PRs for it in order to avoid duplicates.
## Authoring a Manifest
In the future, you will be able to use the [Modget Manifest Creator](https://github.com/ReviversMC/modget-create). Currently, you have to craft a manifest manually following our [authoring guidelines](AUTHORING_MANIFESTS.md).
> Note: Only one manifest may be submitted per PR.
## Testing your manifest
Now that you have authored your manifest, you should make sure it works as expected. Simply copy your local repository into the `/modget/local_repos/` directory inside your Minecraft directory.
> ❗ Note: Modget doesn't support the following commands yet!
1. Verify the syntax by executing the following command:
```
/modget validate --local
```
2. Test the install by executing the following command:
```
/modget install --local
```
## Adding your package to the lookup table
With the manifest verified, you have to now add some basic metadata to the [lookup table](./lookup-table.yaml). See the [lookup table spec](./doc/spec/lookup-table-spec.md) on how to do this.
## Submitting your PR
With all of this out of the way, you will finally need to submit a PR. Your manifest should be located in the folder path matching `manifests / / / ` (see the [file name and folder structure](./doc/spec/manifest-spec.md#file-names-and-folder-structure)).
### Validation Process
The PR request will go through a validation process. During the process, the core team or (in the future) the Modget bot will use [labels](https://docs.microsoft.com/windows/package-manager/package/winget-validation#pull-request-labels) to help. In the event of a failure, the bot will suggest where the problem is with the submission and assign the PR back to you.
### Respond to PR feedback
If the PR has been assigned to you, a timer is triggered. You will have 7 days to resolve the issue, or the PR will be closed automatically by the bot.
Submissions to the repository are reviewed by Modget administrators and/or moderators.
#### Administrators:
- [@NebelNidas](https://github.com/NebelNidas)
#### Maintainers:
- [@thefirethirteen](https://github.com/thefirethirteen)