Repository navigation
Projects and Files
The start screen has Plays in beside Start a map, and Map settings (click outside the map so nothing is selected) has the same row:
- UZDoom and GZDoom - everything WadSmith can make; the map is kept in their own format (UDMF). The default.
- Vanilla Doom (Chocolate Doom) - the 1993 engine's format and limits, as Chocolate Doom and the DOS game play it.
- Limit-removing (Crispy Doom) - the same format without the engine's limits, as Crispy Doom plays it.
With a classic target the project keeps its map in the classic format, written back from the editor through GZDoom's own table of what each classic line type means; the editor is the same either way. Problems lists anything on the map that has no classic type (an action only GZDoom has), so nothing is dropped in silence. WadSmith builds the nodes the classic ports need, checks their limits in Problems, and plays the map in the port itself; see Exporting and Classic Ports.
Each map you make lives in a project: a plain folder. GZDoom can play the folder as it is; nothing in it is in a format only WadSmith reads. WadSmith writes every file to a temporary file first and then swaps it in, so a crash never leaves a half-written map.
A project folder holds:
| What | Where |
|---|---|
| The project's record |
wadsmith.json - the project's name, its game, when it was made, and for each map its name, music, sky, next map, hub and where it came from (new, remix or import) |
| Your maps |
maps/SLOT.wad, one file per map, in GZDoom's own map format |
| Map settings |
zmapinfo.txt, written when a map's name, music, sky, next map or hub differs from the game's |
| Borrowed textures |
textures/ and flats/ - pictures copied in from your other games |
| Prefabs | a folder of saved rooms and things |
| Versions | .wadsmith/versions/SLOT/ |
New projects go in a WadSmith folder inside your Documents folder: "My map", "My map 2" and so on for new maps, and "GAME SLOT remix" for remixes. A remix is your own copy; the game's files are never changed.
The map's slot button in the top bar opens the list of the project's maps, to open another, and:
- New map - one lit room in the game's first empty slot.
- Copy this map - a copy in another slot.
- Move this map - to a chosen empty slot. Its kept versions, and every exit that led to it, follow.
-
Delete this map - its file is kept in the project's
.wadsmith/deletedfolder. A project keeps at least one map.
With nothing selected, the Inspector's Files WadSmith writes… shows the files WadSmith writes into the project for GZDoom (zmapinfo.txt, ANIMDEFS, SNDINFO, MODELDEF, KEYCONF, zscript.txt and its classes), each coloured and read-only, to read or copy. WadSmith writes them again from your choices, so change the choices rather than the files.
A project can load files of yours with its game, before itself: a texture pack such as OTEX, a map pack, any WAD or PK3 GZDoom loads, or a folder laid out as a PK3 is. With nothing selected, the Inspector lists them under ADD-ONS:
- Add a WAD or PK3… and Add a folder… bring one in. The map closes, keeping your changes, and opens again with it.
- Take out NAME stops loading it; the file stays where it is.
Their textures are on the Textures shelf, and Play loads them in the same order. The monsters and other objects an add-on defines (its ZScript or DECORATE, with the numbers its MAPINFO or DECORATE gives them) are on the Objects shelf by their names and kinds, and the plan and the 3D view draw them with their own pictures; one that replaces a game's own object (an imp, say) shows in its place. The Doom Builder notes in an actor's comments are read too: //$Title names it, //$Category puts it on its shelf, //$Sprite picks its picture. The project keeps where an add-on is, not a copy, so a copy of the project on another computer needs it too, and Export lists it as a file the map plays over. A game's own WAD is not an add-on: its textures are on the shelf's game chooser, copied in when you use them. A map pack a project was started from is listed here as well.
- Open a project... on the start screen, then pick the folder.
- Pick one from RECENT.
- Start WadSmith with the folder:
wadsmith PROJECT_FOLDER.
A folder without wadsmith.json is not a project: opened anyway, a folder holding WADs, PK3s or ZIPs with maps offers those maps, as Open a map file... does. A project saved by a newer WadSmith asks you to update.
Open a map file... at the top of the start screen opens a WAD, PK3 or ZIP from anywhere. WadSmith matches its maps to your games (by their names, E1M1 for Doom, MAP01 for Doom II, and the textures they use), opens a single map at once and offers several to pick from. Your changes become a project of your own; the file is never changed and is loaded with your map, so its own textures and things are there. Asking your friend for their project folder instead keeps everything WadSmith knows about it, versions and map settings included.
Every change is kept as you make it. The status bar says "All changes kept", or "Keeping your changes..." for a moment.
WadSmith keeps copies of the map, each with a small picture and a note on why:
- when the map opens,
- each time you press Keep a version,
- each time you press Play,
- the map as it was before you go back to an older copy.
Open the Versions tab to see them. Go back to this version makes a copy the map again, and keeps the map as it is now as a version first, so you can come back to it. If the newest version already holds the map as it is, nothing new is kept.
Above them, This session's steps lists every change since the map opened, by name and time, and the ones taken back with Undo, faded. Click one to put the map as it was just after it, back or forward. A new change after going back drops the steps that were taken back, as Redo would lose them. The latest 100 each way are listed; Undo reaches the rest.
WadSmith follows the usual Linux folders:
| What | Where |
|---|---|
| Settings | ~/.config/wadsmith/settings.json |
Data, including the asset library (your games extracted to plain files) in assets and Freedoom in games/freedoom
|
~/.local/share/wadsmith |
| Log files | ~/.local/state/wadsmith/logs/wadsmith.log |
| Cache | ~/.cache/wadsmith |
| Projects | Documents/WadSmith |
If you have set XDG_CONFIG_HOME, XDG_DATA_HOME, XDG_STATE_HOME or XDG_CACHE_HOME, those are used instead. The Documents folder is the one your desktop names. Older logs are kept beside the current one, numbered.
wadsmith --portable DIR keeps settings, logs and the asset library in DIR, in the folders config, data, state, cache and projects, instead of the usual places.
-
wadsmith --versionprints the version and licence, then exits. -
wadsmith --helpshows the options.
See Command Line for the wadsmith-cli tool.
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