Giter VIP home page Giter VIP logo

pandority's Introduction

Pandority

Roslyn source generators for Unity projects:

Requirements

To use

  • Unity 2021.3 or newer

To develop

Setup

Install the package to your Unity project.

The package comes with a Unity AssetPostprocessor which automatically configures the Pandority.dll importer. As a "bonus" feature, it will also apply the correct settings to any DLL whose name ends with SourceGenerator.dll.

Troubleshooting

If you encounter issue during setup, consult the Unity documentation

If the source generator fails to produce output, check for a crash log in these locations:

Operating System Log File Location
macOS ~/Library/Logs/Pandority
Windows %LOCALAPPDATA%\Pandority
Linux ~/.config/Pandority

Script Utilities

The following log helper can be run as a shell script in a bash interpreter:

sh ./open-log.sh opens the log file directory.

sh ./open-log.sh <file> opens the log with the file name.

If a file is not found, the log directory will be opened instead. In cases where the log directory does not exist, the script will print its path.

To enable debug logs, refer to the Development section for instructions.

Development

Open the SourceGeneratorProject directory in your IDE to modify the source generator. Review the contents of the .csproj file to see the configuration and build process details.

Run nuget restore to install the required NuGet packages.

Run dotnet build --configuration Release to produce an optimized DLL that will be automatically copied to the Unity package directory.

Run dotnet build to build a debug version with logging enabled.

A new release of the generator should always be built with the release configuration for performance reasons.

Debug Logging

To enable more detailed logging beyond the always-enabled crash log, set the solution configuration to Debug and rebuild the project.

Running Unit Tests

Run dotnet test to execute the unit tests. The test project uses xUnit and NET 6.0.

pandority's People

Contributors

chrisyarbrough avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.