Code Monkey home page Code Monkey logo

jamlicensetracker's Introduction

JamLicenseTracker plugin for Unreal Engine

This plugin helps assist in tracking the source of assets used under license.

Quick Start and Usage

It's easy to get up and running:

  • Download the JamLicenseTracker plugin source from this page (click Clone or download -> Download ZIP).

  • Unzip the files into a new JamLicenseTracker sub-folder under your project's Plugins folder. It should end up looking like "/MyProject/Plugins/JamLicenseTracker/"

  • Rebuild your C++ project. The new plugin will be compiled too!

  • Load the editor.

  • You will get two message log notifications about project settings that need to be updated. Accept the actions offered, which will update your DefaultGame.ini

  • Select some assets you want to annotate with a source in the Content Browser.

  • Expand the Asset Actions submenu and enter a value in the Source URL entry.

EnteringSourceURL

  • You can also create a data asset of type UJamAssetLicense (New Asset .. Miscellaneous .. Data Asset, pick JamAssetLicense) in order to create an association between an asset source URL and actual license text (e.g., the CC-BY attribution required for those assets).

EditingLicense

  • You can select the assets that share the same source via the context menu on the license asset you created:

LicenseMenuOptions

Plugin Details

Implementation Details

The menu options store the source URL in package metadata (in a key named "AssetSourceURL"), which is in turn specified as metadata to be copied into the asset registry via project settings.

This allows the plugin to find other assets from the same source even when those assets are unloaded.

Known Issues

The runtime harvesting of licenses that survived cooking is not implemented yet. See the @TODO in JamLicenseTrackerEditorModule.cpp

Compatibility

This plugin requires Visual Studio and either a C++ code project or the full Unreal Engine source code from GitHub.

The plugin has only been tested on Windows with Visual Studio 2022 and the 5.0.1 release of UE, although it should be portable to other platforms and future versions of Unreal Engine.

Support

This plugin should be considered 'jam-quality' code, it hasn't been battle tested in production.

Feel free to file an issue, submit a pull request, or catch me on Twitter, but there is no expectation or guarantee of any future development or fixes.

jamlicensetracker's People

Contributors

joatski avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  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.