API Reference

This section contains the complete API reference for Simulchip.

• NetrunnerDB API Client
  • CardData
  • PackData
  • DecklistData
  • APIError
  • NetrunnerDBAPI
• Cache Module
  • CacheManager
• Collection Management
  • Manager
  • Operations
• Comparison Module
  • CardInfo
  • DecklistStats
  • ComparisonResult
  • DecklistComparisonError
  • DecklistComparer
• PDF Generation
  • ProxyPDFGenerator
• Utilities
  • FactionCode
  • extract_decklist_id()
  • get_faction_symbol()
  • format_card_count()
  • sanitize_filename()
  • get_faction_short_name()
  • parse_card_code()
  • format_deck_size()
  • get_faction_side()
  • CardInfo
  • DecklistStats
  • ComparisonResult
  • DecklistComparisonError
  • DecklistComparer
  • CacheManager
• CLI Utilities
  • resolve_collection_path()
  • ensure_collection_directory()
  • ensure_output_directory()
  • validate_collection_exists()
  • should_generate_proxies()
  • get_proxy_generation_message()
  • filter_valid_packs()
  • calculate_collection_stats()
  • validate_pack_selection()
  • get_navigation_page_size()
  • calculate_selection_bounds()
  • should_reset_selection_on_filter_change()
  • get_card_quantity_action()
  • should_ignore_pack_toggle_errors()
  • NavigationConfig
• Display Utilities
  • calculate_viewport_size()
  • calculate_viewport_window()
  • format_viewport_status()
  • get_completion_color()
• Filtering and Search
  • filter_packs()
  • filter_packs_raw()
  • filter_cards()
  • filter_cards_raw()
  • create_pack_filter()
  • create_card_filter()
  • filter_items_generic()
• Interactive Interface Management
  • KeyAction
  • InteractiveState
  • KeyMapper
  • process_navigation_action()
  • process_filter_action()
  • InteractiveController
• Data Models and Wrappers
  • FilterableItem
  • PackModel
  • CardModel
  • filter_items()
• Path Management
  • get_default_collection_path()
  • get_default_cache_dir()
  • get_deck_pdf_path()
  • create_identity_slug()
  • ensure_path_exists()
  • get_cache_subdirectory()
  • get_cache_locations()
  • reset_simulchip_data()
  • generate_default_output_path()
• Platform-Specific Utilities
  • is_interactive_terminal()
  • get_platform_name()
  • getch()
• Terminal Images Module
  • download_card_image()
  • render_card_image_terminal()
  • get_card_image_url()
  • display_card_preview()

Core Modules