GMod Map in den Workshop hochladen: Schritt für Schritt
GMod Map in den Workshop hochladen: Ordner mit addon.json anlegen, mit gmad.exe bauen, mit gmpublish.exe veröffentlichen. Mit den häufigsten Fehlern.
Eine GMod-Map veröffentlichst du in drei Schritten: Du legst einen Ordner mit einer addon.json und der BSP unter maps/ an, baust daraus mit gmad.exe eine .gma-Datei und lädst sie mit gmpublish.exe samt einem Icon von 512 × 512 Pixeln hoch. Der neue Eintrag ist zunächst versteckt und wird erst sichtbar, wenn du ihn auf der Workshop-Seite öffentlich stellst. Scheitert der Upload, liegt es meist an einer Datei, die nicht auf der Whitelist steht, an der addon.json oder am Icon.
Erst entscheiden: Workshop oder Verkauf
Ein öffentlicher Workshop-Eintrag ist kostenlos und für jeden abrufbar. Das lässt sich nicht sauber zurücknehmen: Nach dem Steam-Nutzungsvertrag bleiben die Rechte der Nutzer, die bereits eine Kopie erhalten haben, bestehen, auch wenn du den Eintrag später entfernst. Eine Map, die du verkaufen willst, gehört deshalb nicht vorher in den Workshop. Umgekehrt ist der Workshop der bequemste Weg für alles, was frei verfügbar sein soll, denn Steam übernimmt Verteilung und Updates. Die Abwägung aus Sicht eines Servers steht in Eigene Map oder Workshop-Map, der Weg zum Verkauf in GMod Maps verkaufen.
Ordneraufbau und addon.json
Ein Workshop-Addon ist technisch eine einzelne .gma-Datei: ein Archiv, das aus einem Ordner mit dem Aufbau von garrysmod/ entsteht. Wie der Ordner heißt, spielt keine Rolle. Für eine Map sieht er so aus:
rp_hafenstadt/
addon.json
maps/rp_hafenstadt_v2.bsp
maps/rp_hafenstadt_v2.nav
maps/graphs/rp_hafenstadt_v2.ain
maps/thumb/rp_hafenstadt_v2.png
materials/...
models/...
sound/...
materials/, models/ und sound/ brauchst du nur für Content, der nicht in der BSP steckt. Meist ist es einfacher, alles zu packen, siehe Custom Content in die BSP packen. Das Bild unter maps/thumb/ erscheint in der Map-Auswahl des Spiels. Die Vorschaubilder, die GMod selbst mitbringt, sind PNG-Dateien mit 128 × 128 Pixeln.
Die addon.json beschreibt das Addon:
{
"title": "rp_hafenstadt",
"type": "map",
"tags": [ "roleplay", "scenic" ],
"ignore": [ "*.vmf", "*.psd" ]
}
| Feld | Erlaubte Werte |
|---|---|
title | Name des Addons, am besten nur ASCII-Zeichen |
type | einer von gamemode, map, weapon, vehicle, npc, entity, tool, effects, model, ServerContent |
tags | höchstens zwei von fun, roleplay, scenic, movie, realism, cartoon, water, comic, build |
ignore | Muster für Dateien, die nicht ins Archiv sollen |
Mit gmad.exe die .gma bauen
gmad.exe und gmpublish.exe liegen im Ordner GarrysMod/bin der Spielinstallation. Das GMod-Wiki warnt davor, gmad an einen anderen Ort zu verschieben.
gmad.exe create -folder "C:\maps\rp_hafenstadt" -out "C:\maps\rp_hafenstadt.gma"
gmad prüft jede Datei gegen eine Whitelist und bricht mit File list verification failed ab, wenn eine durchfällt. Unter maps/ sind nur .bsp, .nav, .ain, .lmp und PNG-Dateien unter maps/thumb/ erlaubt, dazu die üblichen Formate für Materialien, Models, Sounds und Lua. Mit dem Zusatz -warninvalid überspringt gmad ungültige Dateien, statt abzubrechen.
| Meldung | Ursache |
|---|---|
[Not allowed by whitelist] | Dateityp oder Ordner nicht erlaubt, zum Beispiel .vmf, .txt unter maps/ oder scripts/ (außer scripts/vehicles/), bei Models .sw.vtx |
[Filename contains captial letters] | Großbuchstaben im Pfad. gmad baut die Datei trotzdem, benenne sie aber um |
addon.json error: Couldn't find file | addon.json fehlt im Ordner |
Couldn't parse json | Syntaxfehler in der addon.json, etwa ein fehlendes Komma |
type isn't a supported type! | der Wert von type steht nicht in der Liste |
too many tags - specify 2 only! | mehr als zwei Tags |
Die Whitelist hat für Mapper eine wichtige Folge: Soundscape-Skripte (scripts/soundscapes_<mapname>.txt) und ein Partikel-Manifest (maps/<mapname>_particles.txt) lassen sich nicht als lose Dateien mitliefern. Der übliche Ausweg ist, sie in die BSP zu packen. Für Soundscapes ist das in der Valve Developer Community dokumentiert. Prüfe nach dem Packen im Spiel, ob Sounds und Partikel wirklich laden.
Mit gmpublish.exe veröffentlichen
Der Befehl zum Anlegen eines neuen Eintrags lautet:
gmpublish.exe create -icon "C:\maps\rp_hafenstadt.jpg" -addon "C:\maps\rp_hafenstadt.gma"
- Icon vorbereiten. Verlangt wird ein JPEG mit genau 512 × 512 Pixeln, als Baseline-JPEG gespeichert (nicht progressiv) und kleiner als 1 MB. Das Wiki nennt zusätzlich eine Farbunterabtastung von 4:2:0. PNG funktioniert nicht.
- Steam starten und mit dem Account anmelden, dem der Eintrag gehören soll. gmpublish arbeitet über den laufenden Steam-Client.
- Befehl ausführen. Hast du der Workshop-Vereinbarung von Steam noch nicht zugestimmt, bricht gmpublish ab und nennt die Adresse dafür. Bei Erfolg steht in der Ausgabe
Success! Your new item ID ismit der ID des Eintrags. Notiere sie. - Seite ausfüllen. gmpublish meldet, dass der neue Eintrag als versteckt markiert ist. Öffne ihn im Workshop und ergänze Beschreibung und Screenshots.
- Sichtbarkeit setzen. Erst danach stellst du den Eintrag öffentlich.
Steam kennt vier Stufen der Sichtbarkeit: öffentlich, nur Freunde, versteckt (nur für dich) und nicht gelistet. „Nicht gelistet“ heißt, dass jeder mit dem Link den Eintrag sieht, er aber in keiner Suche auftaucht. Wie ein Server Workshop-Addons lädt und an Spieler weitergibt, steht in FastDL oder Workshop.
Updates und Change Notes
gmpublish.exe list
gmpublish.exe update -id 1234567890 -addon "C:\maps\rp_hafenstadt.gma" -changes "v3: fixed spawn in town hall"
gmpublish.exe update -id 1234567890 -icon "C:\maps\rp_hafenstadt.jpg"
list zeigt deine hochgeladenen Einträge. Die ID steht auch in der Adresse der Workshop-Seite hinter ?id=. -changes ist optional, du kannst die Notiz später auf der Workshop-Seite im Reiter „Change Notes“ bearbeiten. Schreibe sie nur mit ASCII-Zeichen, also ohne Umlaute. Laut Wiki läuft der Upload sonst durch, aber die Notiz fehlt. Titel, Beschreibung und Bilder änderst du laut Wiki auf der Workshop-Seite.
Veröffentliche neue Fassungen als Update dieses Eintrags und nicht als neuen Eintrag. Das empfehlen die Workshop-Regeln für GMod. Server prüfen ihre Addons beim Neustart auf Updates. Bis dahin läuft dort die alte BSP, und das kann laut GMod-Wiki Spieler am Beitritt hindern. Warum eine neue Fassung auch einen neuen Dateinamen bekommen sollte, steht in Map-Namen und Versionen.
Fremde Inhalte: was die Regeln sagen
Das ist keine Rechtsberatung, sondern eine Zusammenfassung dessen, was in den Regeln steht.
- Im Steam-Nutzungsvertrag sicherst du zu, dass du einen Workshop-Beitrag selbst erstellt hast oder für alle Beteiligten einreichen darfst, und dass du die nötigen Rechte an den Inhalten hast.
- Das GMod-Wiki formuliert es direkter: keine Addons hochladen, die du nicht gemacht hast, auch keine reparierten Fassungen, außer der Autor stimmt zu. Re-Uploads werden entfernt, auch wenn das Original nicht mehr existiert.
- Addons mit Inhalten aus kostenpflichtigen Spielen wie Counter-Strike: Source oder Half-Life 2 werden laut den Workshop-Regeln entfernt, auch wenn dein Addon diese Props zum Funktionieren braucht. Packe solche Dateien also nicht in die BSP.
- Nicht erlaubt sind außerdem leere Einträge und Test-Einträge, Addons, die einen externen Download verlangen, und Addons, die ihre Nutzung auf bestimmte Server beschränken.
Valve kann Beiträge nach dem Nutzungsvertrag aus beliebigem Grund einschränken oder entfernen. Wer an welchen Bestandteilen einer Map die Rechte hält, ordnet der Artikel Urheberrecht bei GMod-Maps ein.
Häufige Fragen
Wie liefere ich ein TTT-Skript mit, wenn .txt unter maps/ nicht erlaubt ist?
Über data_static/. TTT sucht das Waffen- und Spawn-Skript zuerst unter maps/<mapname>_ttt.txt und danach unter data_static/<mapname>_ttt.txt. Dieser Ordner ist in der Whitelist für .txt, .json, .xml, .csv und .dat freigegeben.
Kann ich einen Workshop-Eintrag wieder löschen?
Ja, auf der Workshop-Seite, und das lässt sich nicht rückgängig machen. Kopien, die Abonnenten schon haben, holst du damit nicht zurück.
Reicht „nicht gelistet“, um eine Map nur meinem Server zu geben?
Nein. Jeder mit dem Link kann den Eintrag abonnieren, und jeder Spieler, der beitritt, bekommt die Datei ohnehin. Für Maps, die nicht öffentlich sein sollen, ist FastDL der übliche Weg.
Wie groß darf ein Addon sein?
Die Workshop-Regeln nennen eine Grenze von rund 4 GB und raten davon ab, ein Addon in mehrere Teile zu zerlegen. Meldet der Upload „Compression Failed“, ist das Addon laut Wiki zu groß. Kleinere Texturen sind dann der erste Hebel, mehr dazu in BSP-Dateigröße verkleinern.