kgediya / sparkar-creators

The right place for SparkAR creators from around the globe. Exchange resources on SparkAR, assets, patches and scripts to make your favourite filters for Instagram and Facebook. Create your spark here!

Kicking Off Hacktoberfest with ACM-VIT!

ACM Learn2Augment Mini-Hack Gravitas'20

Registered participants from Learn2Augment will make PRs with their project submissions. All the PRs from the registered participants would be merged. See steps below to make your Pull Request.

Visit the L2A Mini-Hack directory to know more about the hackathon submission

SparkAR Open Repository

All other directories are open to contributions from all SparkAR creators. You are free to download assets, scripts, patches for your own projects and contribute your own proects and resources for the community. Here are necessary guidelines:

Please read the issues and contribute assets, scripts, patches for the projects. Create a new issue if you have something innovative for a new project. Make sure all your assets are compressed to the least size possible

Spark AR Studio supports various file formats, depending on the type of object or asset you're importing.

2D Assets

1. PNG 2. JPEG 3. SVG

3D Models

1. FBX 2014/2015 (binary and ASCII versions) 2. gITF 2 (binary and text versions) 3. COLLADA / DAE 4. OBJ 5. DAE

The following features are supported for 3D models:

1. 3D scene. 2. Materials. 3. Textures. 4. Animations targeting a model's position, rotation and scale.

Audio

1. Mono M4A, with a sampling frequency of 44.1kHz

Fonts

1. TrueType/ OpenType

---

Submitting a Pull Request

• Fork the repository by clicking the fork button on top right corner of the page
• Clone the target repository. To clone, click on the clone button and copy the https address. Then run

git clone [HTTPS-ADDRESS]

• Go to the cloned directory by running

cd [NAME-OF-REPO]

• Create a new branch. Use

 git checkout -b [YOUR-BRANCH-NAME]

• Make your changes to the code. Add changes to your branch by using

git add .

• Commit the chanes by executing

git commit -m "your msg"

• Push to remote. To do this, run

git push origin [YOUR-BRANCH-NAME]

• Create a pull request. Go to the target repository and click on the "Compare & pull request" button.
  • For L2A participants - make sure your PR title follows the format L2A Submission - (name)
  • For General PRs - PR title should be the filter you made
• Wait for your request to be accepted.

---

Guidelines for Pull Request

• Avoid pull requests that :
  • are automated or scripted
  • that are plagarized from someone else's branch
• Do not spam
• Project maintainer's decision on validity of PR is final.

For additional guidelines, refer to participation rules

---

Overview

1. For L2A, download SparkAR for Windows and MacOS (here)[https://sparkar.facebook.com/ar-studio/download/]
2. Refer to the documentation to explore more about (SparkAR)[https://sparkar.facebook.com/ar-studio/learn/]
3. Visit the SparkAR (Blog)[https://sparkar.facebook.com/blog/]
4. Manage your effects through the (SparkAR_HUB)[https://www.facebook.com/sparkarhub/]
5. Visit the community (forum)[https://sparkar.facebook.com/forum/]

---

Usage

Lets get started!

git remote add
git fetch
git merge

---

Authors

Authors: Elio, Shovin, Eesha

Contributors: