Standalone release guide

robble robble robble

Getting Started

Download a fresh copy of the latest version of MegaZeux and extract it to a new folder.

Which architectures do I need to release under?

Releasing simply a copy of Windows x86 should be enough to satisfy the majority of people who will play your game. For Mac OS X users, it is recommended that you use the Universal DMG. Standalone releases for Linux platforms are not recommended, as most Linux users will be able to figure out how to use MegaZeux normally and play the standard release of your game.

Which files do I need to include?

These are the only files mandatory to run a MegaZeux game--all other files can be safely deleted for your standalone release. Please note that as of MegaZeux 2.84c, several features will not correctly work from this setup, including the editor, help file, and updater.

mzxrun.exe        (can be renamed or have the icon changed)
core.dll          MegaZeux core library
sdl.dll           SDL library
config.txt        Config file (see #Configuration)
assets/shaders/   If you intend to allow users to use the GLSL renderer, this is mandatory.
docs/COPYING.DOC  Mandatory to fulfill GPL requirements

In addition to including COPYING.DOC in your release, it is recommended that you provide a link to http://digitalmzx.net/ on any other website your game is released to, as releases of GPL software such as MegaZeux must have accessible source code.

Configuration

Your game can be further integrated into MegaZeux by the following config.txt options:

startup_file      Specifies a local path from the startup path to a .MZX file.  This file is loaded automatically upon starting MegaZeux.
startup_path      Specifies an absolute path for MZX to startup in.  May be necessary for Mac OS X due to unreliable default startup paths.

Using the MegaZeux built-in updater to allow users to update the game or MZX version

By hosting your own updater repository on the Internet and configuring MegaZeux's updater to point to that repository, you can use the updater to quickly and effectively allow users to download updates. {{{stub}}}