A Deno-powered backend service for Plants vs. Zombies: MODDED. This service provides APIs for uploading, downloading, listing, and rating user-created I, Zombie levels.
- Error Responses:
- Code: 400
- Content:
{ "error": "Invalid level ID" } - Code: 400
- Content:
{ "error": "Rating must be 'like' or 'dislike'" } - Code: 404
- Content:
{ "error": "Level not found" } - Code: 400
- Content:
{ "error": "You have already rated this level" } - Code: 500
- Content:
{ "error": "Failed to rate level" }
Note: Captcha verification is not required for rating levels. management (upload, download, listing)
- User tracking and author management
- Rating system for levels
- Content moderation using OpenAI (optional)
- CAPTCHA protection using Cloudflare Turnstile (optional, only required for level uploading)
- SSL support for secure connections
- CORS configuration for frontend integration
- Clone the repository
- Copy
.env.exampleto.envand configure the environment variables - Run the server:
deno task startFor development with auto-reload:
deno task devFor HTTPS support:
- Set
USE_SSL=truein your.envfile - Generate SSL certificates:
chmod +x generate-ssl-certs.sh
./generate-ssl-certs.shThis will generate self-signed certificates for development or for a server behind Cloudflare. For production, use properly signed certificates.
All API endpoints are prefixed with /api.
Currently, the API doesn't require authentication, but it tracks users by IP address.
-
URL:
/api/levels -
Method:
POST -
Content Types:
application/jsonapplication/octet-stream
-
URL Params: None
-
Query Params: (for octet-stream)
author: Author nameturnstileResponse: Captcha verification token (if enabled)
-
Request Body: (for JSON)
{ "author": "Author Name", "is_water": true, "sun": 100, "version": 1, "level_data": "base64-encoded level data", "turnstileResponse": "captcha-token" } -
Success Response:
-
Code: 201
-
Content:
{ "id": 123, "name": "Level Name", "author": "Author Name", "created_at": 1714680000, "is_water": 1, "sun": 100, "version": 1 }
-
-
Error Responses:
- Code: 400
- Content:
{ "error": "Missing required fields" } - Code: 400
- Content:
{ "error": "Content contains inappropriate language or content" } - Code: 400
- Content:
{ "error": "Captcha verification required" } - Code: 400
- Content:
{ "error": "Invalid captcha" } - Code: 500
- Content:
{ "error": "Failed to upload level" }
-
URL:
/api/levels -
Method:
GET -
URL Params: None
-
Query Params:
page: Page number (default: 1)limit: Results per page (default: 10)author: Filter by author name (partial match)is_water: Filter by water levels ("true"/"false")version: Filter by level version
-
Success Response:
-
Code: 200
-
Content:
{ "levels": [ { "id": 123, "name": "Level Name", "author": "Author Name", "created_at": 1714680000, "sun": 100, "is_water": 1, "likes": 5, "dislikes": 0, "plays": 10, "version": 1 } ], "pagination": { "total": 50, "page": 1, "limit": 10, "pages": 5 } }
-
-
Error Response:
- Code: 500
- Content:
{ "error": "Failed to list levels" }
-
URL:
/api/levels/:id -
Method:
GET -
URL Params:
id: Level ID
-
Success Response:
-
Code: 200
-
Content:
{ "id": 123, "name": "Level Name", "author": "Author Name", "created_at": 1714680000, "sun": 100, "is_water": 1, "likes": 5, "dislikes": 0, "plays": 10, "version": 1 }
-
-
Error Responses:
- Code: 400
- Content:
{ "error": "Invalid level ID" } - Code: 404
- Content:
{ "error": "Level not found" } - Code: 500
- Content:
{ "error": "Failed to get level" }
- URL:
/api/levels/:id/download - Method:
GET - URL Params:
id: Level ID
- Success Response:
- Code: 200
- Content: Binary file download with appropriate extension (.izl or .izl2)
- Error Responses:
- Code: 400
- Content:
{ "error": "Invalid level ID" } - Code: 404
- Content:
{ "error": "Level not found" }or{ "error": "Level file not found" } - Code: 500
- Content:
{ "error": "Failed to download level" }
-
URL:
/api/levels/:id/rate -
Method:
POST -
URL Params:
id: Level ID
-
Request Body:
{ "rating": "like" or "dislike" } -
Success Response:
- Code: 200
- Content:
{ "success": true }or{ "success": true, "message": "Rating updated" }or{ "success": true, "message": "You've already rated this level" }
-
Error Responses:
-
Code: 400
-
Content:
{ "error": "Invalid level ID" } -
Code: 400
-
Content:
{ "error": "Rating must be 'like' or 'dislike'" } -
Code: 404
-
Content:
{ "error": "Level not found" } -
Code: 400
-
Content:
{ "error": "You have already rated this level" } -
Code: 500
-
Content:
{ "error": "Failed to rate level" }Note: Captcha verification is not required for rating levels.
-
-
URL:
/api/config -
Method:
GET -
Success Response:
-
Code: 200
-
Content:
{ "turnstileEnabled": true, "turnstileSiteKey": "0x0000000000000000000000", "moderationEnabled": true }
-
The server can be configured using the following environment variables in a .env file:
| Variable | Description | Default |
|---|---|---|
| PORT | Server port | 3000 |
| DB_PATH | Path to SQLite database | ./database.db |
| DATA_FOLDER_PATH | Path to level data storage | ./data |
| CREATE_DATA_FOLDER | Create data folder if it doesn't exist | true |
| USE_SSL | Enable SSL/HTTPS | false |
| SSL_KEY_PATH | Path to SSL key | ./ssl/key.pem |
| SSL_CERT_PATH | Path to SSL certificate | ./ssl/cert.pem |
| CORS_ENABLED | Enable CORS | false |
| ALLOWED_ORIGINS | Comma-separated list of allowed origins | |
| USE_TURNSTILE | Enable Cloudflare Turnstile captcha | false |
| TURNSTILE_SECRET | Turnstile secret key | |
| TURNSTILE_SITE_KEY | Turnstile site key | |
| USE_OPENAI_MODERATION | Enable OpenAI content moderation | false |
| OPENAI_API_KEY | OpenAI API key |
This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.