Skip to content

Getting Started with Icecap

This guide will help you get up and running with Icecap quickly.

Installation

Install Icecap from PyPI using pip:

pip install icecap

Basic Usage

Here's a minimal example to get you started with Icecap:

Finding players around you
from icecap.infrastructure import (
    get_memory_manager,
    GameDriver,
    PlayerRepository,
)
from icecap.infrastructure.process import get_game_process_manager

driver = GameDriver(get_game_process_manager(), get_memory_manager)
player_repository = PlayerRepository(driver)

for player in player_repository.yield_players():
    print(player)

Let's break down what's happening in this example:

  1. First, we create a GameDriver instance using the game process manager and memory manager getter.
  2. Next, we create a PlayerRepository, which provides access to player entities in the game.
  3. Finally, we iterate over all players in the game and print their details.

Next Steps

Once you're familiar with the basics, check out the Tutorials for more detailed examples or explore the API Reference for complete documentation of all available components and their purpose.