Sublime Forum

**IPWright83** · September 11, 2024, 8:39am

I’m trying to create my first couple of SublimeText plugins and the docs suggest I need to include the .sublime-package file. But I can’t work out how to do so and looking for tips?

I’m using Github, and it doesn’t look like authors include the sublime-package in repository code. So I’ve created a Tag manually, created a Release from this Tag and intended to upload the .sublime-package file to the release - however it’s not a valid file type in GitHub. So I’m a bit stumped. Can anyone help?

Thanks!

**jfcherng** · September 11, 2024, 9:08am

.sublime-package is auto created by Package Control during downloading.

I believe Package Control download zip tarball by github tags, add a meta file into it and rename/repack it into a .sublime-package file, which is just a zip file with a different file extension.

**IPWright83** · September 11, 2024, 9:09am

Do you know if there’s a worked example somewhere? I’ve tried looking at a few existing plugins to see how they work and they’re all terribly inconsistent leaving me more confused

**jfcherng** · September 11, 2024, 9:15am

Not sure what you have seen but it’s literally how most (like >90% or maybe >95%) plugins work. And… there is nothing to see actually. It’s the default behavior…

**jfcherng** · September 11, 2024, 9:14am

If you must want an example: https://github.com/glutanimate/sublime-deselect
Those are ALL source codes of the https://packagecontrol.io/packages/Deselect plugin.

**IPWright83** · September 11, 2024, 9:23am

Hmm ok, thanks. So looking there there doesn’t seem to be any “.sublime-package” at all. Maybe I’ll try without and see what happens!

**deathaxe** · September 11, 2024, 9:31am

Just create a github repository for each package.
Create SemVer compatible release tags
Register the repository to Package Control’s default channel to be public.

Example:

A File Icon

Repository:

https://github.com/SublimeText/AFileIcon

Channel entry

github.com

wbond/package_control_channel/blob/03123d0785d4ffb5cfa8b8ab905645180e86a4ad/repository/a.json#L4-L16


		{
			"name": "A File Icon",
			"previous_names": ["File Icons Extended", "zz File Icons"],
			"details": "https://github.com/SublimeText/AFileIcon",
			"author": ["ihodev", "DeathAxe"],
			"labels": ["theme", "file", "icons"],
			"releases": [
				{
					"sublime_text": ">=3114",
					"tags": true
				}
			]
		},

You can attach sublime-package files for manual installation by

git archive --format zip -o "Package.sublime-package" master from your local checked out worktree
attach them to a GH release using “gh” CLI tool gh release create ...

Some authors of closed source packages decided to prebuild such sublime-package files and register direct links to them, but that’s not recommended for simple open-source packages using pure python plugins.

**IPWright83** · September 11, 2024, 10:53am

Ok thanks! I’ve updated the package repository so will see if it get’s accepted.

How to host a .sublime-package in GitHub

Example: