Skip to content

Adds a credit screen for the installed mods in the style of the game credits, but with improved functionality and a custom poem

License

Notifications You must be signed in to change notification settings

moehreag/modcredits

Repository files navigation

Mod Credits screen

With custom poem!

This mod adds a screen in the style of the vanilla credits/win screen, but for the currently installed mods and with expanded functionality as well as a small custom poem.

Customization options (for mod devs)

Custom FMJ property (simple)

Example:

{
  /*...*/
  "custom": {
    "moehreag-modcredits:description": "Your custom text!"
  }
}

Note: This property does not support localization.

Example (using translation keys):

{
  /*...*/
  "custom": {
    "moehreag-modcredits:description-keys": "modid.modcredits.description"
  }
}

Note: For both options, the line length is limited to a width of 256 and will be wrapped.

Custom Entrypoint (more powerful, but also more manual work and likely to break with version updates)
{
  /*...*/
  entrypoints: {
    "moehreag-modcredits": [
      "com.example.modid.modcredits.ModCreditsImpl"
    ]
  },
  /*...*/
}
package com.example.modid.modcredits;

import io.github.moehreag.modcredits.ModCreditsApi;
import io.github.moehreag.modcredits.entries.Entry;

import net.fabricmc.loader.api.ModContainer;

public class ModCreditsImpl implements ModCreditsApi { 
	
	@Override 
	public Entry createEntry(ModContainer self, boolean rightText) {
		/* Your code! */
	}
}

Maven coordinates

This mod can be found on https://moehreag.duckdns.org/maven. Alternatively, the modrinth maven can be used.

build.gradle.kts
repositories {
    maven("https://moehreag.duckdns.org/maven/releases")
}

dependencies {
    
    modImplementation("io.github.moehreag:modcredits:$VERSION")
}

build.gradle
repositories {
    maven { url = "https://moehreag.duckdns.org/maven/releases" }
}

dependencies {
    
    modImplementation("io.github.moehreag:modcredits:$VERSION")
}


You want to use this mod in a modpack but it doesn't offer the correct options? Head to the issue tracker and let us know!

About

Adds a credit screen for the installed mods in the style of the game credits, but with improved functionality and a custom poem

Resources

License

Stars

Watchers

Forks

Languages