https://github.com/sttz/trimmer

An editor, build and player configuration framework for the Unity game engine.
https://github.com/sttz/trimmer

build-automation configuration-management framework unity-game-engine unity3d

Last synced: 28 days ago
JSON representation

An editor, build and player configuration framework for the Unity game engine.

• Host: GitHub
• URL: https://github.com/sttz/trimmer
• Owner: sttz
• License: mit
• Created: 2017-11-22T19:29:15.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-08-25T15:31:59.000Z (4 months ago)
• Last Synced: 2024-10-30T23:03:36.435Z (about 1 month ago)
• Topics: build-automation, configuration-management, framework, unity-game-engine, unity3d
• Language: C#
• Size: 965 KB
• Stars: 104
• Watchers: 6
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - sttz/trimmer - An editor, build and player configuration framework for the Unity game engine. (C\#)
• awesome-unity3d - trimmer - An editor, build and player configuration framework for the Unity game engine. (Open Source Repositories / Build Tools and CI)

README

        


# Trimmer

An editor, build and player configuration framework for the Unity game engine.

### Introduction

Unity supports deploying your projects to dozens of platforms and provides a powerful editor to develop your project. Supporting many platforms becomes complicated very fast and adjusting configuration in builds requires a lot of scaffolding.

Trimmer provides that scaffolding as a flexible framework, that allows to quickly adjust the configuration of your project through its whole lifecycle: In the editor during development, during the build process and in the built player.

Trimmer makes it easy to create Options with a few lines of code. It provides a sensible default baseline but allows complex configurations when you need it.

Trimmer is a non-invasive framework. Instead of having to integrate it into your code, you write small Option adapters that hook your existing systems into Trimmer. Options that are not used are not compiled into builds and when a build doesn't contain any Options, Trimmer removes itself from the build completely. Trimmer also makes it easy to conditionally compile your own code.

In the editor, Trimmer provides a simple GUI interface to configure your Options for when you play your project and for the different builds your project requires. In the player, Trimmer provides optional loading of a configuration file and a in-game prompt that can configure the same Options as in the editor. Using Build Profiles, you can decide which Options are only available in the editor and which can also be configured in a given build.

#### Features

* Write options easily with only a couple lines of code

* Visually edit options in the editor and the player

* Conditionally compile only the features that you need

* Automate building and post-process your scenes during build

* Create and build profiles with different settings and features

### [Full Documentation](https://sttz.ch/trimmer/)

### Screenshots

 

### License

Trimmer is licensed under the MIT license.