Welcome brave adventurer! If you're still into classic 8-bit / 16-bit home computers and Infocom style adventure games you may want to rest here for a while. The Puny BuildTools provide a command-line interface to PunyInform, a lightweight but powerful Inform 6 library, optimized to perform well on old hardware. The Puny BuildTools assist interactive fiction authors as a project management solution for Infocom Z-machine games. They make the whole process of development fast, streamlined and accessible, from structuring your project to compilation, testing, building disk images for retro systems, converting pixel artworks to loading screens compatible with classic targets and bundling your releases for distribution.
2.2 Craters of Ganymede
The following targets support Z-machine version 5 (XZIP) and Z-machine version 3 (ZIP) story files:
C64, Amiga, ZX Spectrum, Amstrad CPC/PCW, Atari ST, Atari 8-bit, MS-DOS, MSX, BBC Micro/Acorn Electron, C128, Plus/4, Apple II, SAM Coupe, TRS80 Model 3, TRS 80 Model 4, Mega65, classic Macintosh, modern PC.
There are also a few deprecated targets available, only supporting Z-machine version 3:
VIC20/PET, DEC Rainbow, TRS CoCo/Dragon64, Osborne1, Ti99/4a, Oric, Kaypro.
Note: Puny BuildTools projects by default are configured to target Z-machine v5 and it's strongly recommended to keep it that way. The format is less restrictive and offers more options.
You can use the built-in feature to compile your story from source but the project workflow allows to skip this step and use any given story file.
The Puny BuildTools are designed for Linux (64-bit) systems. They've been developed and extensively tested on Ubuntu and Debian but any derivate of the latter should be fine.
If you're on Windows 10 (or later) you can run the Puny BuildTools via WSL2.
If you work on MacOS, I can't recommend OrbStack enough. Make sure you set up an Ubuntu machine with Intel architecture.
Below instructions are intended for Debian based systems like Ubuntu and may vary if you are using a different distro. The recommended system is Ubuntu.
Open a Bash terminal. In your home directory, create a folder named FictionTools with
mkdir ~/FictionTools
The Puny BuildTools require some dependencies. Install these via a single command:
sudo apt update && sudo apt install frotz cpmtools dosfstools mtools git ruby imagemagick zip python3-pip
When prompted to install additional dependencies, type Y to confirm. Switch to the folder you created and use Git to load the newest version from GitHub:
cd ~/FictionTools && git clone https://github.com/ByteProject/Puny-BuildTools.git .
Let's use Puny-Wan Kenobi to check if the Puny BuildTools have sufficient permissions to run on your system by typing:
cd ~/FictionTools && ./kenobi -c
This usually is the case since Git keeps track of the executable bit of a file. If so, you can skip the troubleshooting part below.
Permissions Troubleshooting: Should Bash tell you that you don't have sufficient permissions to run
kenobi, or shouldkenobiitself report errors for some of the components and modules, you can use it to fix these. Again, only do the command below if you got errors reported or cannot run kenobi:
cd ~/FictionTools && chmod 755 kenobi && ./kenobi -p
This may take some time. Should you ever need to fix permissions again, simply run
kenobi -p.
Next, you need to make sure all environment variables and paths are properly set on your system. Launch nano to edit your Bash resource file. The next step depends on which host system you are using, so I recommend reading it carefully.
nano ~/.bashrc
In case you're on Linux add this entry:
source ~/FictionTools/.punyrc
In case you're on Windows / WSL2, the entry needs to look like this instead:
source ~/FictionTools/.punyrc
source ~/FictionTools/.punywsl
And for those on MacOS, make sure the entry looks like this:
source ~/FictionTools/.punyrc
source ~/FictionTools/.punyorb
After you've made your changes, hit CTRL X to exit Nano. Make sure you select Y when you're asked to save the modified buffer.
Another dependency is Wine, a compatibility layer that allows running Windows applications on Linux.
Note: MacOS users can skip this step as Wine won't run in OrbStack.
To install Wine, type these three commands:
sudo apt update && sudo apt install wine
sudo dpkg --add-architecture i386
sudo apt update && sudo apt install wine32
It's recommended to close all Terminal windows now and then open a new Bash instance. The changes you've made to .bashrc have now been applied.
Next, teach cpmtools to handle disk images for SAM Coupe and DEC Rainbow. In your Bash prompt, type sudo nano /etc/cpmtools/diskdefs and add the following code:
diskdef prodos
seclen 512
tracks 160
sectrk 9
maxdir 256
blocksize 2048
boottrk 1
skew 0
os 2.2
end
# DEC2 DEC Rainbow - SSDD 96 tpi 5.25" - 512 x 10
diskdef dec2
seclen 512
tracks 80
sectrk 10
blocksize 2048
maxdir 128
skew 2
boottrk 2
os 2.2
end
For making the Amiga target work, you need to install the amitools Python package. But first install its dependencies:
pip3 install cython --break-system-packages && pip3 install -U git+https://github.com/cnvogelg/machine68k.git --break-system-packages
Now install amitools:
pip3 install -U git+https://github.com/cnvogelg/amitools.git --break-system-packages
One final step remains: providing the Puny BuildTools with the path to your PunyInform installation. In case you haven't installed PunyInform yet, do so now. You'll find it here.
Type below command and enter the path to your PunyInform installation, then save.
nano ~/FictionTools/.pi6rc
Congratulations! You've completed the setup.
The heart of the Puny BuildTools is a command-line interface called Puny CLI, which is accessible via the puny command.
Note: It's important that you execute the Puny CLI in your project's root directory.
The synopsis is:
puny [-switch] or [-build target]
A rule of thumb is: the switches are for managing your project, the build options with target arguments are meant to roll out your project on a variety of retro computer systems.
Note: when this documentation talks about your "project" it actually refers to a game. A project is essentially a Z-machine game.
The following switches are available.
Show the help menu.
Initialize the project directory. This is the first thing you have to do before you can actually work with your project. It creates a set of files and directories:
project root: all.sh, bundle.sh, config.sh
/Releases directory: game.transcript, licenses.txt, PlayIF.pdf, readme.txt
/Resources directory: pixel_guide.txt
How to work with the above project structure and its purpose is explained in the next chapter of this documentation.
Opens an editor to set up the project configuration file config.sh, found in the project directory root. In practice, you do this step only once and directly after project initialisation.
Compile your project to a Z-machine story file. Inform source file and Z-machine version are read from the variables defined in the project's config file. Will report an error if your story file cannot compile.
Create highly optimized abbrevations. While this feature is optional, it's recommended to make use of it. Abbrevations are tokens of text compression. The better the compression, the smaller the story file, the higher the performance on retro computers. Please refer to the abbrevations chapter of the PunyInform manual to learn more about it. The optimized abbrevations are written to a file named abbrvs.h in the project directory, which you can import by adding Include ">abbrvs.h"; to your Inform source file. Do so very early in your source as the Inform compiler is a one pass compiler, meaning strings found in your code before you include the abbreviatons won't be compressed. You also need to add these lines of code at the very beginning of your source file:
!% $MAX_ABBREVS=96
!% $TRANSCRIPT_FORMAT=1
!% -r
!% -e
Test your project. This feature is very useful while you're actively working on your game. What it really does: it compiles your latest source, then launches Frotz in your terminal window to test it. Will report and won't launch Frotz if a story file could not be generated due to a compilation error. In practice, you will use this feature a lot while your project progresses. It is the equivalent to "compile and run" in modern IDEs.
See the full range of target systems available for the build feature. Will also list the valid arguments you can pass after the build flag.
Shows some examples of how you would use the Puny CLI.
Shows version information for all components and modules of the Puny BuildTools.
The most prominent feature of the Puny CLI is building disk images for a broad range of retro systems. It's designed to be as accessible as possible and a real time saver.
Note: Make sure that you have the latest version of your project compiled, using
puny -c. The build feature does not compile but instead takes the story file it finds in the project directory as a basis.
Let's say you'd love to have a Commodore Amiga version of your game. Essentially, all you need to do is this:
puny -b amiga
So you need to provide an argument after the build flag -b argument, which specifies the target system, in this case -b amiga. An overview of all supported targets and the equivalent arguments can be seen when launching with the -o switch puny -o.
The Puny CLI also supports the creation of multiple targets at once. Let's assume you want to create an Amiga, C64 and ZX Spectrum version of your game:
puny -b amiga -b c64 -b speccy
You'll find the resulting disk images right in your project folder. It's really that easy. And it can be even easier. When you initiated the project directory, an executable script all.sh has been placed in there as well. You can launch it with
./all.sh
and it will build all supported targets at once. To be more precise, it is configured to build all targets at once that support Z-machine version 5, which means you get 17 disk images for 19 classic computer systems. The whole build process takes only a few seconds. You can edit the all.sh script of course to suite your needs, for example to activate the deprecated z3 targets. That's why the script is placed locally in your project's root folder, so you may alter it based on the project's scope.
There is one more thing to know. You probably noticed the Resources folder that has been created when you initiated the project directory. Puny CLI will look into this folder upon building a target. When it finds a pixel artwork with the right format in it, Puny CLI will build a disk image for you with a proper loading screen. Not all targets support loading screens, but many targets do. If you look into the Resources folder, you'll find pixel_guide.txt, which explains in detail how to create the pixel artworks for all supported systems.
Note: Loading screens are purely optional. If you don't provide one in
Resources, the target is built without. The Puny BuildTools support you in rapidly creating screens though for quite a few targets. Some great utilities have been crafted exclusively for the Puny BuildTools for said purpose. You'll learn more about them in the "Bonus Content" section of this documentation.
Note: The MS-DOS target is the only one that doesn't create a disk image. Instead it places the output in a folder
DOSinside theReleasesfolder in your project directory.
This part of the documentation aims to give you a real-life example of how one would work with the Puny BuildTools. Let's assume for a moment you have that great vision for your next best-selling interactive fiction epos called "The Galaxy".
The first thing you'll need to take care of is creating a project directory and navigate to it via mkdir Galaxy && cd Galaxy.
Next, initiate the project directory: puny -i. Afterwards, edit the configuration file with puny -e. In the editor view, change the STORY setting to "galaxy" and adjust SUBTITLE and LABEL to desired values. Save your changes.
Now would be the right time to add an Inform source file to your project folder. Name it galaxy.inf. In case you need a starting point, the examples that come with PunyInform are great. It's recommended that your game source has these compiler settings at the very beginning of the file:
!% -~S
!% $OMIT_UNUSED_ROUTINES=1
!% $MAX_ABBREVS=96
!% $TRANSCRIPT_FORMAT=1
!% $ZCODE_LESS_DICT_DATA=1
!% -r
!% -e
What happens now is solely based on your awesomeness. You start developing your game and you'll probably use the test feature puny -t a lot to "compile and run" your game until you're satisfied with it.
Once you're done, it's recommended to create optimized abbreviations with the puny -a switch. How to properly import these and make use of them has already been covered earlier in this documentation.
So your game is done and the size of the story file has been optimized. Now it's about preparing the release. You decide to roll out your game on all supported retro systems, which means you don't need to alter the all.sh executable script in the project directory. And why would you. The more systems you're game will be available for, the bigger the addressable target audience.
You choose to go the extra mile and provide loading screens, so you do as advised in Resources/pixel_guide.txt.
You use the all.sh script to create disk images for all supported systems.
In the Releases folder, which had been created when you initiated the project directory, you find a few files that you might want to alter. The file readme.txt contains loading instructions for all supported targets, but you may want to add additional content here, for example the gameplay or credits, really any information you want to player to receive together with your game. The file game.transcript is empty. You may choose to replace it with an actual transcript of your game, the alternative is that you delete the file and it won't be added to the release bundle. The file licenses.txt needs to remain and you're not allowed to delete content from it. However, you are allowed to append a license text for your project to it, if applicable. The PlayIF.pdf card is a slightly improved version of the "Play IF" card Andrew Plotkin (Zarf) once made. If you don't want to distribute it with your game, you can delete it but I strongly recommend to keep it in as there are only advantages for the player when doing so. It also means that you don't need to focus too much on general mechanics in your manual / readme.txt.
Note: It's important that you don't rename the files found in
Releases, because otherwise they won't be added to the release bundle.
What a ride! Wouldn't it be nice and convenient if you could tell the Puny BuildTools to create a .ZIP file with all relevant contents of project, ready for distribution? That's exactly what the bundle.sh utility in your project directory is for. The synopsis is:
./bundle.sh -t path
Let's say you want to place said .ZIP archive on your desktop. Simply do this:
./bundle.sh -t ~/Desktop
The file will be placed on your desktop and you can upload it to itch.io or wherever you want to distribute it.
How much time you save with the Puny BuildTools really becomes obvious once you need to update your code and distribute a new version of your game:
- change code
- bump version number in config file
- puny -c
- ./all.sh
- ./bundle.sh -t ~/Desktop
Apart from the code changes, you can do this in less than a minute.
And that's it.
There is bonus content? Yes! The Puny BuildTools exclusively come with some additional, very useful applications. Let's have a closer look.
pi6 is an Inform 6 command line wrapper, which uses the PunyInform library on your system to create story files. So instead of launching the Inform compiler itself, you can use pi6 instead. It's independent from project structures you create with Puny CLI. So if you quickly want to compile some Inform source to a story file without making it a project, that's what pi6 is for. The other major advantage is that it has a very straightforward synopsis compared to the Inform compiler. Building a story file from an Inform source file using the PunyInform library is as easy as this:
pi6 galaxy.inf
This will create galaxy.z5 in your current working directory. So by standard, pi6 creates Z-machine version 5 files. You may however create .z3 files with the -3 flag:
pi6 -3 galaxy.inf
If you launch pi6 without an argument, it will show you the help menu.
I know, that's a very creative name. You've already been in touch with this powerful utility during the installation process. It has the capability to check if the Puny BuildTools have sufficient permissions on your system via kenobi -c and it is also capable to fix them. The feature you're probably going to use the most though is its ability to keep the Puny BuildTools up to date. Just type
kenobi -u
to fetch the latest updates.
Type kenobi -h for the help menu.
ifftool.sh is a Commodore Amiga/MEGA65 IFF screen maker. It converts .PNG files to .IFF images in Amiga and MEGA65 resolutions. It also compiles .PNG images to executable Amiga binaries, the format used by the Puny CLI 'amiga' target to build disks with loading screen.
Type ifftool.sh -h for the help menu.
cpcscr.sh is an Amstrad CPC screen maker. It converts a .PNG image file to an Amstrad CPC loading screen, a colour palette file and a BASIC loader. The output will be: SCREEN.SCR, SCREEN.PAL and SCREEN.BAS.
Type cpcscr.sh -h for the help menu.
degaspi1.sh is, as the name implies, an Atari ST (Degas .PI1) screen maker. It converts .PNG images to Atari ST / Degas .PI1 format.
makescr.sh is a ZX Spectrum screen maker. Please refer to the pixel_guide.txt found in the Resources folder of your project to learn how to use it.
By default, the folder punycustom does not exist. However, if you find the feature useful, you may create it via
mkdir ~/FictionTools/punycustom
So what does it do? Let's assume for a moment that you want to replace a PunyInform library file. Not just a few routines but the whole file. That's what it is for. Every file you place in punycustom that has the same name as a PunyInform library file, is used upon compilation instead. The most common scenario would be replacing the library's standard messages found in messages.h with your own implementation. Another common scenario would be replacing one of the PunyInform library extensions with a customized version.
Hacks are settings which you can add to the configuration file of your project to override the default behavior of the Puny BuildTools. All hacks are case-sensitive.
Builds Apple II Z-machine version 3 targets with Infocom's interpreter version K instead of Vezza. This hack is ignored if ZVERSION 5 is defined in your project's configuration file.
There is only one limitation I am currently aware of and it affects MacOS hosts. OrbStack unfortunately does not support Wine. That means build targets that use Wine to execute Windows-binaries during the disk image creation process won't work.
To be more precise: if you run the Puny BuildTools on
MacOSyou are not able to build disk images forTRS80 Model 3andTRS80 Model 4. If you try to, the TRS disk image builders will tell you that this is not supported on your host.
I am currently looking into a workaround. The problem is the lack of tools that allow you to write TRS disk images on Linux or other *nix based operating systems.
Special thanks to Shawn Sijnstra, Fredrik Ramsberg, Johan Berntsson, Andrew Plotkin, Graham Nelson, Marco Innocenti, the community on the Puny Discord server, the authors of all the free and open-sourced utilities being used in the backend of the Puny BuildTools, those great individuals who directly or indirectly contributed to this project, Sebastian Bach from PolyPlay, Ant Stiller, the ZZAP!64 crew, Jason Scott and most importantly the great masters themselves, once known as Infocom.
The Puny BuildTools are released under a modified BSD 2-clause license. I strongly encourage you to read the file LICENSE.md before you start working with the project.
Any free or open-sourced software distributed with the Puny BuildTools not written by Stefan Vogt, retains the copyright and license under which it had been released.