Skip to content

Latest commit

 

History

History
56 lines (49 loc) · 2.34 KB

ReadMe.md

File metadata and controls

56 lines (49 loc) · 2.34 KB
Raw

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>