Metadata-Version: 2.1
Name: xflsvg
Version: 0.1.2
Summary: A tool for working with XFL/XflSvg data.
Home-page: https://github.com/synthbot-anon/synthanim
Author: Synthbot
Author-email: synthbot.anon@gmail.com
License: Copyright 2021 Synthbot
        
        You may only use this project to process publicly-available data. You may not
        use this project to process private or proprietary data. This applies even if
        you are a student or an academic researcher. You may modify any part of this
        project arbitrarily EXCEPT:
        
            - This license.
            - Any file explicitly marked as unmodifiable under the license.
            - Any line of code explicitly marked with the comment "DO NOT MODIFY".
        
        If you use this project to process non-public data, you must make the data
        publicly available within 30 days of execution, and you must inform
        synthbot.anon@gmail.com with details on how to download the data.
        
        For exceptions to this license, please contact synthbot.anon@gmail.com.
        
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Description-Content-Type: text/x-rst


This library is part of the Pony Preservation Project. It is designed to
support the development of 2D animation AI. It has three main functions:

    - Support to creation for SVG spritemaps for XFL files. Since there's no
      publicly-known way to render Adobe's Edge format, this library assumes
      that Adobe Animate is required to render shape objects. The XflSvgRecorder
      class simplifies the process by exporting (1) a simplified XFL file
      containing a single symbol, whose frames contain all of the shapes in the
      parent XFL files, and (2) a JSON object mapping parent XFL shapes to their
      location in the simplified XFL file.
    - Convert XFL files and exported SVG shapes (xflsvg files) into a tabular
      data format. The tabular data will eventually contain ALL data necessary
      to fully recreate the original animation, and the data will be
      hierarchically structured to match the original XFL file. This is done
      using the XflSvgRecorder class's to_json() and to_xfl() methods.
    - Render tabular animation data. The tabular data may be exported from
      existing xflsvg files, or they may be programmatically generated. This
      is done using the XflSvgRenderer class.

This project is currently in an early stage. The xflsvg format will change
over time as we identify exactly what XFL data is necessary to recreate
animations, as will the rendering code.

If you're using pip to install xflsvg, you'll need to install cairocffi
and cairosvg to use XflSvgRenderer. If you're using conda to install xflsvg,
both will be automatically installed. Note that pip doesn't seem to install
cairocffi properly.


