Skip to main content

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-corridorkey to skip)
  • FFmpeg (optional, for media processing)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sorcgcs_server-0.5.12.tar.gz (18.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sorcgcs_server-0.5.12-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file sorcgcs_server-0.5.12.tar.gz.

File metadata

  • Download URL: sorcgcs_server-0.5.12.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for sorcgcs_server-0.5.12.tar.gz
Algorithm Hash digest
SHA256 780cd716dd21574b4232273e35a8c3934a1f1ae1632e7bdc9b4447256323f437
MD5 430808715a70e479448741a159043a86
BLAKE2b-256 98d34533cdb0c3d45ede1d5aadbd3078399df201f084555d0124dc5745be36dd

See more details on using hashes here.

File details

Details for the file sorcgcs_server-0.5.12-py3-none-any.whl.

File metadata

File hashes

Hashes for sorcgcs_server-0.5.12-py3-none-any.whl
Algorithm Hash digest
SHA256 a3d21bdf9b70bbeb1b76eaa2b9b7aae42dfd28e07a248c7bb4993d6cc3ee7fc7
MD5 a461ecf0cda3a53aaf3687aa89cda47a
BLAKE2b-256 fedc5fb00a1bc68a317841812b087724252265459d537b1b7532c37109d7f5d5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page