bacommon.app

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Common high level values/functionality related to apps."""
  4
  5from __future__ import annotations
  6
  7from enum import Enum
  8from dataclasses import dataclass
  9from typing import TYPE_CHECKING, Annotated
 10
 11from efro.dataclassio import ioprepped, IOAttrs
 12
 13if TYPE_CHECKING:
 14    pass
 15
 16
 17class AppInterfaceIdiom(Enum):
 18    """A general form-factor or way of experiencing a Ballistica app.
 19
 20    Note that it is possible for a running app to switch idioms (for
 21    instance if a mobile device or computer is connected to a TV).
 22    """
 23
 24    PHONE = 'phone'
 25    TABLET = 'tablet'
 26    DESKTOP = 'desktop'
 27    TV = 'tv'
 28    XR = 'xr'
 29
 30
 31class AppExperience(Enum):
 32    """A particular experience that can be provided by a Ballistica app.
 33
 34    This is one metric used to isolate different playerbases from
 35    eachother where there might be no technical barriers doing so.
 36    For example, a casual one-hand-playable phone game and an augmented
 37    reality tabletop game may both use the same scene-versions and
 38    networking-protocols and whatnot, but it would make no sense to
 39    allow players of one join servers for the other. AppExperience can
 40    be used to keep these player bases separate.
 41
 42    Generally a single Ballistica app targets a single AppExperience.
 43    This is not a technical requirement, however. A single app may
 44    support multiple experiences, or there may be multiple apps
 45    targeting one experience. Cloud components such as leagues are
 46    generally associated with an AppExperience so that they are only
 47    visible to client apps designed for that play style.
 48    """
 49
 50    # An experience that is supported everywhere. Used
 51    # for the default empty AppMode when starting the app, etc.
 52    EMPTY = 'empty'
 53
 54    # The traditional BombSquad experience: multiple players using
 55    # controllers in a single arena small enough for all action to be
 56    # viewed on a single screen.
 57    MELEE = 'melee'
 58
 59    # The traditional BombSquad Remote experience; buttons on a
 60    # touch-screen allowing a mobile device to be used as a game
 61    # controller.
 62    REMOTE = 'remote'
 63
 64
 65class AppArchitecture(Enum):
 66    """Processor architecture the App is running on."""
 67
 68    ARM = 'arm'
 69    ARM64 = 'arm64'
 70    X86 = 'x86'
 71    X86_64 = 'x86_64'
 72
 73
 74class AppPlatform(Enum):
 75    """Overall platform a Ballistica build can be targeting.
 76
 77    Each distinct flavor of an app has a unique combination
 78    of AppPlatform and AppVariant. Generally platform describes
 79    a set of hardware, while variant describes a destination or
 80    purpose for the build.
 81    """
 82
 83    MAC = 'mac'
 84    WINDOWS = 'windows'
 85    LINUX = 'linux'
 86    ANDROID = 'android'
 87    IOS = 'ios'
 88    TVOS = 'tvos'
 89
 90
 91class AppVariant(Enum):
 92    """A unique Ballistica build type within a single platform.
 93
 94    Each distinct flavor of an app has a unique combination
 95    of AppPlatform and AppVariant. Generally platform describes
 96    a set of hardware, while variant describes a destination or
 97    purpose for the build.
 98    """
 99
100    # Default builds.
101    GENERIC = 'generic'
102
103    # Builds intended for public testing (may have some extra checks
104    # or logging enabled).
105    TEST = 'test'
106
107    # Various stores.
108    AMAZON_APPSTORE = 'amazon_appstore'
109    GOOGLE_PLAY = 'google_play'
110    APP_STORE = 'app_store'
111    WINDOWS_STORE = 'windows_store'
112    STEAM = 'steam'
113    META = 'meta'
114    EPIC_GAMES_STORE = 'epic_games_store'
115
116    # Other.
117    ARCADE = 'arcade'
118    DEMO = 'demo'
119
120
121@ioprepped
122@dataclass
123class AppInstanceInfo:
124    """General info about an individual running app."""
125
126    name = Annotated[str, IOAttrs('n')]
127    version = Annotated[str, IOAttrs('v')]
128    build = Annotated[int, IOAttrs('b')]
129
130    platform = Annotated[AppPlatform, IOAttrs('p')]
131    variant = Annotated[AppVariant, IOAttrs('va')]
132    architecture = Annotated[AppArchitecture, IOAttrs('a')]
133    os_version = Annotated[str | None, IOAttrs('o')]
134
135    interface_idiom: Annotated[AppInterfaceIdiom, IOAttrs('i')]
136    locale: Annotated[str, IOAttrs('l')]
137
138    device: Annotated[str | None, IOAttrs('d')]