# sublime-irc

IRC log file syntax highlighting for Sublime Text.

## Screenshots

`#debian` on irc.oftc.net and `#ubuntu` on irc.libera.chat using Sublime Text's default `Monokai` color scheme:

<p align="center">
    <a href="https://i.imgur.com/GHFblkN.png" target="_blank"> <img src="https://i.imgur.com/GHFblkN.png" width="49%"/></a>
    <a href="https://i.imgur.com/0C6a5r5.png" target="_blank"> <img src="https://i.imgur.com/0C6a5r5.png" width="49%"/></a>
    <i>Click images to enlarge.</i>
</p>

## Installation

### With Package Control

1. [Install Package Control](https://packagecontrol.io/installation)
2. Install [IRC Syntax package](https://packagecontrol.io/packages/IRC%20Syntax)

    | Platform      | Install Command                                                |
    | --------------| -------------------------------------------------------------- |
    | OS X          | <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> → Package Control: Install Package → IRC Syntax  |
    | Linux/Windows | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> → Package Control: Install Package → IRC Syntax |

3. Reopen all IRC log files and select the 'IRC' syntax from the menu.

### Without Package Control

1. Locate your Sublime Text "Packages" directory and navigate to it

    | Platform | Installation Path                                           |
    | -------- | ----------------------------------------------------------- |
    | Linux    | `~/.config/sublime-text-3/Packages/`                        |
    | OSX      | `~/Library/Application\ Support/Sublime\ Text\ 3/Packages/` |
    | Windows  | `%AppData%\Roaming\Sublime Text 3\Packages`                 |

2. Clone this repository into `IRC Syntax` directory

```bash
$ git clone git://github.com/barnumbirr/sublime-irc.git 'IRC Syntax'
```

## Configuration

### Uniquely colored nicknames

Navigate to `Preferences → Customize Color Scheme` and add the following to your
theme rules:

```json
    {
        "name": "IRC Nickname",
        "scope": "string.unquoted.username.irc",
        "foreground": ["#7F00FF", "#FF0000"]
    },
```

These foreground colors should be readable in most themes.

## License:

```
Copyright 2021 Martin Simon

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

## Buy me a coffee?

If you feel like buying me a coffee (or a beer?), donations are welcome:

```
BTC : bc1qq04jnuqqavpccfptmddqjkg7cuspy3new4sxq9
DOGE: DRBkryyau5CMxpBzVmrBAjK6dVdMZSBsuS
ETH : 0x2238A11856428b72E80D70Be8666729497059d95
LTC : MQwXsBrArLRHQzwQZAjJPNrxGS1uNDDKX6
```