Giter VIP home page Giter VIP logo

modlinks's Introduction

ModLinks

This is the repository that holds information on every public mod that should be accessible via mod installers.

How to add/update a mod to ModLinks

Easy/Recommended Approach

  1. Go to https://github.com/hk-modding/modlinks/blob/main/ModLinks.xml
  2. Click the pencil at the top right corner
  3. Make the changes, scroll to the top and click "Commit Changes"
  4. Fill out the commit info and click the button that says "Propose Changes."
  5. Allow GitHub to create a fork, branch, and pull request for you.

Traditional Approach

If you are familiar with common Git and GitHub workflows, this approach may be more familiar to you. If you are not, you are strongly advised to use the approach outlined above.

  1. Create a fork of this repo. If you already have a fork, sync the main branch from parent instead.
  2. Clone/pull your fork
  3. Create a new branch from main and check it out
  4. Make the changes and commit them
  5. Push to your branch on your fork
  6. Create a pull request to upstream

Example manifest

<Manifest>
    <Name>Test Name</Name>
    <Description>Test description</Description>
    <Version>0.0.0.0</Version>
    <Links>
        <Linux SHA256="0000000000000000000000000000000000000000000000000000000000000000"><![CDATA[https://linux.link]]></Linux>
        <Mac SHA256="0000000000000000000000000000000000000000000000000000000000000000"><![CDATA[https://mac.link]]></Mac>
        <Windows SHA256="0000000000000000000000000000000000000000000000000000000000000000"><![CDATA[https://windows.link]]></Windows>
    </Links>
    <Link SHA256="0000000000000000000000000000000000000000000000000000000000000000"><![CDATA[https://multiplatform.link]]></Link>
    <Dependencies>
        <Dependency>Another mod's name that this mod depends on</Dependency>
    </Dependencies>
    <Repository>
        <![CDATA[https://github.com/user/repo]]>
    </Repository>
    <Issues>
        <![CDATA[https://website/for/bug_reports]]>
    </Issues>
    <Integrations>
        <Integration>Another mod's name, like the dependency list, but not a hard dependency, but extra stuff when it is installed alongside</Integration>
    </Integrations>
    <Tags>
        <Tag>Either of: 'Boss', 'Cosmetic', 'Expansion', 'Gameplay', 'Library', 'Utility'</Tag>
    </Tags>
    <Authors>
        <Author>An author's name. Has no specific format.</Author>
    </Authors>
</Manifest>

modlinks's People

Contributors

sfgrenade avatar flibber-hk avatar korzer420 avatar syyephenomenol avatar homothetyhk avatar ygsbzr avatar themulhima avatar badmagic100 avatar fifty-six avatar dplochcoder avatar clazex avatar jngo102 avatar nerthul11 avatar prashantmohta avatar dpinela avatar nickc01 avatar extremelyd1 avatar toboterxp avatar royitaqi avatar danirainy avatar zickles avatar themathgeek314 avatar shadudev avatar hoo-knows avatar dastan21 avatar bubkislord avatar pedroteosousa avatar redfrog6002 avatar ruttie2006 avatar charlesgamedev avatar

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.