Introduction

This page aims at giving a broad presentation of the tool and of the contents of this documentation, so that you know where to start if you are a beginner or where to look if you need info on a specific feature.

Why .Guacamole

Unity provides it’s own implementation for writing editor code, that is completely fine to use for small scale projects. When you start to build more complex applications with Unity’s provided GUI classes, you will quickly find that your applications become difficult to manage and maintain. One of our biggest grievances with Unity’s codebase in general is that it’s quite hard to test.

.Guacamole tries to alleviate these problems by introducing the following concepts to Unity Developers.

  • Strict separation of concerns brought through Data-Binding and MVVM.
  • A flexible, extensible View Framework, with more customisation options.
  • An automation framework, allowing users to writing descriptive tests, mimicking user interaction.

About the documentation

This documentation is continuously written, corrected, edited and revamped by members of the .Guacamole team and community. It is edited via text files in the reStructuredText markup language and then compiled into a static website/offline document using the open source Sphinx and ReadTheDocs tools.

Note

You can contribute to .Guacamole’s documentation by opening issues through YouTrack or sending patches via pull requests on its GitHub source repository.

Organisation of the documentation

This documentation is organised in five sections, the way it is split up should be relatively intuitive:

  • The General section contains this introduction as well as general information on the tool It also contains the Frequently asked questions.
  • The Getting Started section is the the first entry point of this documentation, as it contains all the necessary information on using the tool. It starts with the Step by step tutorial which should be the entry point for all new users.
  • The Fundamentals section is required reading for anyone intending to use .Guacamole, as it contains all the necessary information on using the library. Read this section for an overview of the main concepts used in .Guacamole.
  • The Views and Layouts sections go over every view and layout included with .Guacamole.
  • The Automation section is optional reading, but goes over the automation of your application. This is incredibly useful for anyone that wants to test their end product in a real world environment.
  • Finally, the Class API reference is the documentation of the .Profile API. It is generated automatically from a files in the main repository, and the generated files of the documentation are therefore not meant to be modified.