blobfox/README.md

# Blob foxes emotes repository

A repository containing the "blobfox" emotes, [originally made by Feuerfuchs](https://web.archive.org/web/20211115174913/https://www.feuerfuchs.dev/en/projects/blobfox-emojis/)
and released under the Apache 2.0 license.
<!-- TODO: find new link+email for feuerfuchs -->
Work was initially made [on a public archive](https://git.lambdaurora.dev/lambdaurora/diverse_archive) to vectorized some of the blobfoxes,
but as more variants were created, the project needed a new, dedicated place to reside.

This repository also contains additional blobfoxes, blobcats and other blob animal characters, which are all made available under the Apache 2.0 license.

The goal of this project is to vectorize the entire set of blobfoxes.
Automation is key for that, and a solution that can generate clean (both in terms of readability and visual accuracy) results with minimal tweaking will have to be built.

If you enjoy this project, then come say hi here:

- [subreddit dedicated to this project](https://reddit.com/r/blobfox)

## Installation and usage

*TODO :)*

## Definitions

Part - A list of svg elements that make up a part

Design - A list of Parts that make up a final output

## How to help

If you'd like to help, there are a few things that need attention outside of implementing features:

- `TODO`s around the code (currently in the `feat/template` branch)
- vectorize high-value emotes (emotes which contain assets not present in others);
    the usual procedure is to copy the `blobfox.svg` file and to edit away, making sure not to move the body around
- draw base emotes for other species:
  - raccoon
  - doberman
  - german shepherd
  - collie
  - sheep
  - bird
  - etc.
- clean up the SVG for the existing emotes (the `clean` binary in `feat/template` is meant to do the heavy-lifting)

### TODO

- snuggles
- husky
- stella
- amber
- reach

## License

All the code, images and assets of this repository are made available under the Apache 2.0 license.
See [LICENSE.txt](LICENSE.txt) for more information.

For simplicity, the authors of the different parts of this project have been grouped together under the "blobfox team", which contains but is not limited to:

- Feuerfuchs: [original website (down as of writing)](https://feuerfuchs.dev/), [archive](https://web.archive.org/web/20211115174913/https://www.feuerfuchs.dev/en/projects/blobfox-emojis/)
- [LambdAurora](https://git.lambdaurora.dev/lambdaurora/), hosts [a mirror](https://git.lambdaurora.dev/lambdaurora/blobfox)
- [Shad Amethyst](https://git.shadamethyst.xyz/adri326/)
- Lost Quasar
<!-- Add yourself here as you please :) -->
<!-- If we get more people, then we can create a CONTRIBUTORS.txt file -->

## Contributing

Any contribution to the [original repository of this project](https://git.shadamethyst.xyz/adri326/blobfox) must be made available under the [license of this project](./LICENSE.txt).

This means that:

- You must either be the author of the code/asset/image you wish to contribute, or have been given explicit permission by the original author to contribute it here.
- Assets and images must be released under the Apache 2.0 license
- If a contribution is derived from an asset or image, then this asset must also be released under the Apache 2.0 license
- Ideally, contributions should contain a list of contributors, so that these can be added to the list of contributors

For svg files, please include the [svg-default-metadata.xml](credits.svg) file in the svg file (and complete the blank fields).

Don't hesitate to open an issue if you are unsure about any of the above points!