endfield-cards 1.0.5

A library for creating beautiful cards for Endfield.

Endfield Cards

A powerful Python library for generating beautiful character and profile cards for Endfield. This library provides an easy-to-use interface to create stunning visual cards with character stats, weapons, relics, and profile information.

Features

Beautiful Card Templates - Multiple professional templates for character showcase and profile cards

Complete Character Information - Display stats, skills, weapons, relics, and more

Profile Cards - Generate comprehensive profile cards with operator showcase

Async Support - Full async/await support for efficient operations

Caching - Smart asset caching for improved performance

Easy Integration - Simple API for quick integration into your projects

Installation

From PyPI (Recommended)

pip install endfield-cards

From Source

git clone https://github.com/MR-LORD-REX/endfield-cards.git
cd endfield-cards
pip install -e .

Dependencies

This library depends on:

• endfield-py - Core Endfield game data client
• enka.network - Player data and asset provider

Quick Start

Basic Usage

import asyncio
from ef_cards import EFCard

async def main():
    uid = 4225399080  # Your Endfield UID
    token = "your_token_here"  # Required for live stats and factory cards
    
    # Using async context manager (recommended)
    async with EFCard() as ef_card:
        # Get a single character card
        char_card = await ef_card.get_character_card(uid, char_index=0)
        char_card.save("character_card.png")
        
        # Get all characters cards
        all_cards = await ef_card.get_all_characters_card(uid)
        
        # Get profile card with showcase
        profile = await ef_card.get_profile_card(uid)
        profile.card.save("profile_card.png")
        
        # Get live stats card (requires token)
        stats = await ef_card.get_live_stats_card(uid, token)
        if stats:
            stats.img.save("live_stats.png")
        
        # Get factory stats card (requires token)
        factory = await ef_card.get_factory_stats_card(uid, token)
        if factory:
            factory.save("factory_stats.png")

if __name__ == "__main__":
    asyncio.run(main())

Without Context Manager

import asyncio
from ef_cards import EFCard

async def main():
    ef_card = EFCard()
    try:
        char_card = await ef_card.get_character_card(4225399080, char_index=0)
        char_card.save("character_card.png")
    finally:
        await ef_card.close()  # Don't forget to close!

if __name__ == "__main__":
    asyncio.run(main())

Available Methods

Character Card

# Get a single character card
card = await ef_card.get_character_card(
    uid: int,
    char_index: int = 0,
    user_img: Image.Image | None = None,
    template: int = 1
) -> Image.Image

All Characters Cards

# Get cards for all characters in a profile
cards = await ef_card.get_all_characters_card(
    uid: int,
    user_imgs: list[Image.Image] | None = None,
    template: int = 1
) -> list[Image.Image]

Profile Card

# Get a complete profile card with showcase
profile = await ef_card.get_profile_card(
    uid: int,
    template: int = 1
) -> ProfileCard_1

Live Stats Card

# Get live stats card (requires valid token)
stats = await ef_card.get_live_stats_card(
    uid: int,
    token: str,
    server: int = 3
) -> LiveStats | None

Factory Stats Card

# Get factory stats card with settlement details (requires valid token)
factory = await ef_card.get_factory_stats_card(
    uid: int,
    token: str,
    server: int = 3
) -> Image.Image | None

Card Information

Character Card Template 1 (1920x800)

Displays comprehensive character information including:

• Main Frame - Character artwork and basic stats
• Weapon Panel - Current weapon with stats
• Relic Panel - Equipped relics and bonuses
• Skill Panel - Character skills and cooldowns
• Stats Panel - Detailed character statistics

Profile Card Template 1 (1080x1467)

Includes:

• Player Profile - UID, Authority Level, Exploration Level
• Awakening Day - Days since account creation
• Operator Showcase - 4 featured characters
• Statistics - Total operators, weapons, and files collected
• Regional Development - Development levels by region

Live Stats Card (1024x355)

Real-time player statistics card (requires valid authentication token):

• Sanity Points - Current and maximum sanity
• Recovery Timer - Time until full sanity recovery
• Daily Points - Daily mission completion progress
• Weekly Points - Weekly mission score
• Battle Pass - Current battle pass level

Factory Stats Card (1156x1755)

Comprehensive factory and settlement information card (requires valid authentication token):

• Factory Overview - Main factory level and money status
• Settlement Details - Per-settlement information including:
  • Settlement name and level
  • Assigned officer/character
  • Money storage status
• Regional Breakdown - Statistics for each region
• Resource Management - Visual progress bars for resources

Example Output

Character Card

Profile Card

Live stats card

Factory card

Data Sources

• Game Data: endfield-py - Endfield game data wrapper developed by me
• Assets & Player Data: enka.network - Community-driven asset and player data provider

Configuration

Debug Mode

Enable debug logging to troubleshoot issues:

async with EFCard(debug=True) as ef_card:
    # Your code here
    pass

Custom Endfield Client

Use your own Endfield client instance:

from endfield import Endfield

ef = Endfield()
async with EFCard(ef=ef) as ef_card:
    # Your code here
    pass

How to get Token

• Check the endfield-py documentation for instructions on obtaining a valid token for accessing player data.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.

Disclaimer

This project is not affiliated with or endorsed by the developers of Endfield. All assets and game data are sourced from public APIs and are used for educational purposes only.

Acknowledgments

• endfield-py - Library developed by me for accessing Endfield game data
• enka.network - For providing player data and asset caching

Support

If you encounter any issues or have questions:

1. Check the examples directory for usage patterns
2. Enable debug mode to see detailed logs
3. Open an issue on GitHub
4. Contact me on Telegram

Related Projects

• endfield-py - Core Endfield game data client

---

Note: Make sure you have a valid Endfield UID to use this library. You can find your UID in-game .