๐ผ๏ธ Wallpapers App
๐ Overview
The Wallpapers app fetches images from the Pexels API, which provides access to over 4.5 million high-quality images, illustrations, and vectors. To use this feature, you'll need to obtain a free API key from Pexels.
๐ Getting Your Pexels API Key
Step 1: Create a Pexels Account
- Visit Pexels.com
- Sign up using your email or social media/google accounts.
- Verify your email address if required.
Step 2: Access the API Documentation
- Once logged in, go to Pexels API Form
- Fill in the form and Confirm
Step 3: Get Your API Key
- On the next page, you'll see your API key displayed
- It will look something like:
twP5l3YSdChS27hMOTdTMgW7Pkv0e25idvSnj1oPC3nh2Wlttz91AfW5 - Copy this key - you'll need it for the next step
โ๏ธ Server Configuration
Using server.cfg (Recommended)
Add the following line to your server.cfg file:
Code# Pexels API Key for YSeries Wallpapers App set yseriesPexelsApiKey "YOUR_API_KEY_HERE"
Example:
Codeset yseriesPexelsApiKey "twP5l3YSdChS27hMOTdTMgW7Pkv0e25idvSnj1oPC3nh2Wlttz91AfW5"
๐งช Testing the Setup
- Start your server with the new configuration
- Join the server and open the YSeries phone
- Navigate to the Wallpapers app
- Check if images load - you should see wallpapers
- Test search functionality by searching for different terms
๐จ Troubleshooting
Common Issues:
โ No images loading / "API Key Missing" error
- Verify your API key is correctly set in
server.cfg - Ensure there are no extra spaces or quotes in the convar
- Restart your server after making changes
โ "Rate Limited" error
- Pexels free accounts have rate limits (200 requests/hour)
- Wait for the rate limit to reset or consider upgrading your Pexels account
โ Images load but downloads fail
- Check server console for error messages
- Ensure the server has internet connectivity
- Verify write permissions for the resource directory
๐ API Limits
Free Account Limits:
- 200 API requests per hour
- Access to all image types (photos, illustrations, vectors)
- We have added caching to reduce the number of direct requests to the API.
Rate Limit Information:
- Limits reset every hour
- The app will show appropriate error messages when limits are exceeded
๐จ App Features
Once properly configured, the Wallpapers app provides:
- Browse by categories (Nature, Architecture, Abstract, Cars, etc.)
- Search functionality with real-time results
- High-quality image previews
- Set as wallpaper (lock screen, home screen, or both)
- Download images to device storage
- Infinite scroll for seamless browsing
- Author attribution for all images
๐ Support
If you encounter issues:
- Check server console for error messages
- Verify API key format
- Test with a fresh API key from Pexels