Skip to content

Latest commit

 

History

History
136 lines (102 loc) · 4.22 KB

README.md

File metadata and controls

136 lines (102 loc) · 4.22 KB

ES-DE Automated Installer by the Street Kings

  • Version: v1.0.0
  • Date: 01.29.2025 @ 16:00 PST
  • Written by: Geoff Clark of Clark & Burke, LLC

Overview

This project is a Python-based universal (OS-agnostic) installer designed for EmulationStation Desktop Edition (ES-DE). It automates the setup of various emulators while creating symlinks to centralized storage locations, such as a network share, allowing multiple computers to share the same game library seamlessly.

Table of Contents

Features

  • Universal Installer: Aims to support Windows, macOS, and Linux (Windows support available now; macOS and Linux coming soon).
  • Configuration Management: Handles various system settings.
  • Database Support: Uses SQLite for data storage.
  • Utility Functions: Includes logging, debugging, and file handling utilities.
  • GUI Support: Provides graphical interfaces for user interactions.
  • Installer Scripts: Automates the installation and setup of emulators with centralized storage linking.
  • Supported Emulators:
    • Citra
    • DirectX9
    • Dolphin
    • ES-DE (EmulationStation Desktop Edition)
    • Flycast
    • PCSX2
    • PPSSPP
    • RetroArch
    • Ryujinx

Installation

Prerequisites

Ensure you have the following installed on your system:

  • Python 3.11.8 or later
  • pip (Python package manager)

Setup

  1. Clone or extract the project files.

  2. Navigate to the project directory:

    cd extracted_files

  3. Install dependencies:

    pip install -r requirements.txt

Required Files

The bin/ folder must contain the following files:

  • Configuration and Metadata Files (included in the repository):
    • CITRA.ini
    • emuauto.ico
    • es_settings.xml
    • FLYCAST.cfg
    • installers.json
    • PCSX2.ini
  • Installers and Emulator Data (must be obtained separately):
    • citra-windows-msvc-20240927-608383e.zip (Citra Emulator)
    • directx_Jun2010_redist.exe (DirectX 9 Redistributable)
    • dolphin-2412-x64.7z (Dolphin Emulator)
    • ES-DE_3.1.1-x64.zip (EmulationStation Desktop Edition)
    • flycast-win64-2.4.zip (Flycast Emulator)
    • pcsx2-v2.2.0-windows-x64-Qt.7z (PCSX2 Emulator)
    • PPSSPPGold.zip (PPSSPP Portable Edition)
    • RetroArch.7z (Windows Portable Edition, renamed)
    • ryujinx-1.1.1403-win_x64.7z (Ryujinx Emulator)
    • ryujinx_configs_firmware_19.7z (Ryujinx pre-configured folders: bis, profiles, system, Config.json with firmware preinstalled)

Usage

To run the application, execute:

python app.py

Directory Structure

project_root/
│── app.py                 # Main application entry point
│── requirements.txt       # Required dependencies
│── src/
│   ├── settings/         # Configuration settings
│   ├── database/         # SQLite database handlers
│   ├── utils/            # Utility functions
│   ├── gui/              # Graphical interface components
│   ├── installers/       # Installer scripts for various applications
│── bin/                  # Required external binaries and configuration files

Author Information

License

This project is licensed under the MIT License - see the LICENSE file for details.

Attribution

If you use this software as a base for your own projects or fork it, we kindly request that you give credit to Clark & Burke, LLC. While not required by the license, it is appreciated and helps support the ongoing development of this project.

Contributing

If you would like to contribute, please submit a pull request or open an issue.

Third-Party Notices

All rights reserved by their respective owners. Users must comply with the licenses and terms of service of the software being installed.