mcmodfixes.py

#!/usr/bin/python

# Fixes and mod-specific data for various mods' mcmod.info files

import fnmatch

DEP_BLACKLIST = set((
    "mod_MinecraftForge",   # we always have Forge
    "Forge", # typo(?) for mod_MinecraftForge
    "FML", # we always have FML
    "MinecraftForge", # another typo for mod_MinecraftForge
    "MinecraftForge, CodeChickenCore", # typo for CodeChickenCore, broken string instead of a real list
    "MinecraftForge,CoFHCore", # typo for ["MinecraftForge","CoFHCore"]
    "Industrialcraft", # typo for IC2
    "GUI_Api", # typo for GuiAPI and not needed on server
    "EurysCore", # replaced by SlimevoidLib?
    "Modular Powersuits", # mmmPowersuits
    "mod_NotEnoughItems", # chargepads
    "mod_IC2", # MFFS
    ))


DEP_ADDITIONS = {
    "MFFS": ["IC2"],
    "gregtech": ["IC2"],
    "dimensional-anchor": ["IC2"],
    "MineFactoryReloaded": ["PowerCrystalsCore"],
    "NetherOres": ["PowerCrystalsCore"],
    "PowerConverters": ["PowerCrystalsCore"],
    "FlatBedrock": ["PowerCrystalsCore"],
    "immibis-microblocks": ["ImmibisCore"],
    "SlopesAndCorners": ["SlimevoidLib"],
    "ChickenChunks": ["CodeChickenCore"],
    "EnderStorage": ["CodeChickenCore"],
    "TrailMix": ["iChunUtil"],
    "Torched": ["iChunUtil"],
    "MPSA": ["mmmPowersuits"],
    "ThermalExpansion": ["CoFHCore"],
    "OmniTools": ["CoFHCore"],
    "ElectricExpansion": ["BasicComponents"],
    "OpenCCSensors": ["ComputerCraft"],
    "Translocator": ["CodeChickenCore"],
    "miscperipherals": ["ComputerCraft"],
    "chargepads": ["NotEnoughItems"],
    "MekanismGenerators": ["Mekanism"],
    "MekanismTools": ["Mekanism"],
    "thaumicbees": ["Forestry"],
    "Galacticraft": ["IC2"], # requires IC2, UE, or TE - picked one: <strong><h1>Galacticraft Requires Basic Components, IndustrialCraft 2, or Thermal Expansion!</h1></strong><br /><h3>You can enable Basic Components loader in the Galacticraft config or install IndustrialCraft 2/Thermal Expansion manually</h3>
    "extra-bees": ["Forestry"],
    "PluginsforForestry": ["denLib", "Forestry", "ThermalExpansion"],
    "DartCraft": ["IC2"],
    }

MOD_IDS = {
    "PowerCrystalsCore*": ["PowerCrystalsCore"],
    "*bspkrsCore*": ["mod_bspkrsCore"], # newline in json, can't parse
    "BasicComponents*": ["BasicComponents"], # no mcmod.info
    "denLib*": ["denLib"], # no mcmod.info
    "DartCraft*": ["DartCraft"], # no mcmod.info
    }

FILENAME_HAS_NO_VERSION = [
    "gregtechmod.zip", # "If you are unsure about your Version, look at the "mcmod.info" inside the zip, just open it with Notepad."
    "WeaponMod.zip",
    "Barrels 1.5+.jar",
    "ArchimedesShips.zip",
    ]

REQUIRES_EXTRACTION = {
    # mod name : extracted from this folder
    "Millenaire": "Put in mods folder", 
    "BattleTowers": "mods",
    "KenshiroMod": "mods",
    "MagicYarn": "mods",
    "Ruins": "mods",
    #"RopePlus": "mods", # not
    "BetterDungeons": "mods", # but also requires extra files .minecraft..
    "Dynmap": "mods",
    }

USES_UNSHIFTED_ITEM_IDS = [
    "immibis-*",
    ]

# convert "name" on http://bot.notenoughmods.com/1.5.1.html to internal mod ID, when they don't match
NEM_TO_MODID = {
    "bau5_ProjectBench": "ProjectBench",
    "TheBarrelsMod": "barrels",
    "Buildcraft": "BuildCraft|Core",
    "CustomMobSpawner": "CustomSpawner",
    "Mo'Creatures": "MoCreatures",
    "EquivalentExchange3": "EE3",
    "GravityGun": "GraviGun",
    "GregTech": "GregTech_Addon",
    "NuclearControl": "IC2NuclearControl",
    "Immibis'sMicroblocks": "ImmibisMicroblocks",
    "Immibis'sPeripherals": "u'ImmibisPeripherals",
    "IndustrialCraft2": "IC2",
    "IronChests": "IronChest",
    "AdvancedSolarPanels": "AdvancedSolarPanel",
    "ModularPowersuits": "mmmPowersuits",
    "ModularPowersuits-Addons": "u'PowersuitAddons",
    "NEIMystcraftPlugin": "NEI-Mystcraft-Plugin",
    "TinkersConstruct": "TConstruct",
    "EnchantingPlus": "eplus",
    }

def getExtraDeps(mod):
    for k, v in DEP_ADDITIONS.iteritems():
        if mod.startswith(k):
            return set(v)
    return set()

def fixDeps(mod, deps):
    deps = set(deps)
    deps -= DEP_BLACKLIST
    deps |= getExtraDeps(mod)

    deps = [dep.split("@")[0] for dep in deps]  # remove version constraints

    return deps


def fixModIDs(mod, ids):
    for k, v in MOD_IDS.iteritems():
        if fnmatch.fnmatch(mod, k):
            return v 

    return ids

def modNeedsRename(fn):
    for k in FILENAME_HAS_NO_VERSION:
        if fn.startswith(k):
            return True
    return False

"""Get the folder name in a mod zip which tells you to install it into the mod folders."""
def getInstructionFolder(fn):
    for k, v in REQUIRES_EXTRACTION.iteritems():
        if fn.startswith(k):
            return v
    return None


def usesUnshiftedItemIDs(fn):
    for k in USES_UNSHIFTED_ITEM_IDS:
        if fn.startswith(k):
            return True
    return False

def fixNotEnoughModsName(name):
    return NEM_TO_MODID.get(name, name)