- Package Locations (and Abbreviations)
- Package Contents
- Types of Packages
- Managing Packages
- Customizing or Overriding Packages
- Merging and Order of Precedence
- Reverting Sublime Text to Its Default Configuration
There are three locations for storing packages for different purposes.
Packages can be folders under
or zip archives with the
.sublime-packageextension located under
Installed Packages) or any of its subdirectories.
Additionally, Sublime Text provides a set of default packages as zip archives in
Shipped Packages), where
Applicationrefers to the folder where the Sublime Text executable resides.
This folder is not intended to be modified by the user.
For simplicity, we will occasionally
refer to all these directories simply as
and to a package in any folder
.sublime-package or not)
Consequently, a file inside a package
may also be referred to as
Packages distributed as
.sublime-package zip archives
should be considered read-only containers of resources
and never be modified manually.
Since they are usually updated as a whole,
any manual changes made to them
will be lost in the process.
If you do want to modify files in these archives, see Customizing or Overriding Packages.
If two packages with the same name exist
Installed Packages and
the one in
Installed Packages will be used
and the one in
Shipped Packages will be ignored.
Any file in
Packages/PackageName takes precedence
over an identically named file
See also Customizing or Overriding Packages.
Typical resources found in packages include:
Some packages may hold support files
for other packages or for core features.
For example, the spell checker
Installed Packages/Language - English.sublime-package
as a data store for English dictionaries.
In this guide, we categorize packages for clarity when discussing this topic, but Sublime Text doesn’t use this terminology and you don’t need to learn it.
- shipped packages
A set of packages that Sublime Text ships with. Some of these packages are core packages, while others enhance Sublime Text to support common programming languages out of the box.
Examples: Default, Python, Java, C++, Markdown.
- core packages
Sublime Text requires these packages in order to function properly.
Examples: Default, Theme - Default, Color Scheme - Default.
They are part of the shipped packages and located in
- user packages
Installed or created by the user to extend Sublime Text’s functionality. They are not part of Sublime Text, and are always contributed by users or third parties.
- installed packages
A subtype of user packages.
Installed packages are
.sublime-packagearchives and usually maintained by a package manager.
Due to the unfortunate name of this folder, talking about installing packages in Sublime Text is confusing.
Sometimes, in this guide, by installing we mean ‘adding a user/third party package to Sublime Text’ (in any form), and sometimes we use the term in its stricter sense of ‘copying a
- override packages
A special type of user packages.
Override packages serve the purpose of customizing packages that are distributed as
.sublime-packagefiles. They are effectively injected into the original package and do not stand-alone.
See Customizing or Overriding Packages for details.
Note that by third party we also refer to users of other editors, notably Textmate, as Sublime Text and Textmate share some types of resource files that can be reused without modification.
Regular users rarely need to know how to install packages by hand, as automatic package managers are available.
The de facto package manager for Sublime Text is Package Control.
Packages can be installed in two main ways:
- by copying Sublime Text resources
to a folder under
- by copying a
To temporarily disable packages,
you can add them to the
Packages will be loaded or unloaded as needed
when the settings file is saved.
To re-enable a package,
remove the package’s name from the
If you installed a package with a package manager, remove it using the method provided by the package manager.
If you installed a package manually, follow this procedure to safely remove a package:
- Disable the package while Sublime Text is running.
- Close Sublime Text.
- Remove the package’s resources from the disk.
- Remove the package’s name from the
In addition to the resources
you have placed initially
Packages folder or in
plugins may create configuration files
or other files to store package-related data.
Frequently, you will find them in the User package.
Therefore, if you want to remove all traces of a package,
you will need to find and remove all the additional files
that it may have installed.
Shipped packages are reinstated during every Sublime Text update, so you can’t delete them forever. If you want to stop using a shipped package, disable it.
Since packages in
.sublime-package zip archives
you cannot modify them directly.
However, Sublime Text allows you
to create an override package
that will effectively inject files into the original archive
without modifying the archive itself.
To create an override package,
create a new folder under
and name it after the
you want to override, excluding the extension.
Any file you create in this package
will take precedence over any identically named file
in the original package.
Python plugins in override packages
are able to use relative imports
for accessing other modules in the corresponding
as if they were part of it.
Files in override packages override entire files.
If the overriden file in the corresponding
.sublime-package is updated,
you will not be notified.
Package precedence is important for merging certain resources,
and for loading plugins (
If an override package exists
it will be loaded at the same time as the
Sublime Text loads packages in this order:
Reverting Sublime Text to a fresh state solves many problems that appear to be bugs in Sublime Text but are in fact caused by misbehaving packages and plugins.
To revert Sublime Text to its default configuration
and remove all your settings and configurations,
delete the data directory
and restart the editor.
Keep in mind
Installed Packages folder will be deleted too,
so you’ll lose all your installed packages.
Always make sure to back up your data before taking an extreme measure like this one!