DOCSEARCHbyAlgolia
Submit Docs

FlexCompiler

website·Indexed 31 days ago

https://compiler.flexframework.net

A Unity 3D editor extension designed to streamline the development process for asset publishers and game developers. It provides tools for project management, C# compilation, and a robust extension system allowing for custom symbols, references, visibility changes, and assembly obfuscation. It includes programmatic access via the FlexFramework.FlexCompiler namespace.

Tokens
9.6K
Snippets
38
Records
72
Agent score
51%

What's inside FlexCompiler

  1. Overview of FlexCompiler Extensions

    Extensions in FlexCompiler allow developers to extend the capabilities of the C# compiler. They operate by subscribing to specific job hooks and updating the associated context. Extensions can be enabled/disabled via the extensions panel and reordered via drag-and-drop to resolve execution conflicts within the same hook (executing from top to bottom).

  2. Overview of FlexCompiler for Unity 3D

    FlexCompiler is a Unity 3D editor extension that streamlines the C# compilation process. It allows developers and asset publishers to generate compiled assemblies by adding scripts to the project panel and clicking "Run," removing the manual overhead of assembly management.

  3. Modify type visibility using the Visibility Changer extension

    The Visibility Changer extension modifies syntax trees during the compilation creation hook to change the visibility level of top-level types. It uses a strategy to determine the visibility shift and a target mask to filter which types are affected.

  5. Remove source files from the sources panel

    To remove files or folders from the sources panel:

    1. Select the target entries. Use "Shift" or "Control (Command)" to select multiple items.
    2. Click the "-" button at the bottom-right corner to remove the selection.

    Note: Scripts that are missing from the project are marked with warning icons. These must be removed manually using the "-" button if they are no longer needed.

  6. Add source scripts to FlexCompiler

    Source scripts can be added to the project using two methods:

    1. Sources Tab: Click the "+" button in the sources tab to browse and select scripts.
    2. Drag and Drop: Drag scripts directly from the Unity Project panel into the FlexCompiler sources panel.

    When adding a folder, all nested scripts are included automatically. Note that changes to the folder's contents (adding, deleting, or renaming scripts) are not tracked automatically and require the folder to be re-added. Duplicate scripts are ignored.

  7. Build and Export FlexCompiler projects

    To compile the project, click the 'Run' button at the bottom of the window and monitor the Unity console for the result. To save the project configuration for later use, click 'Export Project' at the bottom-right corner (this option is only available if the sources panel contains at least one script).

  9. Extend FlexCompiler functionality

    FlexCompiler includes an extension system that supports dependency projects and code obfuscation. Developers can create custom compiler extensions directly within the Unity editor to add specialized behavior to the compilation pipeline.

  10. Manage projects in the FlexCompiler GUI

    FlexCompiler provides basic project management via the project window:

    • Create New: A new empty project is automatically created on first launch. To start a new project later, click New Project (bottom-left). Warning: Current unsaved changes will be discarded.
    • Import: Click Import Project (bottom-center) to load an existing .fcxml file. Warning: Current unsaved changes will be discarded.
    • Export/Save: Click Export Project (bottom-right). This is required to persist changes to an imported project or save current work, as edits are only stored in a temporary cache until exported. The export option is only enabled when the sources panel is not empty.

  11. Import legacy project files from version 1.x

    The Legacy Project Importer is a global extension that allows users to load project files created in version 1.x. Once this extension is enabled, the project import dialog will include support for the .fpj file extension.

  12. Manage compilation settings and projects in FlexCompiler

    FlexCompiler provides customizable compiler settings to tailor the compilation process to specific project needs. It includes built-in import and export features to simplify project management within the Unity editor.