← Back to kkga/spacegray

How to Deploy & Use kkga/spacegray

Spacegray Theme - Deployment & Usage Guide

1. Prerequisites

  • Sublime Text 3 or 4 (Build 3100+ recommended)
  • Package Control (recommended for easiest installation) - install via Command Palette if not already present
  • No additional runtime, build tools, or accounts required

2. Installation

Method A: Via Package Control (Recommended)

  1. Open Command Palette: Tools > Command Palette... or <kbd></kbd><kbd></kbd><kbd>P</kbd> (macOS) / <kbd>Ctrl+Shift+P</kbd> (Windows/Linux)
  2. Type and select: Package Control: Install Package
  3. Search for Theme - Spacegray and press <kbd>Enter</kbd>
  4. Wait for installation to complete

Method B: Manual Installation

  1. Download the latest release ZIP from: https://github.com/kkga/spacegray/archive/master.zip
  2. Extract the ZIP archive
  3. Rename the extracted folder from spacegray-master to Theme - Spacegray
  4. Open Sublime Text and navigate to Preferences > Browse Packages...
  5. Copy the renamed Theme - Spacegray folder into the opened Packages directory
  6. Restart Sublime Text

3. Configuration

Activating a Theme Variant

After installation, activate your preferred theme variant:

Option 1: Via Command Palette

  1. Open Command Palette
  2. For theme: Select UI: Select Theme → choose your variant (e.g., Spacegray)
  3. For color scheme: Select UI: Select Color Scheme → choose matching Base16 scheme

Option 2: Edit Settings Directly

  1. Open Command Palette → Preferences: Settings
  2. In the right-hand user settings file, add the appropriate pair:

Spacegray (Default - Ocean Dark):

{
  "theme": "Spacegray.sublime-theme",
  "color_scheme": "Base16 Ocean Dark.sublime-color-scheme"
}

Spacegray Light:

{
  "theme": "Spacegray Light.sublime-theme",
  "color_scheme": "Base16 Ocean Light.sublime-color-scheme"
}

Spacegray Eighties:

{
  "theme": "Spacegray Eighties.sublime-theme",
  "color_scheme": "Base16 Eighties Dark.sublime-color-scheme"
}

Spacegray Mocha:

{
  "theme": "Spacegray Mocha.sublime-theme",
  "color_scheme": "Base16 Mocha Dark.sublime-color-scheme"
}

Spacegray Oceanic:

{
  "theme": "Spacegray Oceanic.sublime-theme",
  "color_scheme": "Base16 Oceanic.sublime-color-scheme"
}

Customizing Theme Settings

Access additional customization via:

  1. Global Theme Variables (font, size):

    • Open Command Palette → UI: Customize Theme
    • Edit the "variables" section:
      {
        "variables": {
          "font_face": "system",  // Change to your preferred font (e.g., "Cascadia Code")
          "font_size": 12         // Override global font_size
        }
      }
      
  2. Global Theme Settings (in Preferences.sublime-settings):

    {
      "themed_title_bar": false,              // Disable custom title bar (useful for native macOS tabs)
      "enable_tab_scrolling": false,          // Disable tab scrolling arrows
      "show_tab_close_buttons": false,        // Hide all tab close buttons
      "show_tab_close_buttons_on_left": true  // Show close buttons on left side
    }
    
  3. Spacegray-Specific Settings (in Preferences.sublime-settings):

    {
      // Tab dimensions
      "theme.spacegray.tabs.height": "normal",  // Options: "xsmall", "small", "normal", "large", "xlarge"
      "theme.spacegray.tabs.auto_width": true,  // Auto-width tabs vs fixed width
    
      // Sidebar appearance
      "theme.spacegray.sidebar.row_height": "normal",  // Options: "xsmall", "small", "normal", "large", "xlarge"
      "theme.spacegray.sidebar.show_icons": true,      // Show file type icons
    
      // VCS integration
      "theme.spacegray.sidebar.vcs_color_labels": true,      // Color file labels by VCS status
      "theme.spacegray.sidebar.vcs_color_expanded": true     // Also color expanded folders
    }
    

4. Build & Run

Not applicable. Spacegray is a pure Sublime Text UI theme/color scheme package. No build step, compilation, or runtime execution is required. Changes to settings take effect immediately upon saving the settings file or switching themes via the Command Palette.

5. Deployment

Spacegray is designed as a Sublime Text package, not a standalone application. Distribution methods:

  1. Package Control (primary distribution):

    • Submit pull request to wbond/sublime_package_control channel to have your fork listed
    • Maintainers typically publish via the official Package Control channel
  2. Manual Distribution:

    • Share the Theme - Spacegray folder directly
    • Users install by placing it in their Packages/ directory (see Manual Installation above)
  3. GitHub Releases:

    • Create releases with ZIP archives containing the Theme - Spacegray folder (properly named)
    • Users download and install manually

6. Troubleshooting

Theme/Color Scheme Not Appearing After Installation

  • Cause: Sublime Text hasn't rescanned packages.
  • Solution: Restart Sublime Text completely. If still missing, verify the folder is named exactly Theme - Spacegray (case-sensitive) and located in Packages/.

Settings Not Applying

  • Cause: Syntax errors in settings JSON or incorrect setting keys.
  • Solution:
    1. Open Command Palette → Preferences: Settings - Syntax Specific to ensure you're editing the correct user settings file.
    2. Validate JSON syntax (use a validator or ensure all commas are correct).
    3. Check for typos in setting keys (e.g., "theme.spacegray.tabs.height" not "theme.spacegray.tab.height").
    4. Ensure no conflicting settings from other themes/packages.

Custom Font Not Loading

  • Cause: Font name incorrect or font not installed system-wide.
  • Solution:
    1. Verify exact font name (use font_face setting with the name as shown in OS font settings).
    2. Install the font on your OS if not present.
    3. Note: Sublime Text may require restart to recognize newly installed system fonts.

Tab/Sidebar Settings Ignored

  • Cause: Settings placed in wrong scope or overridden by theme defaults.
  • Solution:
    1. Place Spacegray-specific settings (theme.spacegray.*) in global Preferences.sublime-settings, not in theme customization files.
    2. Check for conflicting settings from other installed themes.
    3. Use UI: Customize Theme to override specific rules if needed (advanced).

Package Control Installation Fails

  • Cause: Network issues or Package Control outdated.
  • Solution:
    1. Ensure internet connection.
    2. Update Package Control: Command Palette → Package Control: Upgrade Package → select Package Control.
    3. Retry installation.

"Base16 Ocean Dark" Color Scheme Missing

  • Cause: Color schemes are included within the Spacegray package; this indicates incomplete installation.
  • Solution: Reinstall the package (delete Theme - Spacegray from Packages/ and reinstall). Verify the package contains .sublime-color-scheme files in its root directory.