Repository navigation
Command Line
wadsmith [options] [PROJECT_FOLDER]
| Option | What it does |
|---|---|
--portable DIR |
Keep settings, logs and the asset library in DIR instead of the usual folders. |
--version |
Print the version and licence, then exit. |
--help |
Show the options. |
Give a project folder to open it straight away.
wadsmith-cli works with map files without opening the editor. It is installed beside the app: wadsmith-cli from the .deb or the AUR package, ./wadsmith-cli in the unpacked tarball. Values are written --name=value.
-
wadsmith-cli --helplists the commands. -
wadsmith-cli help COMMANDshows how to use one. -
wadsmith-cli --versionprints the version and licence.
Commands finish with code 0 when they did their job, 1 when they found a problem (a failed check or a bad file), and 2 when the command line itself was wrong.
Shows what a WAD, PK3 or folder holds: its kind, the game it belongs to, every map with its format and size, and any problems found while reading it. --lumps also lists every lump or file.
wadsmith-cli inspect mymaps.wad --lumps
Turns a WAD or PK3 into folders of PNG pictures, WAV sounds, MIDI music and map files, with a manifest.json saying where each file came from. --out=FOLDER is required. --base=BASEGAME names the game an add-on builds on. --only=KINDS picks from textures, floors, patches, sprites, graphics, sounds, music, maps, palette and other.
wadsmith-cli extract mymaps.wad --out=extracted --only=textures,maps
Converts a Doom- or Hexen-format map to GZDoom's UDMF format. --map=NAME picks the map and --out=FILE.wad writes it. --repairs also applies GZDoom's own repairs for the original map, as a remix does. --game=ID names the game when it cannot be worked out from the file.
wadsmith-cli translate mymaps.wad --map=NAME --out=converted.wad
Starts a project from one of a base game's own maps, in GZDoom's own map format, ready to edit and play. Give it the game's WAD file; it is only read. --map=NAME and --out=PROJECT_FOLDER are required. This needs GZDoom installed.
wadsmith-cli remix path/to/game.wad --map=NAME --out=MyRemix
Checks every map in a file for structural faults, such as a line ending at a missing corner. It fails when it finds one. --warnings also lists things that load but are probably not meant.
wadsmith-cli validate mymaps.wad --warnings
Shows or changes a project map's name, music, sky and next map, and writes the project's zmapinfo.txt. With no setting it prints the current ones. --map, --title, --music, --sky and --next (a map, or EndTitle) are the options. An empty value goes back to the game's own.
wadsmith-cli map-settings MyRemix --map=NAME --title="My first remix"
Writes the feature tour as a new project folder for a game: a room for each feature, each with a sign the game shows. --game=ID is required; it is the game's short name, such as doom2, heretic, hexen or strife.
wadsmith-cli tour TourFolder --game=doom2
Makes a map with Make Me a Map's generator, checks it (its shapes, Problems, and that the exit can be reached with every key before its door), and writes it as a WAD or as a WadSmith project. The same seed and choices make the same map on any computer.
wadsmith-cli generate --out=GrimKeep.wad --game=doom2 --seed=grim-keep --size=large --style=castle
wadsmith-cli generate --project=GrimKeep --game=heretic --maps=5 --keys=3 --bosses=2
-
--game=ID- the base game's short name (defaultdoom2). -
--seed=WORDS- the two words the map is made from. -
--size=small|medium|large|huge,--style=base|caves|castle|mixed,--outdoors=none|some|lots. -
--challenge=0..1,--keys=0..3,--bosses=0..3,--maps=1..8(an episode). -
--without=secrets,stairs,lifts,teleporters,dark,ambushes,decorations,traps,hazards- leaves those out. -
--games=FOLDER- where the base game is, if not in GZDoom's or WadSmith's folders. With the game found, each door stands in a doorway as tall as its picture, as on the page; without it, doors are as tall as their passages. -
--script- prints the edit script the map is built from.
Things from your other games are chosen on the page, which can copy them in; the command line uses the base game's own.
Exports a project as one file and prints what each map loses, as Export in the editor does. Exit code 1 when something in the file stops the port with an error (the file is written either way).
wadsmith-cli export MyProject --for=boom --out=MyMap.wad
wadsmith-cli export MyProject --for=gzdoom --out=MyMap.pk3
-
--for=gzdoom|vanilla|limit-removing|boom|mbf21- what the file plays in. -
--games=FOLDER- where your games are, for the picture checks and carrying (the usual folders are searched too). -
--verbose- lists which walls, rooms and objects each line is about.
wadsmith-cli play PROJECT --print --data=FOLDER --port=crispy-doom prints the command Play in runs for a classic port, after exporting the map for it into the data folder.
WadSmith
- Home
- Installing
- First Steps
- The Editor Window
- Building Rooms
- Selecting and Shaping
- Smart Objects
- Things, Textures and Shelves
- Free Community Assets
- Models, Pictures and Skies
- Sounds, Signs and Screens
- The 3D View
- Playing Your Map
- Problems, Progression and Balance
- Exporting and Classic Ports
- Make Me a Map
- Learning Tools
- Keyboard Shortcuts
- Preferences
- Projects and Files
- Command Line
- Troubleshooting