modorganizer2-linux-installer/docs/contributing/index.md

title, layout, nav_order, parent

title	layout	nav_order	parent
Contributing	default	5	Mod Organizer 2 Linux Installer

Contributing to MO2-LINT

Contributions to Mod Organizer 2 Linux Installer (MO2-LINT) are welcome! If you would like to contribute, please read the following guide for more information on how to get involved.

Guidelines

In order to maintain consistency across the codebase, we utilize pre-commit hooks and GitHub Actions for formatting and validation.

These include:

• Ruff linting (code formatting check)
• Private key detection
• Trailing whitespace trimmer
• YAML formatting checks
• EOF newline checks
• File size limiter (currently 150kb)
• Branch committing restrictions
• Conventional commit message checks

These commit checks will run when you make a pull request, in case any are missed locally (or you don't have pre-commit hooks set up)

Setting Up Your Development Environment

Prerequisites

Install the following dependencies if you don't have them already:

• Python 3.13
• uv
• make
• Wine (for building the redirector)

Installation

To set up your development environment, follow these steps:

1. Clone the repository:

   git clone https://github.com/Furglitch/modorganizer2-linux-installer -b rewrite
   cd modorganizer2-linux-installer
   

2. Install pre-commit hooks:

   uv run pre-commit install
   

Running the Application

To run the application, use the following command:

uv run src/mo2-lint/__init__.py

Note: The script may fail if the Redirector and NXM handler is not built. Run a build first to ensure these components are available. To build the application, use:

make _build

To build individual components, use:

make redirector
make nxm-handler
make mo2-lint