fightstick_hb.py

import os
import sys
import urllib.error
import urllib.request
from configparser import ConfigParser, ParsingError, NoSectionError

import pyglet
from pyglet.util import debug_print
from pyglet.math import Mat4, Vec3

# Set up the debugging flag calls.
_debug_flag = len(sys.argv) > 1 and sys.argv[1] in ('-D', '-d', '--debug')
_debug_print = debug_print(_debug_flag)
_debug_print("Debugging Active")

# Load the theme from the /theme folder.
pyglet.resource.path.append("theme")
pyglet.resource.reindex()
_debug_print("Theme Loaded")

# Create the main window. Use configParser to set a static controller status of unplugged.
window = pyglet.window.Window(640, 390, caption="Fightstick Display", resizable=True, vsync=False)
window.set_icon(pyglet.resource.image("icon.png"))
config = ConfigParser()
config.add_section('layout')
config.add_section('images')
config.add_section('deadzones')
_debug_print("Main window created")

# Parse and add additional SDL style controller mappings.
url = "https://raw.githubusercontent.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt"
try:
    with urllib.request.urlopen(url) as response, open(
        os.path.dirname(__file__) + "/gamecontrollerdb.txt", "wb"
    ) as f:
        f.write(response.read())
except Exception:
    if os.path.exists("gamecontrollerdb.txt"):
        try:
            pyglet.input.controller.add_mappings_from_file("gamecontrollerdb.txt")
            _debug_print(
                "Added additional controller mappings from 'gamecontrollerdb.txt'"
            )
        except Exception as e:
            _debug_print(
                f"Failed to load 'gamecontrollerdb.txt'. Please open an issue on GitHub. \n --> {e}"
            )

# Set the (x,y) parameters for where certain elements should be displayed.
_layout = {
    "background": (0, 0),
    "select": (50, 318),
    "start": (50, 318),
    "up": (237, 10),
    "down": (133, 217),
    "left": (47, 217),
    "right": (209, 176),
    "a": (284, 124),
    "b": (364, 158),
    "x": (290, 214),
    "y": (369, 247),
    "rb": (456, 246),
    "lb": (543, 234),
    "rt": (456, 159),
    "lt": (540, 146),
}
_debug_print("Layout loaded.")

# Connect the image file names to their definitions.
_images = {
    "background": "backgroundHB.png",
    "select": "select.png",
    "start": "start.png",
    "up": "buttonhblg.png",
    "down": "buttonhb.png",
    "left": "buttonhb.png",
    "right": "buttonhb.png",
    "a": "buttonhb.png",
    "b": "buttonhb.png",
    "x": "buttonhb.png",
    "y": "buttonhb.png",
    "lt": "buttonhb.png",
    "rt": "buttonhb.png",
    "lb": "buttonhb.png",
    "rb": "buttonhb.png",
}
_debug_print("Images loaded.")

def load_configuration():
    # Load the button mapping configuration.
    global _layout, _images
    layout = _layout.copy()
    images = _images.copy()

    with pyglet.resource.file('layouthb.ini', 'r') as file:
        loaded_configs = config.read(file.name)

    if not loaded_configs:
        print("No valid layouthb.ini found. Falling back to default.")
        return

    try:
        for key, value in config.items('layout'):
            x, y = value.split(', ')
            layout[key] = int(x), int(y)

        for key, value in config.items('images'):
            images[key] = value

        _layout = layout.copy()
        _images = images.copy()

    except (KeyError, ParsingError, NoSectionError):
        print("Invalid theme/layouthb.ini. Falling back to default.")


def save_configuration():
    with pyglet.resource.file('layouthb.ini', 'w') as file:
        config.write(file)


#########################
#   Scene definitions:
#########################

class _BaseScene:
    manager:    None

    def activate(self):
        pass

    def deactivate(self):
        pass


class RetryScene(_BaseScene):
    #A scene that tells you to try again if no stick is detected.
    def __init__(self):
        self.batch = pyglet.graphics.Batch()
        self.missing_img = pyglet.resource.image("missing.png")
        self.sprite = pyglet.sprite.Sprite(img=pyglet.resource.image("missing.png"), batch=self.batch)


class ConfigScene(_BaseScene):
    #A scene to allow deadzone configuration.
    def __init__(self):
        self.batch = pyglet.graphics.Batch()
        bar = pyglet.resource.image("bar.png")
        knob = pyglet.resource.image("knob.png")
        bg_img = pyglet.resource.image('deadzone.png')
        self.bg = pyglet.sprite.Sprite(bg_img, batch=self.batch, group=pyglet.graphics.Group(-1))

        self.stick_slider = pyglet.gui.Slider(100, 150, bar, knob, edge=0, batch=self.batch)
        self.stick_slider.set_handler('on_change', self._stick_slider_handler)
        self.stick_label = pyglet.text.Label("", x=380, y=150, batch=self.batch)

        self.trigger_slider = pyglet.gui.Slider(100, 100, bar, knob, edge=0, batch=self.batch)
        self.trigger_slider.set_handler('on_change', self._trigger_slider_handler)
        self.trigger_label = pyglet.text.Label("", x=380, y=100, batch=self.batch)

    def activate(self):
        self.stick_slider.value = self.manager.stick_deadzone * 100
        self.trigger_slider.value = self.manager.trigger_deadzone * 100
        self.stick_label.text = f"Stick Deadzone: {round(self.manager.stick_deadzone * 100, 2)}"
        self.trigger_label.text = f"Trigger Deadzone: {round(self.manager.trigger_deadzone * 100, 2)}"
        self.manager.window.push_handlers(self.stick_slider)
        self.manager.window.push_handlers(self.trigger_slider)

    def deactivate(self):
        self.manager.window.remove_handlers(self.stick_slider)
        self.manager.window.remove_handlers(self.trigger_slider)
        save_configuration()

    def _stick_slider_handler(self, value):
        self.stick_label.text = f"Stick Deadzone: {round(value, 2)}"
        scaled_value = round(value / 100, 2)
        self.manager.stick_deadzone = scaled_value
        config.set('deadzones', 'stick', str(scaled_value))

    def _trigger_slider_handler(self, value):
        self.trigger_label.text = f"Trigger Deadzone: {round(value, 2)}"
        scaled_value = round(value / 100, 2)
        self.manager.trigger_deadzone = scaled_value
        config.set('deadzones', 'trigger', str(scaled_value))

    def on_button_press(self, controller, button):
        if button == "guide":
            self.manager.set_scene('main')

    def on_key_press(self, key, modifiers):
        self.manager.set_scene('main')
        return pyglet.event.EVENT_HANDLED


class MainScene(_BaseScene):
    # The main scene, with all fightstick events wired up.
    def __init__(self):
        self.batch = pyglet.graphics.Batch()
        # Ordered groups to handle draw order of the sprites.
        self.bg = pyglet.graphics.Group(0)
        self.fg = pyglet.graphics.Group(1)
        # Create all sprites using helper function (name, batch, group, visible).
        self.background = self._make_sprite('background', self.bg)
        self.select_spr = self._make_sprite('select', self.fg, False)
        self.start_spr = self._make_sprite('start', self.fg, False)
        self.up_spr = self._make_sprite("up", self.fg, False)
        self.down_spr = self._make_sprite("down", self.fg, False)
        self.left_spr = self._make_sprite("left", self.fg, False)
        self.right_spr = self._make_sprite("right", self.fg, False)
        self.x_spr = self._make_sprite('x', self.fg, False)
        self.y_spr = self._make_sprite('y', self.fg, False)
        self.a_spr = self._make_sprite('a', self.fg, False)
        self.b_spr = self._make_sprite('b', self.fg, False)
        self.rb_spr = self._make_sprite('rb', self.fg, False)
        self.lb_spr = self._make_sprite('lb', self.fg, False)
        self.rt_spr = self._make_sprite('rt', self.fg, False)
        self.lt_spr = self._make_sprite('lt', self.fg, False)

        # Mapping of (Input names : Sprite names).
        self.button_mapping = {"a": self.a_spr, "b": self.b_spr, "x": self.x_spr, "y": self.y_spr,
                               "rightshoulder": self.rb_spr, "leftshoulder": self.lb_spr,
                               "righttrigger": self.rt_spr, "lefttrigger": self.lt_spr,
                               "back": self.select_spr, "start": self.start_spr}

    def _make_sprite(self, name, group, visible=True):
        # Helper function to make a Sprite.
        image = pyglet.resource.image(_images[name])
        position = _layout[name]
        sprite = pyglet.sprite.Sprite(image, *position, batch=self.batch, group=group)
        sprite.visible = visible
        return sprite

    def on_key_press(self, key, modifiers):
        if key == pyglet.window.key.F1:
            self.manager.set_scene('config')

    # Event to show a button when pressed.
    def on_button_press(self, controller, button):
        assert _debug_print(f"Pressed Button: {button}")
        if button == "guide":
            self.manager.set_scene('config')
        pressed_button = self.button_mapping.get(button, None)
        if pressed_button:
            pressed_button.visible = True

    # Event to hide the sprite when the button is released.
    def on_button_release(self, controller, button):
        pressed_button = self.button_mapping.get(button, None)
        if pressed_button:
            pressed_button.visible = False

    # Have the dpad hats alert the main window to draw the sprites.
    def on_dpad_motion(self, controller, dpleft, dpright, dpup, dpdown):
        assert _debug_print(
            f"Dpad  Left:{dpleft}, Right:{dpright}, Up:{dpup}, Down:{dpdown}"
        )
        self.up_spr.visible = bool(dpup)
        self.down_spr.visible = bool(dpdown)
        self.left_spr.visible = bool(dpleft)
        self.right_spr.visible = bool(dpright)

    # Math to draw trigger inputs or hide them.
    def on_trigger_motion(self, controller, trigger, value):
        assert _debug_print(f"Pulled Trigger: {trigger}")
        if trigger == "lefttrigger":
            if value > self.manager.trigger_deadzone:
                self.lt_spr.visible = True
            elif value < self.manager.trigger_deadzone:
                self.lt_spr.visible = False
        if trigger == "righttrigger":
            if value > self.manager.trigger_deadzone:
                self.rt_spr.visible = True
            elif value < self.manager.trigger_deadzone:
                self.rt_spr.visible = False


#####################################################
#   SceneManager class to handle Scene Switching:
#####################################################

class SceneManager:
    """A Scene Management class.

    The SceneManager is responsible for switching between
    the various scenes cleanly. This includes setting and
    removing Window and Controller events handlers. Global
    state (deadzone, etc.) is also defined here.

    """
    def __init__(self, window_instance):
        self.window = window_instance
        self.window.push_handlers(self)

        self.fightstick = None

        # Set up Scene instances:
        self._scenes = {}
        self._current_scene = None
        self.add_scene('main', MainScene())
        self.add_scene('retry', RetryScene())
        self.add_scene('config', ConfigScene())

        # Instantiation a ControllerManager to handle hot-plugging:
        self.controller_manager = pyglet.input.ControllerManager()
        self.controller_manager.on_connect = self.on_controller_connect
        self.controller_manager.on_disconnect = self.on_controller_disconnect

        # Set Scene depending on if there is a Controller:
        controllers = self.controller_manager.get_controllers()
        if controllers:
            self.on_controller_connect(controllers[0])
            self.set_scene('main')
        else:
            self.set_scene('retry')

        # Global state for all Scenes:
        self.stick_deadzone = float(config.get('deadzones', 'stick', fallback='0.2'))
        self.trigger_deadzone = float(config.get('deadzones', 'trigger', fallback='0.8'))

    # Detect is a controller is connected.
    def on_controller_connect(self, controller):
        if not self.fightstick:
            controller.open()
            self.fightstick = controller
            self.fightstick.push_handlers(self._current_scene)
            self.set_scene('main')
        else:
            _debug_print(f"A Controller is already connected: {self.fightstick}")

    # Detect is a controller is disconnected.
    def on_controller_disconnect(self, controller):
        if self.fightstick == controller:
            self.fightstick.remove_handlers(self._current_scene)
            self.fightstick = None
            self.set_scene('retry')

    def add_scene(self, name, instance):
        instance.manager = self
        self._scenes[name] = instance

    def set_scene(self, name):
        if self._current_scene:
            self.window.remove_handlers(self._current_scene)
            self._current_scene.deactivate()
            if self.fightstick:
                self.fightstick.remove_handlers(self._current_scene)

        new_scene = self._scenes[name]
        self.window.push_handlers(new_scene)
        if self.fightstick:
            self.fightstick.push_handlers(new_scene)

        self._current_scene = new_scene
        self._current_scene.activate()

    def enforce_aspect_ratio(self, dt):
        # Enforce aspect ratio by readjusting the window height.
        aspect_ratio = 1.641025641
        target_width = int(window.height * aspect_ratio)
        target_height = int(window.width / aspect_ratio)

        if self.window.width != target_width and self.window.height != target_height:
            self.window.set_size(window.width, target_height)

    # Window Events:

    def on_draw(self):
        self.window.clear()
        self._current_scene.batch.draw()

    def on_resize(self, width, height):
        projection_matrix = Mat4.orthogonal_projection(0, width, 0, height, 0, 1)
        scale_x = width / 640.0
        scale_y = height / 390.0
        self.window.projection = projection_matrix.scale(Vec3(scale_x, scale_y, 1))
        self.window.viewport = 0, 0, width, height
        return pyglet.event.EVENT_HANDLED


if __name__ == "__main__":
    load_configuration()

    scene_manager = SceneManager(window_instance=window)
    # Enforce aspect ratio by readjusting the window height.
    pyglet.clock.schedule_interval(scene_manager.enforce_aspect_ratio, 0.3)
    pyglet.app.run()