swell - A flash animation tracker

Swell (stylised as "Swell" or "swell" ) is a flash animation tracker. It tracks and displays statistics of your animation while you're animating in Adobe Flash.

Swell gets out of your way by running in the background, tracking changes made to your existing Adobe Flash (.FLA) file and saving these changes in a local database.

Swell is useful for creating graphs or a timeline of your animation progress. Have multiple Flash projects? Swell can handle it.

Technically, Swell is written in Go to be a portable, tiny single binary, being able to run on Windows and Mac. The data swell saves is available in a JSON format and can be accessed through a REST API. In the near future, swell will be able to export a report of your stats to multiple formats including:

.csv
.pdf
.json
.txt
.md
and .html

Swell was made out of frustration over the fact that I needed a way to track how long I was really taking just to create a single flash cartoon. And to show this in a nicely formatted report to people who are interested in the evolution of a flash project from start to finish.

quickstart

This guide assumes you have read the requirements.

Take a look at the 5 step installation.

Then take a look at the usage page.

docs

Requirements

Installation

Usage

Advanced topics:

Configuration & Commands

Building

bugs

If you find any bugs please file an issue on GitHub.

license

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

See LICENSE for the full license text.

contributing

Would like to contribute to swell? contributions are welcome! Please look at TODO.md to see what needs to be done.

Please DO NOT commit directly to the master branch, instead work on your own branch, commit changes and then pull request.

If there is a small typo or whatever, please mark your branch as hotfix-name_of_fix

Feature requests are welcome.

colophon

The inspiration for the name 'Swell' is based on a phrase used by the late (but great) animator Edd Gould, creator of the web flash cartoon Eddsworld.

"it's pretty swell." - Edd Gould (Eddsworld)

credits

Edd Gould for *Eddsworld

Edd logo by Paul Ter Voorde

(Note: 'Swell' is *NOT affiliated to, or endorsed by the show 'Eddsworld')