Standalone release guide - Revision history

Spectere: /* Licensing */ Updated DMZX link (.net -> .com)

2020-05-16T23:33:37Z

Licensing: Updated DMZX link (.net -> .com)

← Older revision		Revision as of 23:33, 16 May 2020
Line 34:		Line 34:
	MegaZeux is licensed under the GNU General Public License (GPL) 2.0. A file containing license information is distributed with all MZX releases. This file is called "LICENSE" (or "docs/COPYING.DOC" for older versions) and it '''must''' be included with your standalone release. The contents of this file should '''not''' be modified.		MegaZeux is licensed under the GNU General Public License (GPL) 2.0. A file containing license information is distributed with all MZX releases. This file is called "LICENSE" (or "docs/COPYING.DOC" for older versions) and it '''must''' be included with your standalone release. The contents of this file should '''not''' be modified.

	In addition to including the license in your release, you should provide a link to https://digitalmzx.~~net~~/ with your game or on any other website your game is released to. Releases of GPL software such as MegaZeux must have accessible source code, and this is the simplest way to fulfill this requirement. However, if you modified the MegaZeux source code for your game, you must provide ALL modifications you made to the source code with your release. If you fail to do this, ''you are in violation of the GPL!''		In addition to including the license in your release, you should provide a link to https://digitalmzx.com/ with your game or on any other website your game is released to. Releases of GPL software such as MegaZeux must have accessible source code, and this is the simplest way to fulfill this requirement. However, if you modified the MegaZeux source code for your game, you must provide ALL modifications you made to the source code with your release. If you fail to do this, ''you are in violation of the GPL!''

	As your MegaZeux game is considered essentially data files for MegaZeux, you may apply your own license to those data files (i.e. they do not need to be licensed under the GPL). In the case that your game isn't GPL licensed, you should rename the "LICENSE" file to something like "LICENSE.MEGAZEUX" and provide your own "LICENSE" file containing the license for your game files.		As your MegaZeux game is considered essentially data files for MegaZeux, you may apply your own license to those data files (i.e. they do not need to be licensed under the GPL). In the case that your game isn't GPL licensed, you should rename the "LICENSE" file to something like "LICENSE.MEGAZEUX" and provide your own "LICENSE" file containing the license for your game files.


	==Configuration==		==Configuration==

Lachesis: /* Linux/Raspbian/BSD/MacPorts/Android/etc. */

2020-05-16T21:31:39Z

Linux/Raspbian/BSD/MacPorts/Android/etc.

← Older revision		Revision as of 21:31, 16 May 2020
Line 29:		Line 29:

	#!/bin/sh		#!/bin/sh
	/usr/bin/env mzxrun /PATH/TO/MY_GAME.MZX standalone_mode=1 [etc]		/usr/bin/env mzxrun /PATH/TO/MY_GAME.MZX standalone_mode=1 [etc]

	==Licensing==		==Licensing==

Lachesis: /* Linux/Raspbian/BSD/MacPorts/Android/etc. */

2020-05-16T21:31:30Z

Linux/Raspbian/BSD/MacPorts/Android/etc.

← Older revision		Revision as of 21:31, 16 May 2020
Line 29:		Line 29:

	#!/bin/sh		#!/bin/sh
	mzxrun /PATH/TO/MY_GAME.MZX standalone_mode=1 [etc]		/usr/bin/env mzxrun /PATH/TO/MY_GAME.MZX standalone_mode=1 [etc]

	==Licensing==		==Licensing==

Lachesis: /* Linux/Raspbian/BSD/MacPorts/Android/etc. */

2020-05-16T21:28:19Z

Linux/Raspbian/BSD/MacPorts/Android/etc.

← Older revision		Revision as of 21:28, 16 May 2020
Line 26:		Line 26:
	These platforms do not really support standalone releases in the way they are defined here. In fact, if you attempted a standalone release in the way described for Windows, it's probable you'll end up with a package that directly conflicts with the official MegaZeux release packages!		These platforms do not really support standalone releases in the way they are defined here. In fact, if you attempted a standalone release in the way described for Windows, it's probable you'll end up with a package that directly conflicts with the official MegaZeux release packages!

	Instead, you should consider packaging your game for the package manager for a given operating system and make your game's package dependent on the MegaZeux package. The settings documented below can be provided as command line arguments, so your game "executable" could just be a script like this:		Instead, you should consider packaging your game for the package manager for a given operating system and make your game's package dependent on the official MegaZeux package. The settings documented below can be provided as command line arguments, so your game "executable" could just be a script like this:

	#!/bin/sh		#!/bin/sh

Lachesis: /* Linux/Raspbian/BSD/MacPorts/Android/etc. */

2020-05-16T21:07:54Z

Linux/Raspbian/BSD/MacPorts/Android/etc.

← Older revision		Revision as of 21:07, 16 May 2020
Line 26:		Line 26:
	These platforms do not really support standalone releases in the way they are defined here. In fact, if you attempted a standalone release in the way described for Windows, it's probable you'll end up with a package that directly conflicts with the official MegaZeux release packages!		These platforms do not really support standalone releases in the way they are defined here. In fact, if you attempted a standalone release in the way described for Windows, it's probable you'll end up with a package that directly conflicts with the official MegaZeux release packages!

	Instead, you should consider packaging your game for the package manager for ~~the~~ given operating system and make your game's package dependent on the MegaZeux package. The settings documented below can be provided as command line arguments, ~~and then~~ your game "executable" could just be a script like this:		Instead, you should consider packaging your game for the package manager for a given operating system and make your game's package dependent on the MegaZeux package. The settings documented below can be provided as command line arguments, so your game "executable" could just be a script like this:

	#!/bin/sh		#!/bin/sh

Lachesis: Update platforms, add note for Linux/Raspbian/BSD/MacPorts/Android/etc

2020-05-16T21:05:23Z

Update platforms, add note for Linux/Raspbian/BSD/MacPorts/Android/etc

← Older revision		Revision as of 21:05, 16 May 2020
Line 4:		Line 4:
	The following platforms support standalone releases. Click the link for a platform for more information on how to modify a release for that platform.		The following platforms support standalone releases. Click the link for a platform for more information on how to modify a release for that platform.

			* [[Standalone_release_guide/Emscripten\|HTML5/JavaScript (Emscripten)]]
	* [[Standalone_release_guide/Windows\|Windows (x86)]]: should support all 32-bit and 64-bit Windows releases back to at least Windows XP.		* [[Standalone_release_guide/Windows\|Windows (x86)]]: should support all 32-bit and 64-bit Windows releases back to at least Windows XP.
	* [[Standalone_release_guide/Windows\|Windows (x64)]]: should support all 64-bit Windows releases.		* [[Standalone_release_guide/Windows\|Windows (x64)]]: should support all 64-bit Windows releases.
Line 11:		Line 12:
	* [[Standalone_release_guide/NDS\|Nintendo NDS]]: must be used via a homebrew launcher/flash card.		* [[Standalone_release_guide/NDS\|Nintendo NDS]]: must be used via a homebrew launcher/flash card.
	* [[Standalone_release_guide/Wii\|Nintendo Wii]]: must be used via a homebrew launcher.		* [[Standalone_release_guide/Wii\|Nintendo Wii]]: must be used via a homebrew launcher.
			* [[Standalone_release_guide/Switch\|Nintendo Switch]]: must be used via a homebrew launcher.
	* [[Standalone_release_guide/PSP\|PlayStation Portable]]		* [[Standalone_release_guide/PSP\|PlayStation Portable]]

	The following upcoming platforms ~~will~~ also support standalone releases:		The following upcoming platforms should also support standalone releases:

	* [[Standalone_release_guide/~~Emscripten~~\|~~HTML5/JavaScript (Emscripten)~~]]		* [[Standalone_release_guide/PSVita\|PlayStation Vita]]
	* [[Standalone_release_guide/~~Switch~~\|~~Nintendo Switch~~]]		* [[Standalone_release_guide/Dreamcast\|Sega Dreamcast]]

	===Which platforms do I need releases for?===		===Which platforms do I need releases for?===
	Releasing simply a copy of Windows x86 should be enough for now. Standalone releases for Linux/BSD/etc 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.		Releasing simply a copy of Windows x86 should be enough for now. Standalone releases for Linux/BSD/etc 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.

			===Linux/Raspbian/BSD/MacPorts/Android/etc.===
			These platforms do not really support standalone releases in the way they are defined here. In fact, if you attempted a standalone release in the way described for Windows, it's probable you'll end up with a package that directly conflicts with the official MegaZeux release packages!

			Instead, you should consider packaging your game for the package manager for the given operating system and make your game's package dependent on the MegaZeux package. The settings documented below can be provided as command line arguments, and then your game "executable" could just be a script like this:

			#!/bin/sh
			mzxrun /PATH/TO/MY_GAME.MZX standalone_mode=1 [etc]

	==Licensing==		==Licensing==

Lachesis: "Nintendo PSP"

2019-04-19T01:09:22Z

"Nintendo PSP"

← Older revision		Revision as of 01:09, 19 April 2019
Line 11:		Line 11:
	* [[Standalone_release_guide/NDS\|Nintendo NDS]]: must be used via a homebrew launcher/flash card.		* [[Standalone_release_guide/NDS\|Nintendo NDS]]: must be used via a homebrew launcher/flash card.
	* [[Standalone_release_guide/Wii\|Nintendo Wii]]: must be used via a homebrew launcher.		* [[Standalone_release_guide/Wii\|Nintendo Wii]]: must be used via a homebrew launcher.
	* [[Standalone_release_guide/PSP\|~~Nintendo PSP~~]]		* [[Standalone_release_guide/PSP\|PlayStation Portable]]

	The following upcoming platforms will also support standalone releases:		The following upcoming platforms will also support standalone releases:

Lachesis at 01:02, 19 April 2019

2019-04-19T01:02:13Z

← Older revision		Revision as of 01:02, 19 April 2019
Line 1:		Line 1:
	~~==Getting Started==~~		MegaZeux has limited support for standalone game releases. This guide is intended to help you create a copy of your game that a user can play without needing to download MZX.
	~~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?=~~==		==Platforms==
	~~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~~.		The following platforms support standalone releases. Click the link for a platform for more information on how to modify a release for that platform.

	~~===Which files do I need~~ to ~~include?===~~		* [[Standalone_release_guide/Windows\|Windows (x86)]]: should support all 32-bit and 64-bit Windows releases back to at least Windows XP.
	~~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~~.		* [[Standalone_release_guide/Windows\|Windows (x64)]]: should support all 64-bit Windows releases.
			* [[Standalone_release_guide/Mac OS X\|Mac OS X (Intel)]]: the "Universal" DMG should support all Intel-based Macs.
			* [[Standalone_release_guide/Mac OS X\|Mac OS X (PowerPC)]]: the "PowerPC" DMG should support some PowerPC-based Macs.
			* [[Standalone_release_guide/3DS\|Nintendo 3DS]]: must be used via a homebrew launcher.
			* [[Standalone_release_guide/NDS\|Nintendo NDS]]: must be used via a homebrew launcher/flash card.
			* [[Standalone_release_guide/Wii\|Nintendo Wii]]: must be used via a homebrew launcher.
			* [[Standalone_release_guide/PSP\|Nintendo PSP]]

	~~mzxrun.exe (this can be renamed or have the icon changed)~~		The following upcoming platforms will also support standalone releases:
	~~core.dll MegaZeux core library~~
	~~sdl.dll SDL library (2.80 to 2.84c)~~
	~~SDL2.dll SDL library (2.90+)~~
	~~config.txt Config file (see [[#Configuration]]).~~
	~~assets/ Most of this directory is mandatory. For best results include the entire thing; otherwise, MZX~~ will ~~fail to start.~~

	~~docs/COPYING.DOC Mandatory to fulfill GPL 2.0 requirements (2.80 to 2.90d)~~

	~~LICENSE Mandatory to fulfill GPL 2.0 requirements (2.91+)~~

	~~In addition to including the license 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.~~		* [[Standalone_release_guide/Emscripten\|HTML5/JavaScript (Emscripten)]]
			* [[Standalone_release_guide/Switch\|Nintendo Switch]]

	~~Only use files from the same release of MegaZeux; e.g.,~~ do ~~NOT mix "mzxrun.exe" and "core.dll" or "assets/" from different~~ releases of ~~MegaZeux~~. Do not ~~modify these files unless you know what you are doing~~, and ~~NEVER modify~~ the ~~license file (unless you are renaming it to "LICENSE.MEGAZEUX" or similar)~~.		===Which platforms do I need releases for?===
			Releasing simply a copy of Windows x86 should be enough for now. Standalone releases for Linux/BSD/etc 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.


	==~~=Can my release to DMZX include these files?=~~==		==Licensing==
	~~Yes~~. ~~Still,~~ it should ~~include all of~~ the ~~files listed above and~~ a link to the MegaZeux source ~~somewhere~~ in your game'~~s archive~~.		MegaZeux is licensed under the GNU General Public License (GPL) 2.0. A file containing license information is distributed with all MZX releases. This file is called "LICENSE" (or "docs/COPYING.DOC" for older versions) and it '''must''' be included with your standalone release. The contents of this file should '''not''' be modified.

			In addition to including the license in your release, you should provide a link to https://digitalmzx.net/ with your game or on any other website your game is released to. Releases of GPL software such as MegaZeux must have accessible source code, and this is the simplest way to fulfill this requirement. However, if you modified the MegaZeux source code for your game, you must provide ALL modifications you made to the source code with your release. If you fail to do this, ''you are in violation of the GPL!''

			As your MegaZeux game is considered essentially data files for MegaZeux, you may apply your own license to those data files (i.e. they do not need to be licensed under the GPL). In the case that your game isn't GPL licensed, you should rename the "LICENSE" file to something like "LICENSE.MEGAZEUX" and provide your own "LICENSE" file containing the license for your game files.


	==Configuration==		==Configuration==

Lachesis: /* Configuration */

2018-08-27T03:21:33Z

Configuration

← Older revision		Revision as of 03:21, 27 August 2018
Line 31:		Line 31:

	startup_file Specifies a local path from the startup path to a .MZX file. This file is loaded automatically upon starting MegaZeux.		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~~.		startup_path Specifies a relative or absolute path for MZX to startup in. May be necessary for some platforms.
	standalone_mode See below.		standalone_mode See below.
	no_titlescreen See below.		no_titlescreen See below.

Lachesis at 08:06, 15 January 2018

2018-01-15T08:06:32Z

← Older revision		Revision as of 08:06, 15 January 2018
Line 21:		Line 21:
	In addition to including the license 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.		In addition to including the license 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.

	~~Note that it is not necessary that many of these~~ files be the same ~~as those that ship with MZX~~; ~~the~~ files ~~must only exist in name. However~~, the license file ~~must be unmodified~~.		Only use files from the same release of MegaZeux; e.g., do NOT mix "mzxrun.exe" and "core.dll" or "assets/" from different releases of MegaZeux. Do not modify these files unless you know what you are doing, and NEVER modify the license file (unless you are renaming it to "LICENSE.MEGAZEUX" or similar).


	===Can my release to DMZX include these files?===		===Can my release to DMZX include these files?===