How to install sublime package without package control?

Question

How can I install a sublimetext3 package manually, without the package control. I am trying to fix a bug in an existing package, therefore I need a way to test my changes.

what are the naming conventions to be followed when naming the zip file? Where do I place it? what other configurations I have to do?

Answer 1

Download the ZIP, and then place it in your Packages directory which can be found by doing Sublime Text -> Preferences -> Browse Packages...

what are the naming conventions to be followed when naming the zip file? Where do I place it? what other configurations I have to do?

This really depends on the specific package you are downloading. For some packages, you can name it whatever you want. For others, the name has to be exact. If you are downloading these packages manually from GitHub, I urge you to read the documentation in the README. They usually provide instructions for manual installation. For example, if you wanted to download the Spacegray theme manually, it tells you to download the ZIP, unzip the folder, and rename it to Theme - Spacegray.

Answer 2

Depending on your OS, your package directory might be one of these and for most of the packages, just extract the content to this folder (with it's root folder as the name)

Linux: ~/.config/sublime-text-3/Packages

OS X: ~/Library/Application Support/Subime Text 3/Packages

Windows: %APPDATA%\\Sublime Text 3

Answer 3

I am trying to fix a bug in an existing package, therefore I need a way to test my changes.

I was in the same situation. The accepted answer didn't work for me because Package Control would automatically remove the folder. I found this to be helpful:

https://packagecontrol.io/docs/customizing_packages

Sublime Text 3 offers the most options for overriding a package. By default, packages will be installed by placing a .sublime-package file in the Install Packages/ folder. Then users may override individual files in the package by creating a folder Packages/{Package Name}/ and placing edited files in there.

Another approach is PackageResourceViewer, which allows you to extract and override individual files from packages, including the built-in packages.

Answer 4

The best answer I think, so far, is this one by @Andreas Haferburg.

The most-upvoted answer also has some really useful information, such as the link to the spacegray package which states:

Manual

You can also install the theme manually:

1. Download the .zip
2. Unzip and rename the folder to Theme - Spacegray
3. Copy the folder into Packages directory, which you can find using the menu item Sublime Text -> Preferences -> Browse Packages...

That is where I first learned about the existence of the Packages folder and how to find its path.

Using those answers together, plus putting in about 1 weekend worth of work into learning about how Sublime Text packages and syntax highlighting work, I wrote the following "Developer Notes & Package Development Tutorial", on GitHub, as well as these "manual installation" instructions.

In short, to "install a package" withOUT Package Control, all you need to do is put the package into your Sublime Text Packages folder, whose path can be found by going to Preferences --> Browse Packages.... The folder name can be anything. It only needs to match what is inside the Installed Packages dir (which is at the same level as the Packages dir) if you want to override an already-installed package which was previously installed by Package Control in "packed" (zip file) format.

The main link you should study, aside from my tutorial, is this: https://packagecontrol.io/docs/customizing_packages.

1. How to manually install a package

Here are some of the key quotes and instructions from my manual installation instructions and tutorial.

Again, note that I am only requiring that the name in the Packages folder be something specific like gcode in the instructions below because my instructions are intended to override a Package-Control-installed package the reader may already have installed. If you want to install for the first time, or make a new package, the folder name you use inside the Packages folder can be anything.

2. Manual installation

In Sublime Text, find the path to your Packages folder by clicking Preferences --> Browse Packages.... This will open up your GUI file manager to the path where Sublime Text packages are stored. For me on Linux Ubuntu 20.04, that's /home/gabriel/.config/sublime-text-3/Packages (even though I am running Sublime Text 4).

Now, extract this package to that folder.

Option 1: the GUI way: click the green "Code" button above --> "Download ZIP" --> save the zip file, extract it to your Packages path above, and rename it to gcode.

OR Option 2 [what I prefer]: the command-line way:

# --------------
# Option 2.A: clone the repo directly into your "Packages" dir
# --------------

# cd to the Packages dir (change this path according to your Packages path above)
cd "$HOME/.config/sublime-text-3/Packages"
# clone the repo
git clone https://github.com/ElectricRCAircraftGuy/sublime_gcode.git
# rename the repo dir to "gcode"
mv sublime_gcode gcode

# --------------
# OR Option 2.B [what I prefer]: clone the repo into wherever you want, and then
# symlink it into your "Packages" dir
# --------------

# clone repo into ~/dev
mkdir -p ~/dev
cd ~/dev
git clone https://github.com/ElectricRCAircraftGuy/sublime_gcode.git
# now symlink it into your Packages dir
ln -si ~/dev/sublime_gcode ~/.config/sublime-text-3/Packages/gcode

That's it! The gcode entry is now instantly available in your syntax highlighting menu.

Developer Notes & Package Development Tutorial

...
...
...

Sublime Text packages and syntax highlighting--how it all works

And here are some really important notes about Sublime Text packages and how Package Control works:

1. Sublime Text packages

Any folder inside of your Sublime Text Packages folder (found via Preferences --> Browse Packages...) is automatically instantly loaded by Sublime Text as a "package".

Packages installed by the Package Control package, however, come in two types:

1. Packed: most packages installed by Package Control are "packed" into a zip file named packageName.sublime-package and are located inside the Installed Packages dir which is at the same level as the Packages dir.
   1. If you manually create a dir inside the Packages dir and name it packageName (to match the packed file above), then any files in it with the same name as those in the packed package will override those in the packed package. See the "Overrides" section here: https://packagecontrol.io/docs/customizing_packages.
2. Unpacked: any package which is installed in the Packages dir is unpacked.
   1. Developers can tell Package Control to unpack a package installed by Package Control by placing a file named .no-sublime-package at the root of their repo. See here: https://packagecontrol.io/docs/submitting_a_package.
   2. Unpacked packages are required if they contain binary executables which need to be run by the system, for instance, as they apparently can't run from inside the packed zip file.

2. Syntax highlighting

Hopefully I got all of this straight.

If you want to learn more about Syntax Highlighting in Sublime Text, and how it maps to scope entries in your Color Scheme, read my tutorial.

2. Test your changes

I am trying to fix a bug in an existing package, therefore I need a way to test my changes.

See also this section in my tutorial:

To modify and test changes to this package locally...

...in case you'd like to change it or contribute to it, follow the "manual installation" instructions above. If you have already installed it via Package Control, then what is in your /home/$USERNAME/.config/sublime-text-3/Packages/gcode folder will override what is in your /home/$USERNAME/.config/sublime-text-3/Installed Packages/gcode.sublime-package zip file which Package Control installed, so long as the folder and file names are the same.

Modify any files in the Packages/gcode dir as desired. Each time you save, the changes will instantly be reflected in all Sublime Text editors you have open. As a quick test:

1. Open a gcode file.
2. Click your cursor on some text in the file.
3. Use the Tools --> Developer --> Show Scope Name trick to see what the scope is for that text.
4. Open the corresponding *.sublime-syntax file.
5. Change or delete the regular expression in the match entry for that corresponding scope you just found, so that it no longer matches the text on which you placed your cursor.
6. Save the *.sublime-syntax file and you will instantly see the formatting of that text in the gcode file change.
7. Undo your change to the match entry and save again. The formatting will return to how it was.
8. Go to Preferences --> Customize Color Scheme, and add a custom rules entry for that scope, with new formatting for that scope. Save it and watch the formatting instantly change again. Delete that custom entry when done, if desired.