Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/voldien/umultitargetbuilder

Unity 3D Multi Platform Builder Configuration Project Tool
https://github.com/voldien/umultitargetbuilder

builder multiple-platform unity-package unity-package-manager unity-tool unity3d upm-package

Last synced: 2 months ago
JSON representation

Unity 3D Multi Platform Builder Configuration Project Tool

Host: GitHub
URL: https://github.com/voldien/umultitargetbuilder
Owner: voldien
License: gpl-3.0
Created: 2020-05-05T15:21:57.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-02-10T07:38:04.000Z (almost 2 years ago)
Last Synced: 2024-09-23T11:31:41.047Z (3 months ago)
Topics: builder, multiple-platform, unity-package, unity-package-manager, unity-tool, unity3d, upm-package
Language: C#
Homepage:
Size: 734 KB
Stars: 46
Watchers: 4
Forks: 3
Open Issues: 6
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # Multiable Buildable Target Configuration Tool

[![openupm](https://img.shields.io/npm/v/com.linuxsenpai.multitargetbuilder?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.linuxsenpai.multitargetbuilder/)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

[![GitHub release](https://img.shields.io/github/release/voldien/UMultiTargetBuilder.svg)](https://github.com/voldien/UMultiTargetBuilder/releases)

A Unity Provider setting tool that supports adding multiple build targets with different configurations for multiple platforms. All the targets can be built with a single button and written to their specified directories specified in their respective target settings. It allows for less time being spent on switching between build platforms. Furthermore, All the settings export and imported onto other projects easily.

# Features

- Multiple configurable build targets.

- Overridable Scene List for individual build targets.

- Run targets from the editor.

- Import/Export configuration settings.

Table of Contents

=================

- [Multiable Buildable Target Configuration Tool](#multiable-buildable-target-configuration-tool)

- [Features](#features)

- [Table of Contents](#table-of-contents)

- [Installation](#installation)

    - [Simple Download](#simple-download)

    - [Unity Package Manager (UPM)](#unity-package-manager-upm)

    - [OpenUPM](#openupm)

- [Quick Start](#quick-start)

  - [Open up the Configuration Window](#open-up-the-configuration-window)

  - [Fresh Configuration](#fresh-configuration)

  - [Additional Targets](#additional-targets)

  - [Configuration Target](#configuration-target)

  - [Override Scenes](#override-scenes)

  - [Run from Editor](#run-from-editor)

  - [Export/Import Settings](#exportimport-settings)

  - [Build](#build)

  - [Server/ Command Line Build Feature](#server-command-line-build-feature)

  - [Resources](#resources)

  - [Note](#note)

  - [Contributing](#contributing)

  - [Donations](#donations)

  - [License](#license)

# Installation

### Simple Download

[Latest Unity Packages](../../releases/latest)

### Unity Package Manager (UPM)

> You will need to have git installed and set in your system PATH.

Find `Packages/manifest.json` in your project and add the following:

```json

{

  "dependencies": {

    "com.linuxsenpai.multitargetbuilder": "https://github.com/voldien/UMultiTargetBuilder.git#0.1.6",

    "...": "..."

  }

}

```

### OpenUPM

Install the package with [OpenUPM](https://openupm.com/) through the commandline

```sh

# Install openupm-cli

$ npm install -g openupm-cli

# Enter your unity project folder

$ cd YOUR_UNITY_PROJECT_FOLDER

# Add package to your project

$ openupm add com.linuxsenpai.multitargetbuilder

```

# Quick Start

## Open up the Configuration Window

The configuration window can be found in the project settings window, under the *MultiTarget Build Settings* tab.

![image](images/open_project_settings.png)

## Fresh Configuration

The first thing on a fresh configuration is to create a target.  After the first target, all the other configuration UI will be presented and visible for configuration.

![image](images/add_first_target.png)

## Additional Targets

Adding a target can be done as an empty new target or copy the currently selected target. The name is only used in the project and will not be the title. There is a dedicated field for setting the title for the target.

![image](images/adding_targets.png)

## Configuration Target

In the target configuration window. The meta-information, build settings, and scenes settings can be configured. 

![image](images/target_configuration.png)

## Override Scenes

On a selected *build target*, unchecking the Use default scene will enable the configuration list. From there adding and removing scenes can be performed.

![image](images/override_scene_for_target.png)

## Run from Editor

Currently on the target with its platform that matches the host target platform can be run with success from the editor directly.

## Export/Import Settings

The settings can be export and import. Thus making it possible to use the settings across the project with the exception of the scene override that is dependent on the current project.

![image](images/import_export.png)

## Build

The tool support for building individual build target as well all the targets that are enabled. Furthermore, both support script only to build only the script.

## Server/ Command Line Build Feature

The target configurations can be build from using the command line. Where the build script [build.sh](build.sh) can be used. This allows for the game to be built in a headless Unity 3D or the original intent on a server for rapid builds.

However, note that this script is a UNIX shell script and thus only supports Unix based system Linux. See the following example. It requires a path to the unity program as the first argument. The second the path to the root directory of the project. Finally, the *-f* argument is the mode

```

build.sh /path/unity/Editor/Unity /path/project-directory -f

```

All the additional argument after the three-argument is required to be valid a *Unity 3D* command-line arguments. For instance, using the -quit argument is a valid appended command-line option.

```

build.sh /path/unity/Editor/Unity /path/project-directory -f -quit

```

## Resources

Quick Video of the main functionalities: [Video](https://www.youtube.com/watch?v=F8CBExsLApk)

A Comprehensive guide: *Still work in progress*.

## Note

It is designed to handle the common build target such as Windows, Linux, Android, iPhone and Mac OS-X. However, it has only been currently been manually tested for Windows, Linux, and Android. But, this should be work just fine since all the internal logic is handle by the Unity engine. 

## Contributing

If you have any idea, feel inclined to fork it and submit your changes back to me.

## Donations

The project was originally intended to be put on the Unity asset store. However, it was decided to make it free instead. If you find this tool useful consider making a donation.

[![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=R35V8EE62CBDL&source=url)

## License

This project is licensed under the GPL+3 License - see the [LICENSE](LICENSE) file for details