Difference between revisions of "Mudlet File Locations"

From Mudlet
Jump to navigation Jump to search
(Simple documentation of Mudlet config/profiles directory.)
 
(Add TOC)
 
(5 intermediate revisions by the same 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 6: Line 8:
  
  
== 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 21:
  
  
== 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 10:11, 3 September 2022

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.


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