Rebootpy

https://github.com/xmistt/rebootpy
Admin
Rebootpy is an asynchronous Python library for interacting with Fortnite and EpicGames' API and XMPP...
Tokens:101,445
Snippets:690
Trust Score:8.9
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start client as an async context manager

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

Demonstrates using the start method as an async context manager to perform operations while the client is active.

```default
async with client.start() as future:
    user = await client.fetch_user('Ninja')
    print(user.display_name)

    await future  # Nothing after this line will run.
```

--------------------------------

### Default Party Member Configuration Example

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Example of setting default party member configurations using partials for actions like setting outfits and banners.

```python
from rebootpy import ClientPartyMember
from functools import partial

[
    partial(ClientPartyMember.set_outfit, 'CID_175_Athena_Commando_M_Celestial'),
    partial(ClientPartyMember.set_banner, icon="OtherBanner28", season_level=100)
]
```

--------------------------------

### Start Multiple Clients

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Starts multiple clients concurrently as a coroutine.

```APIDOC
## async rebootpy.start_multiple(clients, gap_timeout=0.2, shutdown_on_error=True, ready_callback=None, error_callback=None, all_ready_callback=None, before_start=None, before_close=None)

### Description
This function is a coroutine. Starts multiple clients at the same time.

### Method
POST

### Endpoint
/api/clients/start_multiple

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **clients** (List[BasicClient]) - Required - A list of the clients you wish to start.
- **gap_timeout** (float) - Optional - The time to sleep between starting clients. Defaults to `0.2`.
- **shutdown_on_error** (bool) - Optional - If the function should cancel all other start tasks if one of the tasks fails. Defaults to `True`.
- **ready_callback** (Optional[Union[Callable[[BasicClient], Awaitable[BasicClient]]]]) - Optional - A callable/async callback taking a single parameter `client`. The callback is called whenever a client is ready.
- **error_callback** (Optional[Union[Callable[[BasicClient, Exception], Awaitable[BasicClient, Exception]]]]) - Optional - A callable/async callback taking two parameters, `BasicClient` and an exception. The callback is called whenever a client fails logging in. The callback is not called if `shutdown_on_error` is `True`.
- **all_ready_callback** (Optional[Union[Callable, Awaitable]]) - Optional - A callback/async callback that is called whenever all clients have finished logging in, regardless if one of the clients failed logging in.
- **before_start** (Optional[Awaitable]) - Optional - An async callback that is called when just before the clients are beginning to start.
- **before_close** (Optional[Awaitable]) - Optional - An async callback that is called when the clients are beginning to close.

### Request Example
```json
{
  "clients": [
    {
      "username": "user1",
      "password": "pass1"
    },
    {
      "username": "user2",
      "password": "pass2"
    }
  ],
  "gap_timeout": 0.5,
  "shutdown_on_error": false
}
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Install rebootpy on Windows

Source: https://github.com/xmistt/rebootpy/blob/main/docs/intro.md

Use the Python launcher to install the package on Windows systems.

```sh
py -3 -m pip install rebootpy
```

--------------------------------

### Install rebootpy on Windows

Source: https://github.com/xmistt/rebootpy/blob/main/README.md

Use this command to install the rebootpy library on Windows.

```bash
py -3 -m pip install -U rebootpy
```

--------------------------------

### Install rebootpy on Linux

Source: https://github.com/xmistt/rebootpy/blob/main/README.md

Use this command to install the rebootpy library on Linux.

```bash
python3 -m pip install -U rebootpy
```

--------------------------------

### Example Party Playlist Info Output

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Shows example output for the playlist_info property, illustrating different formats for default duos and in-game ESL capture the flag.

```default
# output for default duos
(
    'Playlist_DefaultDuo',
    '',
)

# output for esl capture the flag (when player is in-game)
(
    '0363-4024-8917',
    '820665c477184929aa5d0e1f56902cfd'
)
```

--------------------------------

### Command Input Parsing Examples

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/commands.md

Demonstrates how keyword-only arguments are parsed with and without quotes.

```default
$test hello world
```

```default
hello world
```

```default
$test "hello world"
```

```default
"hello world"
```

--------------------------------

### SocialBanPublicService Route Example

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Example of how to define and use a custom route for the SocialBanPublicService.

```APIDOC
## POST /socialban/api/public/v1/{user_id}

### Description
This endpoint is used to interact with the Social Ban Public Service, likely for retrieving ban or warning information for a specific user.

### Method
GET

### Endpoint
https://social-ban-public-service-prod.ol.epicgames.com/socialban/api/public/v1/{user_id}

### Parameters
#### Path Parameters
- **user_id** (string) - Required - The ID of the user to retrieve ban information for.

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for this GET request."
}
```

### Response
#### Success Response (200)
- **bans** (array) - A list of ban objects associated with the user.
- **warnings** (array) - A list of warning objects associated with the user.

#### Response Example
```json
{
    "bans" : [],
    "warnings" : []
}
```
```

--------------------------------

### Client Lifecycle Methods

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

Methods for starting the client and managing the event loop.

```APIDOC
## run()

### Description
Starts the loop and calls start(). This function is blocking and should be the last function to run.

### Parameters
- None

### Errors
- AuthException: Raised if invalid credentials are provided.
- HTTPException: A request error occurred while logging in.

## start(dispatch_ready=True)

### Description
Starts the client and logs into the specified user. Can be used as a coroutine or an async context manager.
```

--------------------------------

### Client Lifecycle Methods

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Methods for starting the client, waiting for readiness, and handling closure.

```APIDOC
## start(dispatch_ready=True)

### Description
Starts the client and logs into the specified user. This method can be used as a coroutine or an async context manager.

### Parameters
- **dispatch_ready** (bool) - Optional - Whether or not the client should dispatch the ready event when ready.

### Raises
- **AuthException** - Raised if invalid credentials are passed or other failures occur.
- **HTTPException** - A request error occurred while logging in.

## wait_until_ready()

### Description
Waits until the internal state of the client is ready.

## wait_until_closed()

### Description
Waits until the client is fully closed.
```

--------------------------------

### DefaultPartyConfig Meta Coroutines Example

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Example of using functools.partial to define meta coroutines for a party. These coroutines are automatically applied when a new party is created by the client.

```python
from rebootpy import ClientParty
from functools import partial

[
    partial(ClientParty.set_custom_key, 'myawesomekey'),
    partial(ClientParty.set_playlist, 'Playlist_PlaygroundV2')
]
```

--------------------------------

### rebootpy.event_before_start

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Triggered before the client starts.

```APIDOC
## event_before_start()

### Description
This event is called and waited for before the client starts.

### Warning
This event is not called when the client starts in Client.restart().

### Note
The client will wait until the event handlers for this event is finished processing before actually closing. This event is not compatible with Client.wait_for().
```

--------------------------------

### Extension Setup and Teardown

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/extensions.md

Implement `extension_setup` for loading and `cog_teardown` for unloading an extension. These functions are called when the extension is loaded or unloaded, respectively.

```python
def extension_setup(bot):
    print('I am being loaded!')
```

```python
def cog_teardown(bot):
    print('I am being unloaded!')
```

--------------------------------

### Start Multiple Clients

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Starts multiple clients concurrently. This function is blocking and should be the last function to run. It includes options for managing timeouts, error handling, and callbacks for client readiness and errors.

```APIDOC
## async rebootpy.start_multiple(clients, gap_timeout=0.2, shutdown_on_error=False, ready_callback=None, error_callback=None, all_ready_callback=None, before_start=None, before_close=None)

### Description
Starts multiple clients concurrently. This function is blocking and should be the last function to run.

### Method
ASYNC FUNCTION

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **clients** (List[`BasicClient`]) – A list of the clients you wish to start.
- **gap_timeout** (float) – The time to sleep between starting clients. Defaults to `0.2`.
- **shutdown_on_error** (bool) – If the function should cancel all other start tasks if one of the tasks fails. You can catch the error by try excepting.
- **ready_callback** (Optional[Union[Callable[[`BasicClient`], Awaitable[`BasicClient`]]]]) – A callable/async callback taking a single parameter `client`. The callback is called whenever a client is ready.
- **error_callback** (Optional[Union[Callable[[`BasicClient`, Exception], Awaitable[`BasicClient`, Exception]]]]) – A callable/async callback taking two parameters, `BasicClient` and an exception. The callback is called whenever a client fails logging in. The callback is not called if `shutdown_on_error` is `True`.
- **all_ready_callback** (Optional[Union[Callable, Awaitable]]) – A callback/async callback that is called whenever all clients have finished logging in, regardless if one of the clients failed logging in. That means that the callback is always called when all clients are either logged in or raised an error.
- **before_start** (Optional[Awaitable]) – An async callback that is called when just before the clients are beginning to start. This must be a coroutine as all the clients wait to start until this callback is finished processing so you can do heavy start stuff like opening database connections, sessions etc.
- **before_close** (Optional[Awaitable]) – An async callback that is called when the clients are beginning to close. This must be a coroutine as all the clients wait to close until this callback is finished processing so you can do heavy close stuff like closing database connections, sessions etc.

### Request Example
```json
{
  "clients": [
    {
      "client_id": "client1",
      "auth_token": "token1"
    },
    {
      "client_id": "client2",
      "auth_token": "token2"
    }
  ],
  "gap_timeout": 0.5
}
```

### Response
#### Success Response (200)
None

#### Response Example
None

### Raises
- **AuthException** – Raised if invalid credentials in any form was passed or some other misc failure.
- **ValueError** – Two or more clients with the same authentication identifier was passed. This means that you attemted to start two or more clients with the same credentials.
- **HTTPException** – A request error occurred while logging in.
```

--------------------------------

### Async Context Manager Usage of BasicClient.start()

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Demonstrates how to use the `start()` method of `BasicClient` as an asynchronous context manager to fetch user data. The client is automatically managed within the `async with` block.

```python
async with client.start():
  user = await client.fetch_user(‘Ninja’)
  print(user.display_name)
```

--------------------------------

### Configure Enlightenment Loadout

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Example of the enlightenment parameter format for set_outfit, representing Chapter 2 season and level.

```default
# First value is the season in Fortnite Chapter 2
# Second value is the level for the season
(1, 300)
```

--------------------------------

### Implement a basic rebootpy client

Source: https://github.com/xmistt/rebootpy/blob/main/docs/intro.md

A complete example showing how to subclass rebootpy.Client, handle authentication with AdvancedAuth, and manage events like friend requests and messages.

```python3
import rebootpy
import json
import os

filename = 'device_auths.json'


class MyClient(rebootpy.Client):
    def __init__(self):
        device_auth_details = self.get_device_auth_details()
        # this auth instance will login via device auth if its present but if its
        # not, it'll open device code in the browser for you to input email & pass
        super().__init__(
            auth=rebootpy.AdvancedAuth(
                prompt_device_code=True,
                **device_auth_details
            )
        )

    def get_device_auth_details(self):
        if os.path.isfile(filename):
            with open(filename, 'r') as fp:
                return json.load(fp)
        return {}

    def store_device_auth_details(self, details):
        with open(filename, 'w') as fp:
            json.dump(details, fp)

    async def event_device_auth_generate(self, details):
        self.store_device_auth_details(details)

    async def event_ready(self):
        print(f'Client ready as {self.user.display_name}')

    async def event_friend_request(self, request):
        await request.accept()

    async def event_friend_message(self, message):
        print(f'{message.author.display_name}: {message.content}')
        await message.reply('Thanks for your message!')


bot = MyClient()
bot.run()
```

--------------------------------

### Basic rebootpy Bot Usage

Source: https://github.com/xmistt/rebootpy/blob/main/README.md

A simple example demonstrating how to set up a rebootpy bot, including ready event, friend request handling, and a basic command. Ensure you have the necessary authorization method configured.

```python
import rebootpy

from rebootpy.ext import commands

bot = commands.Bot(
    command_prefix='!',
    auth=rebootpy.AuthorizationCodeAuth()
)

@bot.event
async def event_ready():
    print(f'Bot ready as {bot.user.display_name} ({bot.user.id})')

@bot.event
async def event_friend_request(request):
    await request.accept()

@bot.command()
async def hello(ctx):
    await ctx.send('Hello!')

bot.run()
```

--------------------------------

### Run Multiple Clients

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Sets up an event loop and starts multiple clients concurrently. This function is blocking and should be the last one called.

```APIDOC
## rebootpy.run_multiple(clients, gap_timeout=0.2, shutdown_on_error=True, ready_callback=None, error_callback=None, all_ready_callback=None, before_start=None, before_close=None)

### Description
This function sets up a loop and then calls `start_multiple()` for you. If you already have a running event loop, you should start the clients with `start_multiple()`. On shutdown, all clients will be closed gracefully.

#### WARNING
This function is blocking and should be the last function to run.

### Method
POST

### Endpoint
/api/clients/run_multiple

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **clients** (List[BasicClient]) - Required - A list of the clients you wish to start.
- **gap_timeout** (float) - Optional - The time to sleep between starting clients. Defaults to `0.2`.
- **shutdown_on_error** (bool) - Optional - If the function should cancel all other start tasks if one of the tasks fails. Defaults to `True`.
- **ready_callback** (Optional[Union[Callable[[BasicClient], Awaitable[BasicClient]]]]) - Optional - A callable/async callback taking a single parameter `client`. The callback is called whenever a client is ready.
- **error_callback** (Optional[Union[Callable[[BasicClient, Exception], Awaitable[BasicClient, Exception]]]]) - Optional - A callable/async callback taking two parameters, `BasicClient` and an exception. The callback is called whenever a client fails logging in. The callback is not called if `shutdown_on_error` is `True`.
- **all_ready_callback** (Optional[Union[Callable, Awaitable]]) - Optional - A callback/async callback that is called whenever all clients have finished logging in, regardless if one of the clients failed logging in.
- **before_start** (Optional[Awaitable]) - Optional - An async callback that is called when just before the clients are beginning to start.
- **before_close** (Optional[Awaitable]) - Optional - An async callback that is called when the clients are beginning to close.

### Request Example
```json
{
  "clients": [
    {
      "username": "user1",
      "password": "pass1"
    },
    {
      "username": "user2",
      "password": "pass2"
    }
  ],
  "gap_timeout": 0.5,
  "shutdown_on_error": false
}
```

### Response
#### Success Response (200)
None

#### Response Example
None

### Raises:
- AuthException: Raised if invalid credentials in any form was passed or some other misc failure.
- HTTPException: A request error occurred while logging in.
```

--------------------------------

### Leaderboard Entry Format

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

Example structure of a dictionary returned by the leaderboard fetcher.

```json
{
    'account': '4480a7397f824fe4b407077fb9397fbb',
    'value': 5082
}
```

--------------------------------

### Fetch Ranked Stats Example

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Demonstrates how to retrieve ranked statistics for a specific user and season using the fetch_ranked_stats coroutine.

```python
# get my C5S3 ranked stats
async def get_6v_ranked_stats():
    print(f'Fetching ranked stats for C5S3')

    user = await bot.fetch_user('6v.')
    ranks = await bot.fetch_ranked_stats(
        user_id=user.id,
        season=rebootpy.Season.C5S3
    )

    for rank in ranks:
        print(f'{rank.ranking_type.name} - {rank.current_division.name}')

# Example output:
# Fetching ranked stats for C5S3
# BATTLE_ROYALE - DIAMOND_2
# ROCKET_RACING - UNRANKED
# ZERO_BUILD - UNREAL
```

--------------------------------

### Configure Soccer Skin Variants

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Example of setting a soccer skin outfit with a specific jersey color and number using the create_variant method.

```python
# the jersey number set to 99 (max number).
async def set_soccer_skin():
    me = client.party.me

    variants = me.create_variant(
        pattern=0,
        numeric=99,
        jersey_color='Norway'
    )

    await me.set_outfit(
        asset='CID_149_Athena_Commando_F_SoccerGirlB',
        variants=variants
    )
```

```python
# set the outfit to soccer skin with Norwegian jersey and
# the jersey number set to 99 (max number).
async def set_soccer_skin():
    me = client.party.me

    variants = me.create_variant(
        pattern=0,
        numeric=99,
        jersey_color='Norway'
    )

    await me.set_outfit(
        asset='CID_149_Athena_Commando_F_SoccerGirlB',
        variants=variants
    )
```

--------------------------------

### Load an Extension

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/extensions.md

Use `commands.Bot.load_extension()` to load an extension. The extension path is dot-qualified, similar to Python's import mechanism. For example, to load `plugins/hello.py`, use `'plugins.hello'`.

```python
bot.load_extension('hello')
```

--------------------------------

### ExtensionFailed Exception

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

Raised when an extension fails to load during module execution or setup.

```APIDOC
## Exception: rebootpy.ext.commands.ExtensionFailed

### Description
An exception raised when an extension failed to load during execution of the module or `extension_setup` entry point. Inherits from `ExtensionError`.

### Attributes
- **name** (str) - The extension that had the error.
- **original** (Exception) - The original exception that was raised. Accessible via the `__cause__` attribute.
```

--------------------------------

### Set Emote with Hardcoded Path

Source: https://github.com/xmistt/rebootpy/blob/main/docs/faq.md

Example of setting a dance emote using a direct path string.

```default
await bot.party.me.set_emote('/Game/Athena/Items/Cosmetics/Dances/EID_Coronet.EID_Coronet')
```

--------------------------------

### Define Variant Configuration Overrides

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Example dictionary structure for overriding default variant backend names.

```python
# NOTE: Keys refer to the kwarg name.
# NOTE: Values must include exactly one empty format bracket.
{
    'particle': 'Mat{}'
}
```

--------------------------------

### Create StatsV2 Request List

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Example of constructing a list of stat requests using StatsV2.create_stat for use in stats retrieval functions.

```default
[
    rebootpy.StatsV2.create_stat('placetop1', rebootpy.V2Input.KEYBOARDANDMOUSE, 'defaultsolo'),
    rebootpy.StatsV2.create_stat('kills', rebootpy.V2Input.KEYBOARDANDMOUSE, 'defaultsolo'),
    rebootpy.StatsV2.create_stat('matchesplayed', rebootpy.V2Input.KEYBOARDANDMOUSE, 'defaultsolo')
]
```

--------------------------------

### Fetch Ranked Stats Example

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

Retrieves competitive ranked statistics for a user in a specific season. Requires an active bot instance and a valid user ID.

```python
# get my C5S3 ranked stats
async def get_6v_ranked_stats():
    print(f'Fetching ranked stats for C5S3')

    user = await bot.fetch_user('6v.')
    ranks = await bot.fetch_ranked_stats(
        user_id=user.id,
        season=rebootpy.Season.C5S3
    )

    for rank in ranks:
        print(f'{rank.ranking_type.name} - {rank.current_division.name}')
```

--------------------------------

### Get 6v's Zero Build Squad Win Percentage

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Calculates and returns the win percentage for a specific user in a 'zero build squads' game mode using keyboard and mouse input. Requires the user's ID and their stats data.

```python
async def get_6v_zb_squad_winpercentage():
    user = await client.fetch_user('6v.')
    stats = await client.fetch_br_stats(user.id)

    return stats.get_winpercentage(stats.get_stats()['keyboardmouse']['nobuildbr_squad'])
```

--------------------------------

### Fetch Fortnite Item Shop Data

Source: https://context7.com/xmistt/rebootpy/llms.txt

Retrieve the current item shop data using the RebootPy client. This example iterates through items and prints their names and prices, also extracting character IDs from grants.

```python
import rebootpy

client = rebootpy.Client(auth=rebootpy.AdvancedAuth(prompt_device_code=True))

@client.event
async def event_ready():
    store = await client.fetch_item_shop()

    print('Current Item Shop:')
    for item in store.items:
        print(f'  {item.display_name} - {item.price} V-Bucks')

        # Get character IDs from grants
        for grant in item.grants:
            if grant['type'] == 'AthenaCharacter':
                print(f'    CID: {grant["asset"]}')

client.run()
```

--------------------------------

### Create a Simple Extension

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/extensions.md

Define an extension with a command and an `extension_setup` function to add it to the bot. Ensure the `extension_setup` function is a plain Python function, not a coroutine.

```python
from rebootpy.ext import commands

@commands.command()
async def hello(ctx):
    await ctx.send('Hello {0.display_name}.'.format(ctx.author))

def extension_setup(bot):
    bot.add_command(hello)
```

--------------------------------

### Configure Party and Handle Events

Source: https://context7.com/xmistt/rebootpy/llms.txt

Initializes a client with default party settings and registers event listeners for member actions and messages.

```python
import rebootpy
import functools

client = rebootpy.Client(
    auth=rebootpy.AdvancedAuth(prompt_device_code=True),
    default_party_config=rebootpy.DefaultPartyConfig(
        privacy=rebootpy.PartyPrivacy.FRIENDS,
        max_size=16
    ),
    default_party_member_config=rebootpy.DefaultPartyMemberConfig(
        meta=(
            functools.partial(rebootpy.ClientPartyMember.set_outfit, 'CID_175_Athena_Commando_M_Celestial'),
        )
    )
)

@client.event
async def event_party_member_join(member):
    print(f'{member.display_name} joined the party')
    await client.party.send(f'Welcome {member.display_name}!')

@client.event
async def event_party_member_leave(member):
    print(f'{member.display_name} left the party')

@client.event
async def event_party_invite(invite):
    print(f'Party invite from {invite.sender.display_name}')
    await invite.accept()

@client.event
async def event_party_message(message):
    print(f'[Party] {message.author.display_name}: {message.content}')

client.run()
```

--------------------------------

### Class: rebootpy.Client

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Configuration parameters for initializing the Fortnite client.

```APIDOC
## Class: rebootpy.Client

### Description
Represents the client connected to Fortnite and EpicGames’ services.

### Parameters
- **auth** (Auth) - Required - The authentication method to use.
- **http_connector** (aiohttp.BaseConnector) - Optional - The connector to use for http connection pooling.
- **ws_connector** (aiohttp.BaseConnector) - Optional - The connector to use for websocket connection pooling.
- **status** (str) - Optional - The status you want the client to send with its presence to friends. Defaults to {current_playlist}.
- **away** (AwayStatus) - Optional - The away status the client should use. Defaults to AwayStatus.ONLINE.
- **platform** (Platform) - Optional - The platform source. Defaults to Platform.WINDOWS.
- **net_cl** (str) - Optional - The current net cl used by the current Fortnite build.
- **party_version** (int) - Optional - The party version the client should use. Defaults to 3.
- **default_party_config** (DefaultPartyConfig) - Optional - Configuration used when creating parties.
- **default_party_member_config** (DefaultPartyMemberConfig) - Optional - Member configuration used when creating parties.
- **http_retry_config** (HTTPRetryConfig) - Optional - The config to use for http retries.
- **build** (str) - Optional - The build used by Fortnite.
- **os** (str) - Optional - The os version string to use in the user agent.
- **service_host** (str) - Optional - The host used by Fortnite’s XMPP services.
- **service_domain** (str) - Optional - The domain used by Fortnite’s XMPP services.
- **service_port** (int) - Optional - The port used by Fortnite’s XMPP services.
- **cache_users** (bool) - Optional - Whether or not the library should cache User objects. Defaults to True.
- **kill_other_sessions** (bool) - Optional - Whether or not the library should kill all other existing session/tokens. Defaults to True.
- **fetch_user_data_in_events** (bool) - Optional - Whether or not user data should be fetched in event processing. Defaults to True.
- **wait_for_member_meta_in_events** (bool) - Optional - Whether or not the client should wait for party member meta before dispatching events. Defaults to True.
- **leave_party_at_shutdown** (bool) - Optional - Whether or not the client should leave its current party at shutdown.
```

--------------------------------

### BasicClient Initialization and Lifecycle

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Methods for initializing the BasicClient, registering HTTP connectors, and managing the client lifecycle.

```APIDOC
## BasicClient Initialization

### Description
Initializes a new instance of the BasicClient for simple Fortnite API requests.

### Parameters
- **auth** (Auth) - Required - The authentication method to use.
- **http_connector** (aiohttp.BaseConnector) - Optional - The connector for http connection pooling.
- **http_retry_config** (HTTPRetryConfig) - Optional - Configuration for http retries.
- **build** (str) - Optional - The Fortnite build version.
- **os** (str) - Optional - The OS version string for the user agent.
- **cache_users** (bool) - Optional - Whether to cache User objects (default: True).
- **kill_other_sessions** (bool) - Optional - Whether to kill existing sessions (default: True).

## register_connectors

### Description
Registers an HTTP connector after client initialization. Must be called before start().

### Parameters
- **http_connector** (aiohttp.BaseConnector) - Required - The connector to use for the http session.

## start

### Description
Starts the client and logs into the specified user. Can be used as a coroutine or an async context manager.

### Parameters
- **dispatch_ready** (bool) - Optional - Whether to dispatch the ready event (default: True).

### Errors
- **AuthException** - Raised if credentials are invalid.
- **HTTPException** - Raised if a request error occurs during login.
```

--------------------------------

### fetch_event_tokens

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

Gets event tokens for the specified user.

```APIDOC
## fetch_event_tokens(user_id)

### Description
Gets event tokens for the specified user.

### Parameters
- **user_id** (str) - Required - The id of the user you want to fetch event tokens for.

### Response
- **Returns** (list[str]) - A list of event tokens.
```

--------------------------------

### async fetch_multiple_event_tokens

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

Gets event tokens for the specified users.

```APIDOC
## fetch_multiple_event_tokens

### Description
Gets event tokens for the specified users.

### Parameters
- **user_ids** (list) - Required - A list of user ids you want to fetch event tokens for.

### Response
- **Returns** (dict) - A dictionary with user ids mapped to a list of tokens.
```

--------------------------------

### fetch_flag

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

Gets the current set flag for the specified user.

```APIDOC
## fetch_flag(user_id)

### Description
Gets current set flag for the specified user.

### Parameters
- **user_id** (str) - Required - The id of the user you want to fetch the flag for.

### Response
- **Returns** (Country | None) - The users flag.
```

--------------------------------

### async fetch_multiple_flags

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

Gets the current set flags for the specified users.

```APIDOC
## fetch_multiple_flags

### Description
Gets the current set flags for the specified users.

### Parameters
- **user_ids** (str) - Required - A list of user ids you want to fetch flags for.

### Response
- **Returns** (dict[str, Country | None]) - A dictionary with user ids mapped to a flag enum.
```

--------------------------------

### Bot Class Initialization and Attributes

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

Details the constructor for the Bot class, its inheritance, and key attributes like command_prefix, case_insensitive, description, help_command, owner_id, and owner_ids.

```APIDOC
## rebootpy.ext.commands.Bot

### Description
Represents a fortnite bot. This class is a subclass of `rebootpy.Client` and subclasses `GroupMixin` to provide command management functionality.

### Parameters
- **command_prefix** (str | Callable | Iterable[str]) - The command prefix for invoking commands. Can be a string, a callable, or an iterable of strings. An empty string enables prefix-less invocation. When using multiple prefixes, ensure shorter prefixes do not match longer ones that appear later in the sequence.
- **auth** - Authentication credentials for the bot.
- **help_command** (Optional[HelpCommand]) - The help command implementation to use. Defaults to a built-in help command. Can be set to `None` to remove the help command.
- **description** (Optional[str]) - Content prefixed into the default help message.
- **case_insensitive** (bool) - Whether commands should be case insensitive. Defaults to `False`. This setting does not carry over to groups.
- **owner_id** (Optional[int]) - The user ID that owns the bot. Used by `is_owner()`.
- **owner_ids** (Optional[Collection[int]]) - A collection of user IDs that own the bot. Recommended to use a `set` for performance. Cannot be set with `owner_id`.

### Attributes
- **command_prefix** (str | Callable | Iterable[str]) - The command prefix.
- **case_insensitive** (bool) - Whether commands are case insensitive.
- **description** (str) - The content prefixed into the default help message.
- **help_command** (Optional[HelpCommand]) - The help command implementation.
- **owner_id** (Optional[int]) - The user ID of the bot owner.
- **owner_ids** (Optional[Collection[int]]) - A collection of user IDs of the bot owners.
```

--------------------------------

### Get Contrail ID

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Retrieves the contrail ID of the currently equipped contrail.

```python
contrail: str
```

--------------------------------

### HelpCommand Methods

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

Core asynchronous methods for handling help command logic and preparation.

```APIDOC
## async send_command_help(command)

### Description
Handles the implementation of the single command page in the help command. This method does not return anything; message sending should be performed within this method using get_destination().

### Parameters
- **command** (Command) - Required - The command that was requested for help.

---

## async prepare_help_command(ctx, command=None)

### Description
A low-level method used to prepare the help command state before execution. The default implementation does nothing.

### Parameters
- **ctx** (Context) - Required - The invocation context.
- **command** (str) - Optional - The argument passed to the help command.

---

## async command_callback(ctx, command=None, page=1)

### Description
The primary implementation of the help command. It dispatches to various helper methods like send_bot_help, send_cog_help, etc.

### Parameters
- **ctx** (Context) - Required - The invocation context.
- **command** (str) - Optional - The command argument.
- **page** (int) - Optional - The page number.
```

--------------------------------

### Get User ID

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Accesses the user's unique string identifier.

```python
user.id
```

--------------------------------

### Fetch Event Tokens

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Gets event tokens for a specified user. This is an asynchronous coroutine.

```APIDOC
## GET /api/event_tokens/{user_id}

### Description
Gets event tokens for the specified user.

### Method
GET

### Endpoint
/api/event_tokens/{user_id}

### Parameters
#### Path Parameters
- **user_id** (str) - Required - The id of the user you want to fetch event tokens for.

### Response
#### Success Response (200)
- **tokens** (list[str]) - A list of event tokens.

#### Response Example
```json
{
  "tokens": ["token1", "token2"]
}
```

### Raises
- **HTTPException** - An error occurred while requesting.
```

--------------------------------

### Update Cosmetic Loadout

Source: https://context7.com/xmistt/rebootpy/llms.txt

Demonstrates how to set outfits, backpacks, pickaxes, emotes, and banner information for the local party member.

```python
import rebootpy

client = rebootpy.Client(auth=rebootpy.AdvancedAuth(prompt_device_code=True))

@client.event
async def event_ready():
    me = client.party.me

    # Set outfit (skin) - just need the CID
    await me.set_outfit('CID_028_Athena_Commando_F')

    # Set outfit with variants
    await me.set_outfit(
        asset='CID_030_Athena_Commando_M_Halloween',
        variants=[{'channel': 'ClothingColor', 'variant': 'Mat1'}]
    )

    # Set backpack
    await me.set_backpack('BID_001_BlueSquire')

    # Set pickaxe
    await me.set_pickaxe('Pickaxe_ID_015_Holiday')

    # Set emote (runs indefinitely until cleared)
    await me.set_emote('EID_Floss')

    # Set emote with duration
    await me.set_emote('EID_Wave', run_for=5.0)

    # Clear emote
    await me.clear_emote()

    # Set banner and level display
    await me.set_banner(icon='OtherBanner28', color='DefaultColor15', season_level=100)

    # Equip crown
    await me.equip_crown(hold_crown=True)
    await me.set_victory_crowns(crowns=10)

client.run()
```

--------------------------------

### async fetch_multiple_br_stats_collections

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

Gets Battle Royale stats collections for multiple users at the same time.

```APIDOC
## fetch_multiple_br_stats_collections

### Description
Gets Battle Royale stats collections for multiple users at the same time.

### Parameters
- **user_ids** (List[str]) - Required - A list of ids you are requesting the stats for.
- **collection** (StatsCollectionType) - Optional - The collection to receive.
- **start_time** (Optional[Union[int, datetime.datetime]]) - Optional - The UTC start time of the time period to get stats from.
- **end_time** (Optional[Union[int, datetime.datetime]]) - Optional - The UTC end time of the time period to get stats from.

### Response
- **Returns** (Dict[str, Optional[StatsCollection]]) - A mapping where StatsCollection is bound to its owner’s id.
```

--------------------------------

### Implement Bot with Commands

Source: https://context7.com/xmistt/rebootpy/llms.txt

Creates a command-based bot using the commands extension, including persistent device authentication storage.

```python
import rebootpy
from rebootpy.ext import commands
import json
import os

filename = 'device_auths.json'

def get_device_auth_details():
    if os.path.isfile(filename):
        with open(filename, 'r') as fp:
            return json.load(fp)
    return {}

def store_device_auth_details(details):
    with open(filename, 'w') as fp:
        json.dump(details, fp)

device_auth_details = get_device_auth_details()
bot = commands.Bot(
    command_prefix='!',
    auth=rebootpy.AdvancedAuth(
        prompt_device_code=True,
        **device_auth_details
    )
)

@bot.event
async def event_device_auth_generate(details):
    store_device_auth_details(details)

@bot.event
async def event_ready():
    print(f'Bot ready as {bot.user.display_name}')

@bot.command()
async def ping(ctx):
    """Responds with Pong!"""
    await ctx.send('Pong!')

@bot.command()
async def skin(ctx, *, skin_name: str):
    """Sets the bot's outfit"""
    await bot.party.me.set_outfit(skin_name)
    await ctx.send(f'Set skin to {skin_name}')

@bot.command()
async def emote(ctx, *, emote_id: str):
    """Makes the bot perform an emote"""
    await bot.party.me.set_emote(emote_id)
    await ctx.send(f'Playing emote {emote_id}')

@bot.command()
async def stop(ctx):
    """Stops current emote"""
    await bot.party.me.clear_emote()
    await ctx.send('Stopped emote')

bot.run()
```

--------------------------------

### Get User JID

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Retrieves the user's Jabber ID (JID) as an aioxmpp.JID object.

```python
user.jid
```

--------------------------------

### Fetch User Flag

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Gets the current set flag for a specified user. This is an asynchronous coroutine.

```APIDOC
## GET /api/flag/{user_id}

### Description
Gets current set flag for the specified user.

### Method
GET

### Endpoint
/api/flag/{user_id}

### Parameters
#### Path Parameters
- **user_id** (str) - Required - The id of the user you want to fetch the flag for.

### Response
#### Success Response (200)
- **flag** (Country | None) - The users flag.

#### Response Example
```json
{
  "flag": "US"
}
```

### Raises
- **HTTPException** - An error occurred while requesting.
```

--------------------------------

### Manage Party Playlist and Settings

Source: https://context7.com/xmistt/rebootpy/llms.txt

Shows how to update playlist, matchmaking keys, and privacy settings, requiring party leader permissions.

```python
import rebootpy

client = rebootpy.Client(auth=rebootpy.AdvancedAuth(prompt_device_code=True))

@client.event
async def event_ready():
    party = client.party

    # Set playlist (requires party leader)
    if party.me.leader:
        await party.set_playlist('Playlist_DefaultSquad')

        # Set custom matchmaking key
        await party.set_custom_key('my_custom_key_123')

        # Set party privacy
        await party.set_privacy(rebootpy.PartyPrivacy.FRIENDS)

        # Get current playlist info
        print(f'Current playlist: {party.playlist_info}')

@client.event
async def event_party_member_promote(old_leader, new_leader):
    print(f'{new_leader.display_name} is now party leader')
    if new_leader.id == client.user.id:
        await client.party.set_custom_key('bot_custom_key')

client.run()
```

--------------------------------

### Handle Friend Presence and Join Party

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Demonstrates how to listen for friend presence updates and join a party if it is not private.

```python
@client.event
async def event_friend_presence(before, after):
    # after is the newly received presence
    presence = after

    # check if presence is from the account 'Terbau'
    # NOTE: you should always use id over display_name
    # but for this example i've use display_name just
    # to demonstrate.
    if presence.friend.display_name != 'Terbau':
        return

    # check if party is private
    if presence.party.private:
        return

    # if all the checks above succeeds we join the party
    await presence.party.join()
```

--------------------------------

### Get Battle Pass Information

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Retrieves battle pass information including purchase status and level.

```default
(True, 30)
```

--------------------------------

### Get Equipped Contrail ID

Source: https://github.com/xmistt/rebootpy/blob/main/docs/api.md

Retrieves the ID of the currently equipped contrail. Returns None if no contrail is equipped.

```python
member.contrail
```

--------------------------------

### HelpCommand Properties and Methods

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

API documentation for the HelpCommand class members.

```APIDOC
## invoked_with

### Description
Returns the command name that triggered the invocation, handling cases where send_help() is used.

### Returns
- **str** - The command name that triggered this invocation.

## get_command_signature(command)

### Description
Retrieves the signature portion of the help page for a given command.

### Parameters
- **command** (Command) - Required - The command to get the signature of.

### Returns
- **str** - The signature for the command.

## cog

### Description
A property for retrieving or setting the cog for the help command.

### Returns
- **Optional[Cog]** - The cog currently set for the help command.

## command_not_found(string)

### Description
A method called when a command is not found in the help command. Useful for i18n.

### Parameters
- **string** (str) - Required - The string containing the invalid command.

### Returns
- **str** - The string to use when a command has not been found.

## subcommand_not_found(command, string)

### Description
A method called when a command did not have a subcommand requested in the help command.

### Parameters
- **command** (Command) - Required - The command that did not have the subcommand requested.
- **string** (str) - Required - The string that contains the invalid subcommand.

### Returns
- **str** - The string to use when the subcommand is missing.

## filter_commands(commands, sort=False, key=None)

### Description
Returns a filtered list of commands and optionally sorts them based on checks and visibility.

### Parameters
- **commands** (Iterable[Command]) - Required - An iterable of commands to filter.
- **sort** (bool) - Optional - Whether to sort the result.
- **key** (Optional[Callable]) - Optional - Key function for sorting.

### Returns
- **List[Command]** - A list of commands that passed the filter.

## get_max_size(commands)

### Description
Returns the largest name length of the specified command list.

### Parameters
- **commands** (Sequence[Command]) - Required - A sequence of commands to check.

### Returns
- **int** - The maximum width of the commands.

## get_destination()

### Description
Returns the destination where the help command will be output.

### Returns
- **Friend/ClientParty** - The destination object.
```

--------------------------------

### Fetch Multiple Battle Royale Stats

Source: https://github.com/xmistt/rebootpy/blob/main/docs/ext/commands/api.md

Gets Battle Royale stats for multiple users at the same time. This is an asynchronous function.

```APIDOC
## async fetch_multiple_br_stats(user_ids, stats, start_time=None, end_time=None)

### Description
Gets Battle Royale stats for multiple users at the same time. This function is not the same as doing [`fetch_br_stats()`](#rebootpy.ext.commands.Bot.fetch_br_stats) for multiple users.

### Method
GET (Implied)

### Endpoint
/api/br/stats/multiple

### Parameters
#### Query Parameters
- **user_ids** (List[str]) - Required - List of user ids.
- **stats** (List[StatObject]) - Required - List of stat objects to retrieve.
- **start_time** (Optional[Union[int, datetime.datetime]]) - Optional - The UTC start time of the window to get the stats from. Must be seconds since epoch or a `datetime.datetime` instance. Defaults to None.
- **end_time** (Optional[Union[int, datetime.datetime]]) - Optional - The UTC end time of the window to get the stats from. Must be seconds since epoch or a `datetime.datetime` instance. Defaults to None.

### Request Example
```json
{
  "user_ids": ["user1_id", "user2_id"],
  "stats": [
    {
      "name": "placetop1",
      "input": "keyboardmouse",
      "window": "defaultsolo"
    },
    {
      "name": "kills",
      "input": "keyboardmouse",
      "window": "defaultsolo"
    }
  ],
  "start_time": 1678886400,
  "end_time": 1681564800
}
```

### Response
#### Success Response (200)
- **Dict[str, Optional[Dict]]**: A dictionary where keys are user IDs and values are dictionaries containing the requested stats for that user. Returns `None` if no stats were found for a user.

#### Response Example
```json
{
  "user1_id": {
    "keyboardmouse": {
      "defaultsolo": {
        "placetop1": 759,
        "kills": 28093
      }
    }
  },
  "user2_id": {
    "keyboardmouse": {
      "defaultsolo": {
        "placetop1": 1763,
        "kills": 41375
      }
    }
  }
}
```

### Raises
- **HTTPException**: An error occurred while requesting.
```
Tokens:
Raw