converter/readme.md

91 lines
3.0 KiB
Markdown
Raw Normal View History

2018-12-23 22:26:44 +01:00
UUP converter
-------------
### Description
A basic UUP converter aimed at Linux and macOS users who don't have access to any
2018-12-26 00:53:50 +01:00
Windows machine, but want or need to create an ISO image for latest Windows
2018-12-23 22:26:44 +01:00
Insider version downloaded from UUP dump.
2021-03-11 08:47:34 +01:00
**For obvious reasons this script will never support integration of Cumulative
Updates to created images.**
2018-12-26 00:53:50 +01:00
2018-12-23 22:26:44 +01:00
### Usage
```
2019-05-02 01:31:08 +02:00
./convert.sh [compression] [uups_directory] [create_virtual_editions]
2018-12-23 22:26:44 +01:00
```
2019-05-02 01:31:08 +02:00
###### compression options:
* wim - standard wim compression (`/Compress:max` in DISM) (default)
* esd - solid esd compression (`/Compress:recovery` in DISM)
2018-12-23 22:26:44 +01:00
2019-05-02 01:31:08 +02:00
###### create_virtual_editions options:
* 0 - do not create virtual editions (default)
* 1 - create virtual edtitions
2018-12-23 22:26:44 +01:00
### Usage examples
2018-12-26 00:53:50 +01:00
* `./convert.sh` - starts the conversion using files from `UUPs` directory and
creates an ISO image with `install.wim`
2018-12-23 22:26:44 +01:00
2018-12-26 00:53:50 +01:00
* `./convert.sh esd` - starts the conversion using files from `UUPs` directory
and creates an ISO image with `install.esd`
2018-12-23 22:26:44 +01:00
2018-12-26 00:53:50 +01:00
* `./convert.sh wim MyUUP` - starts the conversion using files from `MyUUP`
directory and creates an ISO image with `install.wim`
2018-12-23 22:26:44 +01:00
2019-05-02 01:31:08 +02:00
* `./convert.sh wim MyUUP 1` - starts the conversion using files from `MyUUP`
directory, creates virtual editions and creates an ISO image with
`install.wim`
### Virtual editions
Since version 0.5.0 this script supports creation of virtual editions.
To run creation of all virtial editions simply use create_virtual_editions
switch in command line. If you want to customize which editions will be created
when this switch is set, please use VIRTUAL_EDITIONS_LIST in configuration file.
Virtual editions creation can be only done when convert_ve_plugin is present in
the same directory as converter.
2019-05-02 02:15:51 +02:00
Thanks to abbodi1406 for providing informations which helped with creating this
2019-05-02 01:31:08 +02:00
option.
### Configuration file
Configuration of advanced script options can be modified using
the file `convert_config_linux` (on Linux) or `convert_config_macos` (on macOS).
2019-05-02 01:31:08 +02:00
###### Configuration options
```
VIRTUAL_EDITIONS_LIST='space delimited editions sequence'
```
###### Configuration options explanation
* VIRTUAL_EDITIONS_LIST - configures which editions will be created when
create_virtual_editions is enabled.
2018-12-23 22:26:44 +01:00
### Requirements
This script uses the following commands to do its work:
* cabextract - to extract cabs
* wimlib-imagex - to export files from metadata ESD
* chntpw - to modify registry of first index of boot.wim
* genisoimage or mkisofs - to create ISO image
2018-12-23 22:26:44 +01:00
###### Linux
2018-12-26 00:53:50 +01:00
If you use Debian or Ubuntu based distribution you can quickly install these
using the following command:
2018-12-23 22:26:44 +01:00
```bash
sudo apt-get install cabextract wimtools chntpw genisoimage
2018-12-23 22:26:44 +01:00
```
2018-12-26 00:53:50 +01:00
If you use any other distribution, then you will need to check its repository
for packages needed to run this script.
###### macOS
macOS requires [Homebrew](https://brew.sh) to install the prerequisite software.
After Homebrew was installed, you can install the requirements using:
```bash
brew tap sidneys/homebrew
brew install cabextract wimlib cdrtools sidneys/homebrew/chntpw
```