Skip to content

Visual editor to configure mods for the PC version of Metal Gear Solid 2: Substance using bmn's ASI Plugin

License

Notifications You must be signed in to change notification settings

mcarigs/mgs2-asi-config-editor

Repository files navigation

MGS2 ASI Mod Config Editor

alt text

Table of Contents

  1. Introduction
  2. Features
  3. Project Structure
  4. Getting Started
  5. Usage
  6. Technology Stack
  7. Development Quickstart
  8. Contributing

Introduction

The MGS2 ASI Mod Config Editor is a desktop application tha provides a user-friendly interface for editing and managing configuration files for the ASI plugin created by bmn and used by speedrunners for the PC version of Metal Gear Solid 2: Substance. This tool simplifies the process of customizing various aspects of the game, making it easier for players to tailor their gaming experience.

Features

  • Intuitive UI: A clean, responsive interface for easy navigation and editing of INI files.
  • Real-time Editing: Edit INI files with immediate visual feedback.
  • File Management: Automatically manages and ensures the existence of necessary INI files.
  • Categorized Mods: Organizes mods into categories like HUD, Turbo, Modifiers, and more for easy access.
  • Color Picker: Built-in color picker for easy customization of color-related settings.
  • Boolean Toggles: Checkbox toggles for easy enabling/disabling of features.
  • Sorted Display: Alphabetically sorted sections and keys for consistent viewing.
  • Responsive Design: Adapts to different screen sizes, including a collapsible sidebar for mobile devices.
  • Help Documentation: Comprehensive in-app help section explaining mod configurations and shortcuts.

Usage

  • Download the latest release & launch the installer. When asked where to install the application, choose the bin\scripts folder where you have MGS2 installed.
    • For example: C:\Program Files (x86)\GOG Galaxy\Games\Metal Gear Solid 2 Substance\bin\scripts.
  • Just to be safe, make a backup of your existing .ini files before using this application
  • Use the sidebar to navigate between different mod categories.
  • Click on a specific INI file to view and edit its contents.
  • Make changes using the provided inputs (text fields, checkboxes, color pickers).
  • Click "Save" to apply your changes or "Cancel" to discard them.
  • Refer to the Help section for detailed information on configuring mods and using shortcuts.

Technology Stack

Development Quickstart

  • Install the prerequisites
  • Clone the repository
  • Install frontend dependencies:
pnpm install
  • Run the development server:
pnpm tauri dev
  • Build for production:
pnpm tauri build

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  • Fork the repository
  • Create your feature branch (git checkout -b feature/AmazingFeature)
  • Commit your changes (git commit -m 'Add some AmazingFeature')
  • Push to the branch (git push origin feature/AmazingFeature)
  • Open a Pull Request

License

This project is licensed under the GNU General Public License.