Giter Club home page Giter Club logo

modget-manifests's Introduction

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 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 a manifest.
  3. Test your manifest.
  4. Add your manifest to the lookup table.
  5. Submit 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. Currently, you have to craft a manifest manually following our authoring guidelines.

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 <package id> --local
  1. Test the install by executing the following command:
/modget install <package id> --local

Adding your package to the lookup table

With the manifest verified, you have to now add some basic metadata to the lookup table. See the lookup table spec 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 / <first upper case letter of publisher> / <publisher> / <modid> (see the file name 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 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:

Maintainers:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.