bastd.ui.creditslist

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides a window to display game credits."""
  4
  5from __future__ import annotations
  6
  7from typing import TYPE_CHECKING
  8
  9import ba
 10import ba.internal
 11
 12if TYPE_CHECKING:
 13    from typing import Sequence
 14
 15
 16class CreditsListWindow(ba.Window):
 17    """Window for displaying game credits."""
 18
 19    def __init__(self, origin_widget: ba.Widget | None = None):
 20        # pylint: disable=too-many-locals
 21        # pylint: disable=too-many-statements
 22        import json
 23
 24        ba.set_analytics_screen('Credits Window')
 25
 26        # if they provided an origin-widget, scale up from that
 27        scale_origin: tuple[float, float] | None
 28        if origin_widget is not None:
 29            self._transition_out = 'out_scale'
 30            scale_origin = origin_widget.get_screen_space_center()
 31            transition = 'in_scale'
 32        else:
 33            self._transition_out = 'out_right'
 34            scale_origin = None
 35            transition = 'in_right'
 36
 37        uiscale = ba.app.ui.uiscale
 38        width = 870 if uiscale is ba.UIScale.SMALL else 670
 39        x_inset = 100 if uiscale is ba.UIScale.SMALL else 0
 40        height = 398 if uiscale is ba.UIScale.SMALL else 500
 41
 42        self._r = 'creditsWindow'
 43        super().__init__(
 44            root_widget=ba.containerwidget(
 45                size=(width, height),
 46                transition=transition,
 47                toolbar_visibility='menu_minimal',
 48                scale_origin_stack_offset=scale_origin,
 49                scale=(
 50                    2.0
 51                    if uiscale is ba.UIScale.SMALL
 52                    else 1.3
 53                    if uiscale is ba.UIScale.MEDIUM
 54                    else 1.0
 55                ),
 56                stack_offset=(0, -8) if uiscale is ba.UIScale.SMALL else (0, 0),
 57            )
 58        )
 59
 60        if ba.app.ui.use_toolbars and uiscale is ba.UIScale.SMALL:
 61            ba.containerwidget(
 62                edit=self._root_widget, on_cancel_call=self._back
 63            )
 64        else:
 65            btn = ba.buttonwidget(
 66                parent=self._root_widget,
 67                position=(
 68                    40 + x_inset,
 69                    height - (68 if uiscale is ba.UIScale.SMALL else 62),
 70                ),
 71                size=(140, 60),
 72                scale=0.8,
 73                label=ba.Lstr(resource='backText'),
 74                button_type='back',
 75                on_activate_call=self._back,
 76                autoselect=True,
 77            )
 78            ba.containerwidget(edit=self._root_widget, cancel_button=btn)
 79
 80            ba.buttonwidget(
 81                edit=btn,
 82                button_type='backSmall',
 83                position=(
 84                    40 + x_inset,
 85                    height - (68 if uiscale is ba.UIScale.SMALL else 62) + 5,
 86                ),
 87                size=(60, 48),
 88                label=ba.charstr(ba.SpecialChar.BACK),
 89            )
 90
 91        ba.textwidget(
 92            parent=self._root_widget,
 93            position=(0, height - (59 if uiscale is ba.UIScale.SMALL else 54)),
 94            size=(width, 30),
 95            text=ba.Lstr(
 96                resource=self._r + '.titleText',
 97                subs=[('${APP_NAME}', ba.Lstr(resource='titleText'))],
 98            ),
 99            h_align='center',
100            color=ba.app.ui.title_color,
101            maxwidth=330,
102            v_align='center',
103        )
104
105        scroll = ba.scrollwidget(
106            parent=self._root_widget,
107            position=(40 + x_inset, 35),
108            size=(width - (80 + 2 * x_inset), height - 100),
109            capture_arrows=True,
110        )
111
112        if ba.app.ui.use_toolbars:
113            ba.widget(
114                edit=scroll,
115                right_widget=ba.internal.get_special_widget('party_button'),
116            )
117            if uiscale is ba.UIScale.SMALL:
118                ba.widget(
119                    edit=scroll,
120                    left_widget=ba.internal.get_special_widget('back_button'),
121                )
122
123        def _format_names(names2: Sequence[str], inset: float) -> str:
124            sval = ''
125            # measure a series since there's overlaps and stuff..
126            space_width = (
127                ba.internal.get_string_width(' ' * 10, suppress_warning=True)
128                / 10.0
129            )
130            spacing = 330.0
131            col1 = inset
132            col2 = col1 + spacing
133            col3 = col2 + spacing
134            line_width = 0.0
135            nline = ''
136            for name in names2:
137                # move to the next column (or row) and print
138                if line_width > col3:
139                    sval += nline + '\n'
140                    nline = ''
141                    line_width = 0
142
143                if line_width > col2:
144                    target = col3
145                elif line_width > col1:
146                    target = col2
147                else:
148                    target = col1
149                spacingstr = ' ' * int((target - line_width) / space_width)
150                nline += spacingstr
151                nline += name
152                line_width = ba.internal.get_string_width(
153                    nline, suppress_warning=True
154                )
155            if nline != '':
156                sval += nline + '\n'
157            return sval
158
159        sound_and_music = ba.Lstr(
160            resource=self._r + '.songCreditText'
161        ).evaluate()
162        sound_and_music = sound_and_music.replace(
163            '${TITLE}', "'William Tell (Trumpet Entry)'"
164        )
165        sound_and_music = sound_and_music.replace(
166            '${PERFORMER}', 'The Apollo Symphony Orchestra'
167        )
168        sound_and_music = sound_and_music.replace(
169            '${PERFORMER}', 'The Apollo Symphony Orchestra'
170        )
171        sound_and_music = sound_and_music.replace(
172            '${COMPOSER}', 'Gioacchino Rossini'
173        )
174        sound_and_music = sound_and_music.replace('${ARRANGER}', 'Chris Worth')
175        sound_and_music = sound_and_music.replace('${PUBLISHER}', 'BMI')
176        sound_and_music = sound_and_music.replace(
177            '${SOURCE}', 'www.AudioSparx.com'
178        )
179        spc = '     '
180        sound_and_music = spc + sound_and_music.replace('\n', '\n' + spc)
181        names = [
182            'HubOfTheUniverseProd',
183            'Jovica',
184            'LG',
185            'Leady',
186            'Percy Duke',
187            'PhreaKsAccount',
188            'Pogotron',
189            'Rock Savage',
190            'anamorphosis',
191            'benboncan',
192            'cdrk',
193            'chipfork',
194            'guitarguy1985',
195            'jascha',
196            'joedeshon',
197            'loofa',
198            'm_O_m',
199            'mich3d',
200            'sandyrb',
201            'shakaharu',
202            'sirplus',
203            'stickman',
204            'thanvannispen',
205            'virotic',
206            'zimbot',
207        ]
208        names.sort(key=lambda x: x.lower())
209        freesound_names = _format_names(names, 90)
210
211        try:
212            with open('ba_data/data/langdata.json', encoding='utf-8') as infile:
213                translation_contributors = json.loads(infile.read())[
214                    'translation_contributors'
215                ]
216        except Exception:
217            ba.print_exception('Error reading translation contributors.')
218            translation_contributors = []
219
220        translation_names = _format_names(translation_contributors, 60)
221
222        # Need to bake this out and chop it up since we're passing our
223        # 65535 vertex limit for meshes..
224        # We can remove that limit once we drop support for GL ES2.. :-/
225        # (or add mesh splitting under the hood)
226        credits_text = (
227            '  '
228            + ba.Lstr(resource=self._r + '.codingGraphicsAudioText')
229            .evaluate()
230            .replace('${NAME}', 'Eric Froemling')
231            + '\n'
232            '\n'
233            '  '
234            + ba.Lstr(resource=self._r + '.additionalAudioArtIdeasText')
235            .evaluate()
236            .replace('${NAME}', 'Raphael Suter')
237            + '\n'
238            '\n'
239            '  '
240            + ba.Lstr(resource=self._r + '.soundAndMusicText').evaluate()
241            + '\n'
242            '\n' + sound_and_music + '\n'
243            '\n'
244            '     '
245            + ba.Lstr(resource=self._r + '.publicDomainMusicViaText')
246            .evaluate()
247            .replace('${NAME}', 'Musopen.com')
248            + '\n'
249            '        '
250            + ba.Lstr(resource=self._r + '.thanksEspeciallyToText')
251            .evaluate()
252            .replace('${NAME}', 'the US Army, Navy, and Marine Bands')
253            + '\n'
254            '\n'
255            '     '
256            + ba.Lstr(resource=self._r + '.additionalMusicFromText')
257            .evaluate()
258            .replace('${NAME}', 'The YouTube Audio Library')
259            + '\n'
260            '\n'
261            '     '
262            + ba.Lstr(resource=self._r + '.soundsText')
263            .evaluate()
264            .replace('${SOURCE}', 'Freesound.org')
265            + '\n'
266            '\n' + freesound_names + '\n'
267            '\n'
268            '  '
269            + ba.Lstr(resource=self._r + '.languageTranslationsText').evaluate()
270            + '\n'
271            '\n'
272            + '\n'.join(translation_names.splitlines()[:146])
273            + '\n'.join(translation_names.splitlines()[146:])
274            + '\n'
275            '\n'
276            '  Shout Out to Awesome Mods / Modders / Contributors:\n\n'
277            '     BombDash ModPack\n'
278            '     TheMikirog & SoK - BombSquad Joyride Modpack\n'
279            '     Mrmaxmeier - BombSquad-Community-Mod-Manager\n'
280            '     Ritiek Malhotra \n'
281            '     Dliwk\n'
282            '     vishal332008\n'
283            '     itsre3\n'
284            '     Drooopyyy\n'
285            '\n'
286            '  Holiday theme vector art designed by Freepik\n'
287            '\n'
288            '  '
289            + ba.Lstr(resource=self._r + '.specialThanksText').evaluate()
290            + '\n'
291            '\n'
292            '     Todd, Laura, and Robert Froemling\n'
293            '     '
294            + ba.Lstr(resource=self._r + '.allMyFamilyText')
295            .evaluate()
296            .replace('\n', '\n     ')
297            + '\n'
298            '     '
299            + ba.Lstr(
300                resource=self._r + '.whoeverInventedCoffeeText'
301            ).evaluate()
302            + '\n'
303            '\n'
304            '  ' + ba.Lstr(resource=self._r + '.legalText').evaluate() + '\n'
305            '\n'
306            '     '
307            + ba.Lstr(resource=self._r + '.softwareBasedOnText')
308            .evaluate()
309            .replace('${NAME}', 'the Khronos Group')
310            + '\n'
311            '\n'
312            '                                       '
313            '                      www.ballistica.net\n'
314        )
315
316        txt = credits_text
317        lines = txt.splitlines()
318        line_height = 20
319
320        scale = 0.55
321        self._sub_width = width - 80
322        self._sub_height = line_height * len(lines) + 40
323
324        container = self._subcontainer = ba.containerwidget(
325            parent=scroll,
326            size=(self._sub_width, self._sub_height),
327            background=False,
328            claims_left_right=False,
329            claims_tab=False,
330        )
331
332        voffs = 0
333        for line in lines:
334            ba.textwidget(
335                parent=container,
336                padding=4,
337                color=(0.7, 0.9, 0.7, 1.0),
338                scale=scale,
339                flatness=1.0,
340                size=(0, 0),
341                position=(0, self._sub_height - 20 + voffs),
342                h_align='left',
343                v_align='top',
344                text=ba.Lstr(value=line),
345            )
346            voffs -= line_height
347
348    def _back(self) -> None:
349        from bastd.ui.mainmenu import MainMenuWindow
350
351        ba.containerwidget(
352            edit=self._root_widget, transition=self._transition_out
353        )
354        ba.app.ui.set_main_menu_window(
355            MainMenuWindow(transition='in_left').get_root_widget()
356        )