Skip to content

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

MediEvilRecomp Mod Hub

Community hub for MediEvilRecomp. mods, asset packs ,and shaders listed here can be browsed and installed from inside the game

This repository does not host mods itself, the mods are a file that points to the specific git repo theyre in

This modhub can represent 3 types of modifications, mods (code mods), asset packs, and shaders

Entry format

the entry must be defined as follows:

type=mod
name=Some Example Mod
description=One or two sentences about what it does.
repository=https://github.com/SomeFakeGitHubUser/SomeExampleMod.git
commit=CommitHashGoesHere
authors=SomeExampleUserGoesHere
tags=qol, camera
Key Required Meaning
type yes mod, assetpack or shader
name yes Display name
description yes Short description
repository yes the git repository for the mod
commit yes commit hash for the version
authors yes Everyone who made it, separated by commas
path no Folder inside the repository to install, when it is not the root
icon no Path to the icon inside the repository, when it is not one of the default name.
tags no Keywords that define this mod, separated by commas.
warning no Shown on the card and before installing, This is Required if it talks to the internet, collects anything, or does anything out of the player control

Submitting

  1. Fork this repository.
  2. Add mods/<your-id> with the format that is described above, pointing at the commit you want people to get
  3. Open a pull request, if possible use the template provided.
  4. A maintainer will review the source at that commit and, if everything is ok, it will merged

To update, open a pull request again changing the necessary information, this will be reviewed again for safery

To remove your entry, open a pull request that deletes the file, or open an issue and we will remove it

Guidelines

Entries that break these rules are not merged, and existing ones will get remoevd.

  • No fully AI generated content. Code, art, textures, audio, music, or text that was entirely generated by AI will not be accepted
  • No copyrighted material Do not distribute code that is copyrighted if you do not have the rights to distribute it.
  • Credit and permission. List every author, if you build on other's work, its license has to allow it and they have to be properly credited
  • Source available and readable. Everything that is run HAS to be in the linked repository, code should not be obfuscated and the mod should not download runable code from the internet
  • No malicious behavior. No malware(duh), no data collection, no telemetry, no tampering with files outside the game folder, no messing with other mods(except for mods where this is explicitely allowed). Anything that uses the network or anything outside player control must be stated in warning.
  • Respectful content. No hateful, sexual or harassing content, and no impersonation of other authors or of BlackLabelHQ.
  • One entry per thing. Don't submit the same content under several ids, and don't use names that mislead people about what it is or who made it.
  • Keep it working. Entries that stay broken on the current release for a long time may be removed until fixed.

We reserve the final word on what goes into the hub, installing anything from the hub is at your own risk the entries are reviewed, but that is not a guarantee

If you do not agree with these guidelines you are free to host your mod in other plataforms such as gamebanana or thunderstore


For developers

The hub is part of the RecompOne runtime, so any recompiled game made with RecompOne can use it, the game points it at its hub repository by using:

RecompOne.Runtime.Hub.ModHub.Configure("BlackLabelHQ/MediEvilRecompModHub");

Types decide where things are installed. mod, assetpack and shader are registered by default, and anything unknown goes to mods/. but a game can add its own types, for example a custom translation pack:

ModHub.RegisterType(new HubType("translation", "modhub.type.translation",
    () => Path.GetFullPath("translations"),
    () => ReloadTextures()));

(it can override it from the other types too)

The third argument is the destination folder, the last one runs after an install update or removal

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors