Manual:Portable App - Revision history

Zooka: /* Option 2 */

2025-11-25T20:52:57Z

Option 2

Zooka: /* Option 2 */

2025-11-25T20:52:30Z

Option 2

Zooka: /* How To Enable Portable Mode */

2025-11-25T20:52:17Z

How To Enable Portable Mode

Vadi: /* How To Enable Portable Mode */

2024-12-31T11:07:52Z

How To Enable Portable Mode

Zooka at 17:09, 22 December 2024

2024-12-22T17:09:54Z

Zooka at 04:54, 16 December 2024

2024-12-16T04:54:36Z

Zooka at 09:15, 15 December 2024

2024-12-15T09:15:34Z

Zooka: Zooka moved page Portable App to Manual:Portable App: incorporate into manual

2024-08-19T09:48:38Z

Zooka moved page Portable App to Manual:Portable App: incorporate into manual

Zooka: /* Option 2 */

2024-08-12T15:55:36Z

Option 2

Zooka: /* How To Enable Portable Mode */

2024-08-12T15:38:59Z

How To Enable Portable Mode

@@ Line 28: / Line 28: @@
 {{note}} The path can be ''relative''.  A relative path is a way to specify the location of a directory relative to another directory.  In our case it will be interpreted relative to Mudlet's executable folder.
-{{note}} Don't use variables like %userprofile% in the portable.txt file, this will cause errors.
+{{note}} Don't use variables like <code>%userprofile%</code> in the portable.txt file, this will cause errors.
 All sub-directories must exist up to the last part of the given path.  e.g. <code>d:\usb\mudlet</code> must exist if our path is <code>d:\usb\mudlet\mudlet_data</code> and Mudlet will create <code>mudlet_data</code> if it doesn't already exist.  This will otherwise lead to an error.  This is to avoid taking unintended input. If you see this error but this actually is what you want, just create those folders manually.

← Older revision		Revision as of 20:52, 25 November 2025
Line 27:		Line 27:

	{{note}} The path can be ''relative''. A relative path is a way to specify the location of a directory relative to another directory. In our case it will be interpreted relative to Mudlet's executable folder.		{{note}} The path can be ''relative''. A relative path is a way to specify the location of a directory relative to another directory. In our case it will be interpreted relative to Mudlet's executable folder.
		+
	{{note}} Don't use variables like %userprofile% in the portable.txt file, this will cause errors.		{{note}} Don't use variables like %userprofile% in the portable.txt file, this will cause errors.

← Older revision		Revision as of 20:52, 25 November 2025
Line 27:		Line 27:

	{{note}} The path can be ''relative''. A relative path is a way to specify the location of a directory relative to another directory. In our case it will be interpreted relative to Mudlet's executable folder.		{{note}} The path can be ''relative''. A relative path is a way to specify the location of a directory relative to another directory. In our case it will be interpreted relative to Mudlet's executable folder.
		+	{{note}} Don't use variables like %userprofile% in the portable.txt file, this will cause errors.

	All sub-directories must exist up to the last part of the given path. e.g. <code>d:\usb\mudlet</code> must exist if our path is <code>d:\usb\mudlet\mudlet_data</code> and Mudlet will create <code>mudlet_data</code> if it doesn't already exist. This will otherwise lead to an error. This is to avoid taking unintended input. If you see this error but this actually is what you want, just create those folders manually.		All sub-directories must exist up to the last part of the given path. e.g. <code>d:\usb\mudlet</code> must exist if our path is <code>d:\usb\mudlet\mudlet_data</code> and Mudlet will create <code>mudlet_data</code> if it doesn't already exist. This will otherwise lead to an error. This is to avoid taking unintended input. If you see this error but this actually is what you want, just create those folders manually.

@@ Line 15: / Line 15: @@
 === Option 1 ===
-* create an empty <code>portable.txt</code> file in the same directory as the Mudlet executable (or appimage etc.) e.g. <code>d:\usb\mudlet\portable.txt</code>
+* create an empty <code>portable.txt</code> file in the same directory as the <code>mudlet.exe</code> (or Appimage on Linux) e.g. <code>d:\usb\mudlet\portable.txt</code>
 This will tell Mudlet to use a directory named <code>portable</code> (in the same directory as the executable) for its data. e.g. <code>d:\usb\mudlet\portable\</code>

← Older revision		Revision as of 17:09, 22 December 2024
Line 1:		Line 1:
−	{{note}} Available since 4.20.	+	{{note}} Available since 4.19.

	Portable in this sense is defined as "A portable application (portable app), sometimes also called standalone, is a program designed to read and write its configuration settings into an accessible folder in the computer, usually the folder where the portable application can be found. This makes it easier to transfer the program with the user's preferences and data between different computers." -- https://en.wikipedia.org/wiki/Portable_application		Portable in this sense is defined as "A portable application (portable app), sometimes also called standalone, is a program designed to read and write its configuration settings into an accessible folder in the computer, usually the folder where the portable application can be found. This makes it easier to transfer the program with the user's preferences and data between different computers." -- https://en.wikipedia.org/wiki/Portable_application

← Older revision		Revision as of 04:54, 16 December 2024
Line 1:		Line 1:
−	{{note}} Available since 4.19.	+	{{note}} Available since 4.20.

	Portable in this sense is defined as "A portable application (portable app), sometimes also called standalone, is a program designed to read and write its configuration settings into an accessible folder in the computer, usually the folder where the portable application can be found. This makes it easier to transfer the program with the user's preferences and data between different computers." -- https://en.wikipedia.org/wiki/Portable_application		Portable in this sense is defined as "A portable application (portable app), sometimes also called standalone, is a program designed to read and write its configuration settings into an accessible folder in the computer, usually the folder where the portable application can be found. This makes it easier to transfer the program with the user's preferences and data between different computers." -- https://en.wikipedia.org/wiki/Portable_application

← Older revision		Revision as of 09:15, 15 December 2024
Line 1:		Line 1:
−	~~The latest '''development''' versions of Mudlet can be run as a portable app~~.	+	{{note}} Available since 4.19.

	Portable in this sense is defined as "A portable application (portable app), sometimes also called standalone, is a program designed to read and write its configuration settings into an accessible folder in the computer, usually the folder where the portable application can be found. This makes it easier to transfer the program with the user's preferences and data between different computers." -- https://en.wikipedia.org/wiki/Portable_application		Portable in this sense is defined as "A portable application (portable app), sometimes also called standalone, is a program designed to read and write its configuration settings into an accessible folder in the computer, usually the folder where the portable application can be found. This makes it easier to transfer the program with the user's preferences and data between different computers." -- https://en.wikipedia.org/wiki/Portable_application

← Older revision	Revision as of 09:48, 19 August 2024
(No difference)

@@ Line 26: / Line 26: @@
 change the (empty) contents of the file to a directory on your filesystem where you want Mudlet data to be stored.  This will tell Mudlet to use the directory written in the file as the location for its data.  e.g. the file contents could be <code>d:\usb\mudlet\mudlet_data</code>.
-{{note}} The path can be ''relative<''.  A relative path is a way to specify the location of a directory relative to another directory.  In our case it will be interpreted relative to Mudlet's executable folder.
+{{note}} The path can be ''relative''.  A relative path is a way to specify the location of a directory relative to another directory.  In our case it will be interpreted relative to Mudlet's executable folder.
 All sub-directories must exist up to the last part of the given path.  e.g. <code>d:\usb\mudlet</code> must exist if our path is <code>d:\usb\mudlet\mudlet_data</code> and Mudlet will create <code>mudlet_data</code> if it doesn't already exist.  This will otherwise lead to an error.  This is to avoid taking unintended input. If you see this error but this actually is what you want, just create those folders manually.

@@ Line 21: / Line 21: @@
 === Option 2 ===
-* create a <code>~/.config/mudlet/portable.txt</code> file with the contents being a directory on your filesystem where you want Mudlet data to be stored (<code>~</code> is your home directory)
+* Windows: create a <code>%userprofile%/.config/mudlet/portable.txt</code> file
-This will tell Mudlet to use the directory written in the file as the location for its data.  e.g. the file contents could be <code>d:\usb\mudlet\mudlet_data</code>
+change the (empty) contents of the file to a directory on your filesystem where you want Mudlet data to be stored.  This will tell Mudlet to use the directory written in the file as the location for its data.  e.g. the file contents could be <code>d:\usb\mudlet\mudlet_data</code>.
 {{note}} The path can be ''relative<''.  A relative path is a way to specify the location of a directory relative to another directory.  In our case it will be interpreted relative to Mudlet's executable folder.
@@ Line 30: / Line 31: @@
 Any errors will result in the issue being printed to stderr (the console or terminal) and the program terminating. You probably won't see the error outputs if launched from GUI or Start menu so it's recommended to start Mudlet from the terminal until you are sure everything is setup correctly.
 == Migrating Existing Profiles ==