openpilot-mod-manager

command module
v0.0.0-...-73d1639 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2022 License: MIT Imports: 2 Imported by: 0

README

Openpilot Mod Manager

Test

Openpilot Mod Manager(OMM) is an Openpilot modding tool for both users and developers. It manipulates source code directly as a text file(instead of using language features) in order to customize behaviors.

Install

Even tho OMM works for every forks, it is recommended to use official branch for dependency tracking.

git clone https://github.com/commaai/openpilot -b v0.8.13

Download and install OMM

curl -fsSL https://github.com/borgmon/openpilot-mod-manager/raw/main/bin/install | sh

Quick Start

Initialize Repo

Go to your openpilot folder and type

omm init

This command will prepare the repo for modding and generate an omm.yml file

Install Mod
omm install https://github.com/borgmon/omm-no-disengage_on_gas

This mod does not exist yet :P

You can checkout all the commands via omm --help or the Wiki.

Developer guide

Developing a mod is very easy. Let's start by making a new directory and type

omm mod init

This will generate your manifest file manifest.yml. This file must be placed in root of your folder

name: omm-my-mod # same as github project name
displayName: my mod
repoURL: https://github.com/myname/omm-my-mod
version: v0.8.13-1.0
publisher: my name
description: my first mod!
dependencies: # planned. not being used right now
  - url: https://github.com/borgmon/some-UI-framework
    version: v0.8.13-18

Full guide is available in the Wiki.

Documentation

Overview

Copyright © 2022 borgmon

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL