Skip to content

Commit 9da829b

Browse files
committed
Add Lens Creator Guide
1 parent 94044a9 commit 9da829b

File tree

1 file changed

+87
-0
lines changed

1 file changed

+87
-0
lines changed

docs/CREATOR_GUIDE.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# 🎨 Lens Creator Guide
2+
## 1. Preparing Snap Camera Server
3+
### 1.1. Create Snap Developer Account
4+
1. Go to: https://my-lenses.snapchat.com/camera-kit
5+
2. Log-in or Sign-up for a new developer account
6+
7+
![login](https://github.com/user-attachments/assets/4da8117b-68f8-4c6d-b60d-7ddc6e2c3b32)
8+
9+
### 1.2. Create a new Web App
10+
1. Navigate to the **Apps** section
11+
2. Click on the **Enable App** button
12+
13+
![apps](https://github.com/user-attachments/assets/f32ee22c-8268-4aa2-8283-2ce2231daa05)
14+
15+
1. Click the **Select App** dropdown box
16+
2. Choose <u>**+ Create App**</u>
17+
18+
![create-new-app](https://github.com/user-attachments/assets/c3c1097a-6331-4688-ba7b-4397d159f263)
19+
20+
1. Pick any name for your web app
21+
2. Select **Web** as your target platform
22+
23+
![new-app](https://github.com/user-attachments/assets/dd243619-1f8d-45dd-8a39-cdb5e7b8df67)
24+
25+
1. Confirm your app in the next step by ticking the checkboxes
26+
2. Click the **Enable** button
27+
28+
![select-app](https://github.com/user-attachments/assets/969b8a11-53f9-4d97-a30b-9d9ca18421dd)
29+
30+
Your app will be created and you will be redirected to the overview page
31+
32+
![your-app](https://github.com/user-attachments/assets/aeb7342c-8519-4797-a62c-b0fe968ec3b3)
33+
34+
### 1.3. Copy and pase API Token
35+
Now you need to copy your **API Token**
36+
37+
![copy-api-token](https://github.com/user-attachments/assets/ffde2dfb-dd45-4ae4-b0ac-d627553b99a8)
38+
39+
And paste the string to `BRIDGE_API_TOKEN` in your `.env` file
40+
41+
```.env
42+
###########################
43+
# For Lens Creators
44+
###########################
45+
# Lens creators require an official API token in order to access their own lenses
46+
#
47+
# Get your own API token at:
48+
# https://my-lenses.snapchat.com/camera-kit
49+
#
50+
# 1. Sign-in/Register
51+
# 2. Create a new 'Web App'
52+
# 3. Copy&Paste 'Production API Token' below
53+
#
54+
BRIDGE_API_TOKEN=
55+
```
56+
57+
### 1.4. Start Snap Camera Server in Creator Mode
58+
You can now start the Docker Server with:
59+
```shell
60+
docker compose --profile creator up
61+
```
62+
63+
This will load and start an additonal Docker container to import Lenses from your Snapchat account.
64+
You should run the command above only if you want to import new Lenses .
65+
Once you activate your Lenses inside Snap Camera, they are fully imported.
66+
67+
## 2. Organize your lenses in Groups
68+
### 2.1. Lens Scheduler
69+
You must group your lenses together with the **Lens Scheduler**
70+
71+
![lens groups](https://github.com/user-attachments/assets/c6640e4f-247f-4b44-9ae1-006d6b9e1f78)
72+
73+
You can create a **New Lens Group** and add multiple or single Lenses to them.
74+
If your Lenses are not showing up for selection you might have to put them in **Lens Folders** first.
75+
After putting them in **Folders** you can add the folders under the **Lens Sources** tab.
76+
77+
## 3. Using your grouped lenses with Snap Camera
78+
### 3.1. Copy and paste the Lens Group ID
79+
80+
Clicking on any **Lens Group** will enable you to view and copy the **Lens Group ID**
81+
82+
![lens-group-ids](https://github.com/user-attachments/assets/712469c9-9f25-45ca-ad93-f687d98b812c)
83+
84+
If you set up the API Token in your .env file as described in 1.3
85+
And started Snap Camera Server as described under 1.4
86+
You should now be able to paste the **Lens Group ID** into the search bar of your Snap Camera application.
87+

0 commit comments

Comments
 (0)