Pentagram needs a pentagram.ini file to point it to the game data files. The location of the file varies depending on the Operating System and in the case of Windows OS it also depends on the version of Windows.

• On Linux, pentagram.ini has to be in the ~/.pentagram directory.
• On Mac OS X, it has to be in the ~/Library/Application Support/Pentagram folder. Unfortunately ~/Library is hidden on OS X Lion, to open this folder click on the "Go" menu item of Finder while pressing 'Option/Alt'
• Windows 95, 98, 98 SE and ME save the ini to the folder where you installed Pentagram to (by default C:\Program Files\Pentagram)
• Windows 2000 and XP save pentagram.ini to APPDATA\Pentagram, which translates to C:\Documents and Settings\YourUsername\Application Data\Pentagram for an English version of Windows.
• Windows Vista and Windows 7 also save pentagram.ini to APPDATA\Pentagram, but on these this translates to C:\Users\YourUsername\AppData\Roaming\Pentagram
• On Windows 2000, XP, Vista and 7 you can quickly access this folder by executing shell:AppData\Pentagram in the "Run" entry of the Startmenu (or the "Run or Search" entry of the Windows Vista and 7 Startmenu)

A sample pentagram.ini is included below (this is all that is needed at the moment to run Pentagram). Comments are marked with # and are above the ini-entries.
You can copy/paste these settings with the comments to your ini file as Pentagram will ignore lines beginning with #.

Right now Pentagram assumes some default settings that don't need to be set to make Pentagram work. The settings below are the default settings.

You may also override most settings under [pentagram] by writing them under [u8]. Except for defaultgame all can be overriden.
Right now this is not necessary as we only support U8 but if we start to support other games it might come in handy.

MIDI used on Linux might need some fine tuning in pentagram.ini to work correctly. Below are the settings you can configure.

• Double-click with the right mouse button will make the Avatar find a path to the selected spot.
• Left-click on NPCs or objects to identify them.
• Double-left-click on NPCs or objects to initiate conversations or use the item.
• On pressing the right mouse button down the Avatar walks or runs (depending on distance between cursor and Avatar).
• Pressing right and left mouse button, makes the Avatar jump or while running a running jump.

All key commands of Pentagram can be changed by editing u8bindings.ini or via the options menu in the game.
We are distinguishing between default keyboard commands and debug keyboard commands that are used to help debugging the engine. At the moment you can't turn off the debug commands.

Pentagram has a debugging console with various useful commands. A selection is listed below.

At the moment we only support the English versions of Ultima 8, both pre-patch and post-patch. The German, French, Spanish versions should also work, but are less well-tested. The Japanese version has a chance of working, but has hardly been tested at all.

Before you build Pentagram, make sure you have the following tools/libraries.

• SDL;
• SDL_ttf;
• zlib;
• libpng;
• for Linux/Unix, you need autoconf and automake.

1. Run the "bootstrap" script to create the "configure" script:
   ./bootstrap
2. Now run configure:
   ./configure
3. Finally, start the build as usual:
   make

nothing here yet

Under OS X, the dependencies are built into the application bundle as embedded libraries. Pentagram provides makefiles to build the dependencies appropriately. Internally, the OS X specific makefiles use normal unix-style configure & make to build Pentagram and all dependencies.

For the build, you should install XCode and the SDK for OS X 10.4 as it is currently the oldest supported version of OS X for the official builds. The build may still work on older versions or if the SDK is missing, but it will attempt target your version of OS X by default. Additional editing of system/macosx/archs.mk may be required for some configurations.

You also should ensure /Developer/usr/bin is in you PATH environment variable. You can do this by adding the following to ~/.profile
export PATH=$PATH:/Developer/usr/bin

Lastly, you may need to add configuration for autoconf and associated tools to work correctly. The following is a sample version of this configuration is in system/macosx/autom4te.cfg. Copy the contents of that file to ~/.autom4te.cfg if the "bootstrap" script encounters problems.

After completing the system configuration listed above, perform the following steps to build Pentagram.

1. Run the "bootstrap" script to create the "configure" script:
   ./bootstrap
2. Build all dependencies:
   make -f Makefile.macosx deps
3. Build Pentagram:
   make -f Makefile.macosx build
4. Build Pentagram.app:
   make -f Makefile.macosx bundle
5. Build disk image:
   make -f Makefile.macosx image
6. The disk image is located in the build directory and contains the universal binary

1.2. Advanced Configuration: More scalers and soundfont setting for FluidSynth and CoreAudio.

1.2. Advanced Configuration: added a lot of settings.
2.1. Movement: no more keypad movement and the not for Mac OS is no longer needed.
2.2. Keyboard commands: updated and split in default and debug keys.
Moved the Building SVN section to the bottom.

4.4. Mac OS X: added additional information for builds.

4.4. Mac OS X: replaced old build instructions.

3.1. Console commands: added (short) list of console commands.

3.2. Supported games and versions: updated status of non-English U8.

1.2. Advanced Configuration some more configurations added.
1.3. Optional MIDI settings for Linux added.

cleaned up outdated sections

1.2. Advanced Configuration enable font replacement.