Skip to main content

A library for creating beautiful cards for Endfield.

Project description

Endfield Cards

PyPI version Python 3.10+ License

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

Bots

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:

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:
        # update assets on the first run or when new assets are available
        await ef_card.ef.update_assets()  
        await ef_card.update_builds()

        # 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")

        char_card=await ef_card.get_character_build('endministrator')
        char_card[0].show()
        
        all=await ef_card.available_builds()
        print(all)

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

Character Card Example

Profile Card

Profile Card Example

Live stats card

Stat card example

Factory card

Factory card example

Character Guild Card

Guild card example

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
  • Guides data: prydwen.gg - For character build information and guides

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

Contributing

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

License

This project is licensed under the GNU General Public License v3.0. 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
  • endfield-builds - Sister project for character build cards
  • 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


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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

endfield_cards-1.0.11.tar.gz (6.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

endfield_cards-1.0.11-py3-none-any.whl (6.5 MB view details)

Uploaded Python 3

File details

Details for the file endfield_cards-1.0.11.tar.gz.

File metadata

  • Download URL: endfield_cards-1.0.11.tar.gz
  • Upload date:
  • Size: 6.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.10

File hashes

Hashes for endfield_cards-1.0.11.tar.gz
Algorithm Hash digest
SHA256 ddf48d074baed28c724151c8db50af39a1bd05908fe976e989e8d88181cd1e22
MD5 649b627f66cbda376b8de380ac742e48
BLAKE2b-256 318367d8b635044a60b7057339ed455899a69d4763bdc8d54f0b87cfa7a8f9cb

See more details on using hashes here.

File details

Details for the file endfield_cards-1.0.11-py3-none-any.whl.

File metadata

File hashes

Hashes for endfield_cards-1.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 c21269418943cdce9246cb2c5afe8dd67088a37c8be49297a2274784e3cd8a89
MD5 e1b8653b1802d0248dc608b389e245b2
BLAKE2b-256 c69a643226501e486fe38706ebd2a3d0f8d585194b65861388c2f00be7a78580

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page