Difference between revisions of "Mudlet File Locations"

From Mudlet
Jump to navigation Jump to search
(Simple documentation of Mudlet config/profiles directory.)
 
(portable app note)
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__TOC__
 +
 
This page describes where you can find various files related to or created by Mudlet on your computer.
 
This page describes where you can find various files related to or created by Mudlet on your computer.
  
Line 5: Line 7:
 
The home directory changes based on your Operating System, your username, and some Environment variable if you set them.
 
The home directory changes based on your Operating System, your username, and some Environment variable if you set them.
  
 +
{{note}} Paths may be different if using Mudlet as a [[Portable_App|portable app]].
  
== Default File Paths ==
+
== Default file paths ==
  
 
By default, the paths for each OS should match the following locations:  
 
By default, the paths for each OS should match the following locations:  
Line 19: Line 22:
  
  
== Technical Specifics ==
+
== Technical specifics ==
  
 
Mudlet uses <code>QDir::homePath()</code> to determine the "Home Path" for the user currently running Mudlet.  As such, the resulting path can be changed if the user does not have an existing home directory or if certain system Environment Variables are set differently for the application instance.   
 
Mudlet uses <code>QDir::homePath()</code> to determine the "Home Path" for the user currently running Mudlet.  As such, the resulting path can be changed if the user does not have an existing home directory or if certain system Environment Variables are set differently for the application instance.   
  
Please check the [https://doc.qt.io/qt/qdir.html#home Qt Documentation for QDir::homePath()] to learn more, if you're having issues with the defaults listed above.
+
Please check the [https://doc.qt.io/qt/qdir.html#homePath Qt Documentation for QDir::homePath()] to learn more, if you're having issues with the defaults listed above.
 +
 
 +
== Locations of Mudlet itself ==
 +
 
 +
* Windows for official releases: <code>C:\Users\<username>\AppData\Local\Mudlet\app-<x.y.z>\Mudlet.exe</code>
 +
* Windows for PTB releases: <code>C:\Users\<username>\AppData\Local\Mudlet-PublicTestBuild\app-<x.y.z>ptb<code>\Mudlet PTB.exe</code>

Latest revision as of 13:38, 12 August 2024

This page describes where you can find various files related to or created by Mudlet on your computer.

Generally all Mudlet configs and profile data can be found in your user home directory, under .config/mudlet/

The home directory changes based on your Operating System, your username, and some Environment variable if you set them.

Note Note: Paths may be different if using Mudlet as a portable app.

Default file paths

By default, the paths for each OS should match the following locations:

  • On Windows: C:\Documents and Settings\USERNAME\.config\mudlet
Or: %userprofile%\.config\mudlet
  • On Linux: /home/USERNAME/.config/mudlet
Or: ~/.config/mudlet
  • On Mac: /Users/USERNAME/.config/mudlet
Or: ~/.config/mudlet

Replace USERNAME in the paths above with your own username.


Technical specifics

Mudlet uses QDir::homePath() to determine the "Home Path" for the user currently running Mudlet. As such, the resulting path can be changed if the user does not have an existing home directory or if certain system Environment Variables are set differently for the application instance.

Please check the Qt Documentation for QDir::homePath() to learn more, if you're having issues with the defaults listed above.

Locations of Mudlet itself

  • Windows for official releases: C:\Users\<username>\AppData\Local\Mudlet\app-<x.y.z>\Mudlet.exe
  • Windows for PTB releases: C:\Users\<username>\AppData\Local\Mudlet-PublicTestBuild\app-<x.y.z>ptb\Mudlet PTB.exe