Local development server for SorcGCS — game preview, file management, and AI agent support
Project description
sorcgcs-server
Local development server for SorcGCS (Sorceress) — game preview, file management, AI code agent support, and GPU-powered green screen removal.
Quick Start
# Using uv (fastest)
uvx sorcgcs-server
# Using pipx
pipx run sorcgcs-server
# Or install and run
pip install sorcgcs-server
sorcgcs-server
One command sets up everything:
- The local file server (game preview, file API, agent support)
- The CorridorKey GPU server for AutoSprite green screen removal
On first run, CorridorKey setup runs automatically — clones the repo, downloads the model (~300MB), and installs GPU dependencies (PyTorch).
Options
sorcgcs-server --port 8080 # Custom port (default: 8080)
sorcgcs-server --dir ./games # Serve a specific directory
sorcgcs-server --no-corridorkey # Skip CorridorKey GPU server
sorcgcs-server --version # Show version
What It Does
Local File Server (port 8080)
Lightweight HTTP server (Python stdlib, no dependencies) that provides:
- Game Preview — Serve HTML5 games with live reload support
- File API — Read, write, list, search, and manage project files
- FFmpeg Integration — Audio/video format conversion (if ffmpeg is installed)
- AI Agent Support — Endpoints for the SorcGCS AI code agent
- Checkpoint System — Create and restore file snapshots
CorridorKey GPU Server (port 8100)
Neural green screen removal powered by CorridorKey:
- Auto-setup — Clones repo, downloads model, installs PyTorch on first run
- GPU inference — NVIDIA CUDA, Apple MPS, or CPU fallback
- Runs alongside the main server as a background process
Requires: GPU (NVIDIA or Apple Silicon recommended), ~2GB disk, ~4GB VRAM.
API Endpoints
Main Server
| Method | Path | Description |
|---|---|---|
| GET | /api/status |
Server status and config |
| GET | /api/games |
List available games |
| GET | /preview/* |
Serve game preview files |
| GET | /games/* |
Serve game files |
| POST | /api/read-file |
Read a file |
| POST | /api/write-file |
Write a file |
| POST | /api/list-dir |
List directory contents |
| POST | /api/search-files |
Search files by glob pattern |
| POST | /api/run-command |
Execute a shell command |
| POST | /api/create-dir |
Create a directory |
| POST | /api/delete-file |
Delete a file |
| POST | /api/rename-file |
Rename/move a file |
| POST | /api/ffmpeg-process |
Process media with FFmpeg |
CorridorKey Server
| Method | Path | Description |
|---|---|---|
| GET | /health |
GPU server health + VRAM info |
| POST | /process |
Process image for green screen removal |
Requirements
- Python 3.8+
- No additional dependencies for the file server (uses Python standard library only)
- GPU with CUDA or MPS for CorridorKey (optional — use
--no-corridorkeyto skip) - FFmpeg (optional, for media processing)
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sorcgcs_server-0.7.0.tar.gz.
File metadata
- Download URL: sorcgcs_server-0.7.0.tar.gz
- Upload date:
- Size: 19.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2716ca57165fc33289dd916b2b531a771d1714d70af160202d63cce5fee3c314
|
|
| MD5 |
94aece276f0fe9f68841a76351b9be84
|
|
| BLAKE2b-256 |
0209be2af68b1dd3ad6c8ab539c3da2ffe97c1254606619fa2071a80d2abca77
|
File details
Details for the file sorcgcs_server-0.7.0-py3-none-any.whl.
File metadata
- Download URL: sorcgcs_server-0.7.0-py3-none-any.whl
- Upload date:
- Size: 20.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
62e6251be1595d6cb5aaae9d118d37025b6bb4d384411da720ddb26508f00558
|
|
| MD5 |
a19a6b8389a8b96bed8956d395c193a8
|
|
| BLAKE2b-256 |
90cced5c412706e1a815d1e00ea7b72fa9e7430757e22ca330a6efee74e9d1a4
|