# OmsiLaunch

> OmsiLaunch — an open-source session control and orchestration layer for OMSI 2.

- Canonical page: https://omsilaunch.omsimods.com.br/en-gb/
- Language: English (UK) (`en-GB`)
- Source repository: https://github.com/OmsiModsBR/OmsiLaunch
- Documentation: https://omsilaunch.omsimods.com.br/en-gb/docs/
- License: GNU LGPL v3 (LGPL-3.0-only)

## Integration starts here.

OmsiLaunch is an open-source session control and orchestration layer for OMSI 2.

A flexible infrastructure for defining, preparing and managing OMSI 2 sessions with more possibilities.

- Explore the project: #visao-geral
- Download beta: #download

### WHO IT IS FOR

## For players, creators and developers.

- **For players:** Play without the hassle. Use a shortcut to open a ready-made session, with no terminal or manual changes. Players can enjoy the result without interacting directly with OmsiLaunch.
- **For creators:** Ready-made profiles to share. Create and distribute Predefined Session Profiles with their own settings, presets and assets for maps, tools and other content.
- **For developers:** Integrate and automate. Use the CLI, DLL/API, launchers, external tools, multiplayer and automation to control sessions with your existing infrastructure.

### PREDEFINED SESSION PROFILES

## Session profiles for every need.

Predefined Session Profiles let you save and reuse complete sets of settings, add-ons and adjustments, making it easier to create and share experiences.

Each profile can include splash-screen assets and set policies for the use of internet textures during the session.

### RMG Leste map, by Wesley Sampaio

RMG Leste is a map coming soon, which already includes Predefined Session Profiles to make different setups and experiences easy from day one.

- Map page: https://omsimods.com.br/mapa-rmg-leste/

Available profiles:

1. **Low-end PC:** Lightweight setup, ideal for modest machines.
2. **Mid-range PC:** A balance between quality and performance.
3. **High-end PC:** Maximum quality for the best experience.

Usage example (command line):

```
OmsiLaunchW.exe \
/predefined-profile:rmg-leste \
/predefined-profile-index:1 \
/new
```

Simple, direct and powerful. The same profile can be used from a shortcut or from your own application.

### WHAT IS OMSILAUNCH

## RUNTIME MODULES

### Extensions that live inside the session.

Runtime Modules are optional components that OmsiLaunch loads together with an OMSI 2 session. Each module describes in a manifest what it does and what it needs, and follows the session lifecycle.

- **Optional and described:** Each module comes with a manifest that says what it does, what it needs and how to configure it.
- **Tied to the session:** Activation and settings can come from a profile or the command line, session by session.
- **Failure under control:** Each module defines what happens if it fails: end the session, disable the module or carry on without it.

The first example will be **openHUD**, planned for the next betas. [Read the concept in the documentation.](https://omsilaunch.omsimods.com.br/en-gb/docs/reference/runtime-modules/)

![Collage of openHUD screens: pause menu, mini-map and map with line data inside OMSI 2](https://omsilaunch.omsimods.com.br/assets/img/openhud-collage.webp)

openHUD preview, in development: a new pause menu, a mini-map and the full map with line data, compatible with [openOMSI map packages](https://omsimods.com.br/map-package-creator-openomsi/). [RMG Leste map, by Wesley Sampaio](https://omsimods.com.br/mapa-rmg-leste/).

## A control layer for OMSI 2 sessions.

OmsiLaunch is an open-source control and orchestration layer designed for OMSI 2. It integrates tools, manages processes, handles configuration and prepares the environment for a consistent, flexible experience.

It is not a graphical launcher. OmsiLaunch can be used by your own interface, scripts, or integrations. Control is the core. Flexibility is the goal.

- **Open source:** Built for the community.
- **Modular and extensible:** Works with different tools and workflows.
- **More than starting the game:** A complete session-orchestration layer.
- **Built for possibilities:** For what exists today — and what comes next.

> Endless possibilities.

## CORE CAPABILITIES

### Session definition

Define the map, entry point, situation, date, time, vehicle and other parameters in a structured way.

### Controlled start-up

Prepare the state and start OMSI 2 without relying on UI click automation.

### Transparent execution

Run through OmsiLaunchW.exe, shortcuts, launchers or applications with no visible terminal.

### Predefined sessions

Predefined Session Profiles and shareable presets for community content.

### Safe configuration

Temporary changes tied to the session, preserving and restoring the environment through the transactional lifecycle.

### Recovery and reliability

Diagnostics, lifecycle, recovery and failure handling are part of the session design.

## ARCHITECTURE AND FLOW

### Connecting tools, people and the game.

OmsiLaunch is designed to be an integration point between different ways of using it, serving everyone from players to developers.

- **API / DLL / CLI:** Custom integrations and tools
- **Session Profiles:** Predefined, shared profiles
- **Shortcuts / Launchers:** Direct use, no terminal

### OmsiLaunch / OmsiLaunchW

Prepares, configures and orchestrates the session

### OMSI 2

- Maps
- Situations
- Vehicles
- Configurations
- Process

## OPEN SOURCE. FOR THE COMMUNITY

### Public beta available now.

OmsiLaunch is an open-source project, developed for the community. The latest public version is available to download and test.

- **Open source (LGPL):** Open code, under the LGPL licence.
- **Constantly evolving:** New features and improvements based on community feedback.
- **Join the development:** Report problems, suggest ideas and contribute on GitHub.

Current version: 0.1.x beta (public beta)

- Repository: https://github.com/OmsiModsBR/OmsiLaunch
- Releases: https://github.com/OmsiModsBR/OmsiLaunch/releases