Greedy Mods

The existing list of Greedy mods available for download.

Greed queries the catalogs in this repository, which provides it with the paths required for installation.

Contributing

Joining the League

So you want to join the League, eh? Here's the process:

1. Create a Greedy mod.
2. Publish it online somewhere. Two rules:
   1. It must be accessible to the open internet with a static URL, such as a GitHub release or a Dropbox link.
      1. Discord and UploadNow URLs are not static.
   2. It must be a .zip or .rar.
3. Petition a Maintainer or higher in the League of Greedy Modders for access.
   1. You will need a GitHub account to join.
   2. The Maintainer will validate that you have in fact made a Greedy mod and will consider if you would be a good fit.
   3. If they decide you are, you will be invited to the League of Greedy Modders organization on GitHub via email.
   4. After accepting, the Maintainer will elevate your permissions on Greedy-Mods to Write, allowing you to contribute.
   5. If you have further questions with the process, they will be happy to assist you.

Merge Process

1. Clone the Greedy-Mods repository onto your own computer.
2. Create a new git branch locally.
3. Make your changes on your local branch.
   1. Open Greed
   2. Disable all mods except your new/updated mod, which must be active.
   3. Go to the Developer tab and press the Generate Catalog JSON button.
   4. Paste the resulting JSON into your local copy of Greedy-Mods/catalogs/<schema version>.json.
4. Commit and Push your changes to the Remote branch (GitHub)
5. Validate the installation using your branch as a test channel in Greed.
6. On GitHub, create a Pull Request (aka PR, Merge Request, or MR) between your branch and main.
7. Find another member of the League to review your code.
8. Once they have approved your MR, you can Merge your changes.

Local Test Channel

For your own local testing or when validating another LGM member's merge request, you can set a custom Catalog Channel.

1. Open Greed to the Developer Tab
2. Paste the path of your remote branch's catalogs/<schema version>.json into the Catalog Channel text field
3. Navigate to the Greedy Mods tab and hit the refresh button.
4. Click the online catalog button, and you should see the mods in your custom version.

Catalog Schema

The Catalog is an array of Entries

Entry Object

Field	Type	Description
id*	string	This name of the folder your mod will occupy once installed in the mods folder.
name*	string	The human-readable name of the mod.
author*	string	Your name/username.
description*	string	A brief summary of your mod. Save details for the readme.
url*	url	The URL to your thread or repo where you give greater details about your mod. Details beyond what is covered in the description should be covered here. - Dropbox: If you are using Dropbox, make sure your link ends in dl1, not dl0.
versions*	dictionary<version,versionDetails>	A dictionary mapping versions of your mod to version detail objects.
latest*	version	The most recent version of your mod that will be the default download for it.

Version Detail Object

Field	Type	Description
download	url	A link to a publicly-available .zip or .rar file somewhere on the internet. (I recommend a GitHub release.) If you want users to download manually, rather than through the auto-downloader, provide the instructions to download it in your url link above and leave this field undefined.
sinsVersion*	version	The minimum compatible Sins version.
greedVersion*	version	The minimum compatible Greed version.
dependencies*	dependency[]	An array of dependencies.
conflicts*	string[]	An array of mod ids with which this mod is incompatible.
date*	MM/DD/YYYY	The date on which you published your mod.

Dependency Object

Field	Type	Description
id*	string	The id of the mod on which this mod depends.
version*	version	The minimum required version of the dependency.

Examples

Standard Mod

        {
            "id": "constituent-components",
            "name": "Constituent Components",
            "author": "Volt Cruelerz",
            "description": "Improves the roster of ship components.",
            "url": "https://github.com/VoltCruelerz/constituent-components",
            "versions": {
                "1.3.0": {
                    "download": "https://github.com/VoltCruelerz/constituent-components/archive/refs/tags/1.3.0.zip",
                    "sinsVersion": "1.15.1.0",
                    "greedVersion": "1.7.0",
                    "dependencies": [],
                    "conflicts": [],
                    "date": "09/04/2023"
                },
                "1.2.0": {
                    "download": "https://github.com/VoltCruelerz/constituent-components/archive/refs/tags/1.3.0.zip",
                    "sinsVersion": "1.15.1.0",
                    "greedVersion": "1.4.0",
                    "dependencies": [],
                    "conflicts": [],
                    "date": "09/04/2023"
                }
            },
            "latest": "1.3.0"
        }

Mod With Dependencies

        {
            "id": "b_dependent",
            "name": "B Dependent",
            "author": "TEST",
            "description": "Child of the chain",
            "url": "https://github.com/VoltCruelerz",
            "versions": {
                "1.0.0": {
                    "download": "https://raw.githubusercontent.com/League-of-Greedy-Modders/Greedy-Mods/main/beta/b_dependent.zip",
                    "sinsVersion": "1.15.1.0",
                    "greedVersion": "1.7.0",
                    "dependencies": [
                        {
                            "id": "a_dependency",
                            "version": "1.0.0"
                        }
                    ],
                    "conflicts": [],
                    "date": "09/04/2023"
                }
            },
            "latest": "1.0.0"
        }

Mod With No Download

        {
            "id": "Gauss Weapon Rework",
            "name": "Gauss Weapon Rework",
            "author": "Shrimple",
            "description": "This mod reworks the Gauss weapon type for the TEC Loyalists and TEC Rebels.",
            "url": "https://discord.com/channels/266693357093257216/1148026045124059247",
            "versions": {
                "1.2.0": {
                    "sinsVersion": "1.15.1.0",
                    "greedVersion": "1.5.0",
                    "dependencies": [],
                    "conflicts": [],
                    "date": "09/04/2023"
                }
            },
            "latest": "1.2.0"
        }