s&box-CLI
Agent-natives CLI für die s&box-Spiel-Engine (Facepunch Studios, Source 2). 79+ Befehle in 14 Gruppen. Manipuliere .scene, .prefab, .vmat, .sound, Input.config, Collision.config-JSON-Dateien direkt, generiere idiomatische C#-Komponenten und führe einen Echtzeit-Asset-Graphen über das Projekt aus.
Installation
pip install git+https://github.com/HKUDS/CLI-Anything.git#subdirectory=sbox/agent-harness
Voraussetzungen
- Python 3.10+
- s&box installiert via Steam – wird automatisch erkannt, oder setze
SBOX_PATHauf ein benutzerdefiniertes Installationsverzeichnis. - Die meisten Befehle arbeiten vollständig mit den JSON-Dateien des Projekts – s&box muss nicht laufen.
Globale Optionen
--json Maschinenlesbare JSON-Ausgabe (immer für Agenten verwenden)
--project PFAD Projektverzeichnis (wird automatisch aus cwd erkannt, wenn `.sbproj` vorhanden und `--project` weggelassen wird)
Befehlsgruppen
project – s&box-Projekte verwalten
cli-anything-sbox project new --name MyGame --output-dir ./MyGame
cli-anything-sbox --json project info
cli-anything-sbox project config --max-players 32 --tick-rate 64
cli-anything-sbox --json --project ./MyGame project add-package facepunch.libsdf
cli-anything-sbox --json --project ./MyGame project remove-package facepunch.libsdf
# Lint: defekte Asset-Referenzen, doppelte GUIDs, fehlerhafte Input.config
cli-anything-sbox --json --project ./MyGame project validate
cli-anything-sbox --project ./MyGame project validate --no-inputs --no-guids
scene – .scene-Dateien bearbeiten
cli-anything-sbox scene new --name gameplay -o ./Assets/scenes/gameplay.scene
cli-anything-sbox --json scene info ./scene.scene
cli-anything-sbox --json scene list ./scene.scene
cli-anything-sbox scene add-object ./scene.scene Enemy --position "100,0,0" --components "model,box_collider,rigidbody" --tags "enemy"
cli-anything-sbox scene remove-object ./scene.scene --name Enemy
cli-anything-sbox scene add-component ./scene.scene <object-guid> Sandbox.PointLight
cli-anything-sbox scene remove-component ./scene.scene <object-guid> --component-type Sandbox.Rigidbody
cli-anything-sbox --json scene modify-object ./scene.scene --guid <guid> --name NewName --position "200,0,0"
cli-anything-sbox --json scene clone-object ./scene.scene --name Enemy --new-name EnemyCopy --position "300,0,0"
cli-anything-sbox --json scene get-object ./scene.scene --name Sun
cli-anything-sbox scene set-property ./scene.scene --fixed-update-freq 64 --timescale 0.5
cli-anything-sbox scene set-navmesh ./scene.scene --enabled --agent-height 72 --agent-radius 16
cli-anything-sbox --json scene list-presets
cli-anything-sbox --json scene modify-component ./scene.scene <object-guid> <component-guid> --properties '{"Damage":50}'
# Objekte finden, die einem oder mehreren Filtern entsprechen (UND-verknüpft)
cli-anything-sbox --json scene query ./scene.scene --has-component rigidbody --has-tag tower
cli-anything-sbox --json scene query ./scene.scene --name-regex "^Tower\d$" --in-bounds "0,-500,-50,1000,500,50"
# Jede Asset-Referenz (.vmdl, .vmat, .vsnd, .vtex, .vpcf, .prefab) aus einer Szene extrahieren
cli-anything-sbox --json scene refs ./scene.scene
# Dieselbe Modifikation auf jedes Objekt anwenden, das einer Abfrage entspricht
cli-anything-sbox --json scene bulk-modify ./scene.scene --has-tag tower --position "0,0,100" --enable
# Struktureller Diff zwischen zwei Szenen (hinzugefügte/entfernte/geänderte GameObjects + SceneProperties)
cli-anything-sbox --json scene diff ./old.scene ./new.scene
# Ein Prefab als GameObject in eine Szene einfügen
cli-anything-sbox --json scene instantiate-prefab ./level.scene ./Assets/prefabs/bullet.prefab --position "10,0,0"
prefab – .prefab-Dateien verwalten
cli-anything-sbox prefab new --name Bullet -o ./Assets/prefabs/bullet.prefab --components "model,sphere_collider,rigidbody"
cli-anything-sbox --json prefab info ./Assets/prefabs/bullet.prefab
cli-anything-sbox prefab from-scene ./scene.scene <object-guid> -o ./Assets/prefabs/extracted.prefab
cli-anything-sbox --json prefab add-component ./prefab.prefab rigidbody
cli-anything-sbox prefab remove-component ./prefab.prefab --component-type Sandbox.Rigidbody
cli-anything-sbox --json prefab list
# Asset-Referenzen in einem Prefab
cli-anything-sbox --json prefab refs ./prefab.prefab
# Komponenteneigenschaften an einem Prefab ändern (nach Komponententyp oder Komponenten-GUID)
cli-anything-sbox --json prefab modify-component ./prefab.prefab --component-type Sandbox.Rigidbody --properties '{"Gravity":false,"MassOverride":50}'
# Struktureller Diff zwischen zwei Prefabs (Root + benannte Kinder)
cli-anything-sbox --json prefab diff ./old.prefab ./new.prefab
codegen – C#-Code generieren
# Normale Komponente
cli-anything-sbox codegen component --name PlayerController --methods OnUpdate,OnFixedUpdate -o ./Code/PlayerController.cs
# Komponente mit [Property]-Feldern
cli-anything-sbox --json codegen component --name Tower --properties '[{"name":"Damage","type":"float","default":"25f"},{"name":"Range","type":"float","default":"500f"}]'
# Netzwerkfähige Komponente (partielle Klasse) mit RPC-Methodenstubs
cli-anything-sbox codegen component --name NetPlayer --networked --methods OnUpdate,OnFixedUpdate --rpc-methods "Fire:Broadcast,TakeDamage:Host" -o ./Code/NetPlayer.cs
# GameResource
cli-anything-sbox codegen gameresource --name TowerData --display-name "Tower Data" --extension tower -o ./Code/TowerData.cs
# Editor-Menü (Editor/-Assembly)
cli-anything-sbox codegen editor-menu --name MyTools --menu-path "Editor/My Tools/Open" -o ./Editor/MyTools.cs
# Normale Razor-UI-Komponente (.razor + .razor.scss)
cli-anything-sbox codegen razor --name HudPanel --properties '[{"name":"Score","type":"int","default":"0"}]' -o ./UI/HudPanel.razor
# Statische oder basisabgeleitete Klasse
cli-anything-sbox codegen class --name Math2 --static -o ./Code/Math2.cs
# PanelComponent + zusammengehöriges ScreenPanel-Gerüst (behandelt die s&box-Eigenheit, dass
# PanelComponent-Eingaben nur funktionieren, wenn beide auf demselben GameObject sind).
# Erzeugt .razor + .razor.scss + einen einfügebereiten GameObject-Ausschnitt oder hängt
# direkt an eine Szene an mit --scene.
cli-anything-sbox --json codegen panel-component --name HudBar -o ./UI/HudBar.razor
cli-anything-sbox codegen panel-component --name Crosshair -o ./UI/Crosshair.razor --scene ./Assets/scenes/game.scene
input – Input.config verwalten
cli-anything-sbox --json input list
cli-anything-sbox input add --name PlaceTower --group Gameplay --keyboard mouse1 --gamepad RightTrigger
cli-anything-sbox input remove --name PlaceTower
cli-anything-sbox input set --name Attack1 --keyboard mouse1
collision – Collision.config verwalten
cli-anything-sbox --json collision list
cli-anything-sbox collision add-layer --name projectile --default Collide
cli-anything-sbox collision add-rule --layer-a projectile --layer-b solid --result Collide
cli-anything-sbox collision remove-rule --layer-a projectile --layer-b solid
cli-anything-sbox collision remove-layer --name projectile
material – .vmat-Materialien verwalten
cli-anything-sbox --json material new --name floor --shader complex --color-texture "textures/floor.tga" --metalness 0.3 -o ./Assets/materials/floor.vmat
cli-anything-sbox --json material info ./Assets/materials/floor.vmat
cli-anything-sbox --json material list
cli-anything-sbox --json material set ./Assets/materials/floor.vmat --metalness 0.8
sound – .sound-Events verwalten
cli-anything-sbox --json sound new --name gunshot --sounds "sounds/gun1.vsnd,sounds/gun2.vsnd" --volume 0.8 -o ./Assets/sounds/gunshot.sound
cli-anything-sbox --json sound info ./Assets/sounds/gunshot.sound
cli-anything-sbox --json sound list
cli-anything-sbox --json sound set ./Assets/sounds/gunshot.sound --volume 0.5
localization – Übersetzungen verwalten
cli-anything-sbox localization new --lang en -o ./Localization/en.json
cli-anything-sbox localization set ./Localization/en.json --key "game.title" --value "My Game"
cli-anything-sbox --json localization list ./Localization/en.json
cli-anything-sbox localization get ./Localization/en.json --key "game.title"
cli-anything-sbox localization remove ./Localization/en.json --key "game.title"
cli-anything-sbox localization bulk-set ./Localization/en.json --keys '{"ui.start":"Start","ui.quit":"Quit"}'
server – Dedizierter Server
cli-anything-sbox server info
cli-anything-sbox server start --game my_game --map facepunch.flatgrass
asset – Asset-Verwaltung & Rückwärtssuchen
cli-anything-sbox --json asset list --type scene
cli-anything-sbox --json asset info ./Assets/scenes/minimal.scene
cli-anything-sbox asset compile ./Assets/materials/floor.vmat
# Welche Szenen/Prefabs referenzieren dieses Asset?
cli-anything-sbox --json --project ./MyGame asset find-refs models/myteam/widget.vmdl
# Nicht referenzierte Assets finden (pro Typ oder über alle referenzierbaren Typen hinweg)
cli-anything-sbox --json --project ./MyGame asset find-unused
cli-anything-sbox --json --project ./MyGame asset find-unused --type model --type material
# Ein Asset umbenennen und alle Szenen-/Prefab-Referenzen aktualisieren (Erweiterung bleibt erhalten, wenn weggelassen)
cli-anything-sbox --json --project ./MyGame asset rename models/team/widget.vmdl gizmo
cli-anything-sbox --project ./MyGame asset rename models/team/widget.vmdl gizmo --dry-run
# Ein Asset zwischen Verzeichnissen verschieben und alle Referenzen aktualisieren
cli-anything-sbox --json --project ./MyGame asset move models/team/widget.vmdl models/shared/widget.vmdl
session – Zustandsverwaltung
cli-anything-sbox session status
cli-anything-sbox session undo
cli-anything-sbox session redo
test – Automatisierte Karten-/Szenen-Generierung
cli-anything-sbox test setup
cli-anything-sbox --json test run
launch – Projekt im s&box-Editor öffnen
cli-anything-sbox launch
Komponenten-Presets
29 Kurznamen, die mit --components bei scene add-object, prefab new usw. verwendet werden können. Jeder ist einem Sandbox.*-Komponententyp zugeordnet.
| Preset | Komponententyp |
|---|---|
model | Sandbox.ModelRenderer |
box_collider | Sandbox.BoxCollider |
sphere_collider | Sandbox.SphereCollider |
capsule_collider | Sandbox.CapsuleCollider |
plane_collider | Sandbox.PlaneCollider |
model_collider | Sandbox.ModelCollider |
rigidbody | Sandbox.Rigidbody |
character_controller | Sandbox.CharacterController |
player_controller | Sandbox.PlayerController |
camera | Sandbox.CameraComponent |
light_directional | Sandbox.DirectionalLight |
light_point | Sandbox.PointLight |
spot_light | Sandbox.SpotLight |
ambient_light | Sandbox.AmbientLight |
sprite_renderer | Sandbox.SpriteRenderer |
skinned_model_renderer | Sandbox.SkinnedModelRenderer |
text_renderer | Sandbox.TextRenderer |
line_renderer | Sandbox.LineRenderer |
decal_renderer | Sandbox.DecalRenderer |
trail_renderer | Sandbox.TrailRenderer |
particle_effect | Sandbox.ParticleEffect |
sound_point | Sandbox.SoundPointComponent |
nav_mesh_agent | Sandbox.NavMeshAgent |
screen_panel | Sandbox.ScreenPanel |
world_panel | Sandbox.WorldPanel |
fixed_joint | Sandbox.FixedJoint |
hinge_joint | Sandbox.HingeJoint |
spring_joint | Sandbox.SpringJoint |
ball_socket_joint | Sandbox.BallSocketJoint |
scene list-presets gibt das Live-Preset-Register als JSON zurück.
Agenten-Nutzungsmuster
Übergib bei jedem agentengesteuerten Aufruf --json. Verwende jq, um GUIDs und Pfade zwischen Befehlen zu verknüpfen:
# Ein Projekt starten
sbproj=$(cli-anything-sbox --json project new --name MyGame --output-dir /tmp/MyGame | jq -r '.sbproj')
cd /tmp/MyGame
# Einen Turm mit einem bestimmten Komponenten-Layout hinzufügen, seine GUID erfassen
guid=$(cli-anything-sbox --json scene add-object ./Assets/scenes/main.scene Tower \
--components "model,box_collider,rigidbody" --tags "tower" \
| jq -r '.guid')
# Die entsprechende C#-Komponente generieren, netzwerkfähig
cli-anything-sbox --json codegen component --name Tower --networked \
--rpc-methods "Fire:Host" --properties '[{"name":"Damage","type":"float","default":"25f"}]' \
-o ./Code/Tower.cs
# Massenweise jeden Turm in der Szene anpassen
cli-anything-sbox --json scene bulk-modify ./Assets/scenes/main.scene \
--has-tag tower --enable --position-y-add 50
# Vor dem Commit validieren
cli-anything-sbox --json project validate
REPL-Modus
cli-anything-sbox ohne Argumente startet eine interaktive REPL mit einem gestalteten Prompt:
$ cli-anything-sbox
cli-anything-sbox> project info
cli-anything-sbox> scene list ./Assets/scenes/main.scene
cli-anything-sbox> codegen component --name Foo -o ./Code/Foo.cs
cli-anything-sbox> quit
Umgebungsvariablen
| Variable | Beschreibung | Standard |
|---|---|---|
SBOX_PATH | s&box-Installationsverzeichnis | Automatisch aus Steam-Bibliotheksordnern erkannt |
CLI_ANYTHING_SKILL_REPO | Überschreibt das Repository, von dem repl_skin SKILL.md liest | HKUDS/CLI-Anything |