This repository contains the config files for Droidian Installer devices.
Devices are configured using YAML files following the schema specifcation in the ./v2/devices directory.
If you want to propose changes to the structure or propose a new action, open an issue. Device-specific installation issues should be filed directly against the Droidian Installer's repository.
If you want to add a or improve a device, run npm run build && npm run validate to make sure your file follows the specification and npm run lint to make it pretty. You can use npm run checksemver to validate semver strings and npm run checkdownloads to make sure all files download successfully. If you modify any specifications, use npm run test to run specification validation tests.
You can use your local config file with the Droidian Installer by supplying the --file or -f flag:
droidian-installer -f ./path/to/config.yml
Install using npm i droidian-installer-configs.
import validate from "droidian-installer-configs";
validate(object); // will return true or falseTypeScript Types for the config file schema are exported as UBportsInstallerConfig.
import { validate, UBportsInstallerConfig } from "droidian-installer-configs";
validate(object as UBportsInstallerConfig);Original development by Johannah Sprinz. Copyright (C) 2019-2022 UBports Foundation. Copyright (C) 2023 Erik Inkinen [email protected]
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.