Перейти к содержимому
Mineforgian

Profile API

Library adding a player profile UI; features right-click interactions, developer API, and full command support.

89 загрузок0 подписчиковLGPL-3.0-onlyforge

Обновлён 10 марта 2026 г. · опубликован 9 марта 2026 г.

Скачать 1.0.4(30 КБ)
Profile API Banner

Modrinth Downloads CurseForge Downloads GitHub Issues GitHub Stars Discord License

A highly customizable Profile UI library for Minecraft.

🌟 Overview

Profile API is more than just a stats viewer—it's a polished, modular UI framework for Minecraft. By right-clicking any player, you gain access to a beautifully structured profile screen showing real-time character models, equipment, and dynamic data from across the modding ecosystem.

✨ Key Features

  • 👤 Real-time 3D Preview: See players in their full glory with high-resolution, centered 3D model rendering.
  • 🛡️ Interactive Equipment: View equipped armor slots with hoverable tooltips showing names, enchantments, and stats.
  • 📊 Structured Data: Information is organized into clean, row-based layouts with subtle highlights.
  • 🎨 Premium Visuals:
    • Fancy Panels: Framed UI elements for a professional, "embedded" feel.
    • Conditional Coloring: Health is Red, Experience is Green, and Titles match Team colors.
    • Dynamic Icons: Automatic icons for Health, Hunger, and XP (with custom Icon support for developers).
  • ⚙️ Ultra Configurable: Toggle almost every visual element—from the 3D model to the "Fancy" panel styling.
  • 🧩 Modular API: Developers can register custom "Profile Components" in seconds.

🛠️ For Developers

Adding to your project (Gradle)

repositories {
    maven {
        name = "GitHubPackages"
        url = uri("https://maven.pkg.github.com/yigit-guven/Profile-API")
    }
}

dependencies {
    implementation "net.yigitguven.profile:profile:VERSION"
}

Registering a Component

ProfileRegistry.register(player -> new ProfileComponent() {
    @Override
    public ResourceLocation getId() { 
        return new ResourceLocation("yourmod", "example_stat"); 
    }

    @Override
    public Component getTitle() { 
        return Component.literal("Strength"); 
    }

    @Override
    public Component getValue() { 
        // Can be dynamic colored text
        return Component.literal("Lv. 99").withStyle(ChatFormatting.GOLD); 
    }
    
    @Override
    public ResourceLocation getIcon() {
        return new ResourceLocation("yourmod", "textures/gui/strength_icon.png");
    }
});

📦 How 2 Play?

Installation

  1. Download the latest version from Modrinth or CurseForge.
  2. Drop the .jar file into your Minecraft mods folder.
  3. Ensure you have the correct version of Mod Loader installed.

Controls

  • Right-Click any player to view their profile.
  • Command: /profile view <player> (supports self-view and others).

License & Usage

Modpacks

You are absolutely free to include Profile API in any modpack! No explicit permission is required, though a link back to this page is always appreciated.

Developing with Profile API

We encourage other developers to use Profile API as a dependency! Since it is licensed under LGPL 3.0, you can build mods that depend on this library without having to license your own mod under LGPL, as long as you don't modify the Profile API source code itself.

🔗 Project Links

❤️ Support the Project

If you find this library useful, please consider:

  • ⭐ Starring the repository!
  • 👤 Following me on GitHub, Modrinth, and CurseForge.
  • 🛠️ Building Mods: Create new mods that depend on Profile API to grow the ecosystem.
  • 🚀 Server Hosting: Use our link to buy a server via BisectHosting with 25% OFF using our link: Get 25% Off Here!
Made with ❤️ by Yigit Guven

Центр версий

5 версий
Бета1.0.41.20.1 · 30 КБ
  • Бета30 КБ
  • Бета28 КБ
  • Бета25 КБ
  • Бета19 КБ
  • Бета15 КБ

Ченджлог

1.0.4Бета1.20.1 · 10 марта 2026 г.
  • UI Refinements:
    • Repositioned player model higher and slightly right to align with armor slots.
    • Repositioned "Appearance" header for better framing.
    • Vertically centered skin head icon with the profile title.
  • Dynamic Colored Stats:
    • Health values now appear in Red.
    • Experience values now appear in Green.
  • Interactive Armor Slots:
    • Added hoverable tooltips for armor items (configurable via enableArmorTooltips).
  • Profile Title Color: Title now matches the player's team or name color from the Tab list.
  • Fixed Icons: Updated Experience icon to use the correct XP orb sprite.
  • Premium UI Polish: Introduced structured panels and framed areas for a more professional look.
  • Framed Player Model: Added a recessed, 3D-effect frame for the player character display.
  • Row-Based Data Layout: Stats are now organized into subtle, readable rows with better vertical spacing.
  • Enhanced Typography: Added color-coding for labels (Gold) and values (White), plus a highlighted title (Cyan).
  • Appearance Header: Added a dedicated sub-header for the player model area.
  • New Configuration: Added useFancyPanels and highlightColor for further customization.
  • Vanilla UI Style: New configurable option to use standard Minecraft GUI textures for the Profile Screen.
  • Player Skin Heads: Added 2D skin head rendering next to player names in the UI.
  • Dynamic Icons: Automatic heart, hunger, and XP icons for relevant profile data entries.
  • Enhanced Configuration: Added vanillaStyleUi, showSkinHead, and showIcons toggles.
  • Documentation: Updated README with full feature list and updated developer API examples.
  • Improved UI spacing and alignment for data entries.
  • Added null-safety checks for client-side player connection states.
  • Bumped version to 1.0.4.
  • Re-centered character model for better framing.

Full Changelog: https://github.com/yigit-guven/Profile-API/compare/1.0.3...1.0.4

1.0.3Бета1.20.1 · 10 марта 2026 г.
  • Profile UI Overhaul:
    • Added real-time rendering of the target player's character model.
    • Added display of the target player's equipped armor items (helmet, chestplate, leggings, boots).
    • Custom background rendering with configurable colors.
  • New Configuration Options:
    • showPlayerModel: Toggle visibility of the player character.
    • backgroundColor: Customize the UI background color (Hex).
    • textColor: Customize the data text color (Hex).
    • modelScale: Adjust the size of the rendered player model.
  • Networking: Updated network protocol to transmit player UUID, name, and armor data.
  • Fixed CurseForge project links and download badge in README.md.
  • Bumped version to 1.0.3.

Full Changelog: https://github.com/yigit-guven/Profile-API/compare/1.0.2...1.0.3

1.0.2Бета1.20.1 · 9 марта 2026 г.
  • Brand Identity: Created a sleek "Profile API" text banner logo for use in mod repositories and documentation.
  • mods.toml: Added issue tracker URL and display URL.
  • Version: Updated to 1.0.2
  • Documentation: Created a README.md with banners, badges, and project links.

Full Changelog: https://github.com/yigit-guven/Profile-API/compare/1.0.1...1.0.2

1.0.1Бета1.20.1 · 9 марта 2026 г.
  • Publishing Conflict: Bumped version to 1.0.1 to resolve 409 error on GitHub Packages.
  • Deprecation Warnings: Resolved remaining ResourceLocation warnings and cleaned up unused imports.
  • Solo Testing Support: Added /profile view <player> command for manual verification and self-testing.
  • Sample Components: Integrated "Health" and "Experience Level" components as reference implementations.

Full Changelog: https://github.com/yigit-guven/Profile-API/compare/1,0,0...1.0.1

1.0.0Бета1.20.1 · 9 марта 2026 г.
  • Core API Registry: Created ProfileRegistry and ProfileComponent for other mods to register custom profile data.
  • Networking Layer: Implemented S2CProfilePacket and ProfileNetwork to synchronize profile data from server to client.
  • Profile UI: Added ProfileScreen based on standard Minecraft demo background, capable of displaying dynamic profile components.
  • Interaction Logic: Added ModEvents to trigger profile opening when right-clicking another player.
  • Client Access: Added ClientAccess utility for safe client-side screen management.
  • Mod Identity: Renamed mod from examplemod to profile.
  • Display Name: Set official display name to Profile API.
  • Package Refactoring: Moved all classes from com.example.examplemod to net.yigitguven.profile.
  • Metadata Update: Updated gradle.properties and mods.toml with correct author (Yigit Guven), description, and mod ID.
  • Main Class: Renamed ExampleMod to ProfileMod and cleaned up template registry code.
  • Licensing: Changed project license to LGPL 3.0.
  • CI/CD Automation: Created a GitHub Actions workflow for automatic Maven publishing to GitHub Packages.
  • Publishing Fix: Resolved 422 error on GitHub Packages by standardizing project/artifact names and adding POM metadata.
  • Code Cleanup: Resolved deprecation warnings for FMLJavaModLoadingContext and ResourceLocation.

Full Changelog: https://github.com/yigit-guven/Profile-API/commits/1,0,0

Комментарии

Загружаем…