Skip to content

Commit

Permalink
#4 Update plugin version and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ivan Seredkin committed Jul 19, 2024
1 parent 560c390 commit 5b5f202
Show file tree
Hide file tree
Showing 8 changed files with 58 additions and 48 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## [Unreleased]

## [1.1.0] - 2024-07-19
### Changed
- Add "Use Keyboard Layout" setting to determine the language based on the keyboard layout
- Update Gradle to 8.9

## [1.0.5] - 2023-12-07
### Changed
Expand Down
68 changes: 34 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,51 @@
<div align="center">
<img src="./src/main/resources/META-INF/pluginIcon_dark.svg" width="220" height="220" alt="logo"/>
</div>
<h1 align="center">Kursor</h1>
<p align="center">IntelliJ plugin for tracking keyboard language</p>

<p align="center">
<a href="https://plugins.jetbrains.com/plugin/22072-kursor"><img src="https://img.shields.io/jetbrains/plugin/r/stars/22072?style=flat-square"></a>
<a href="https://plugins.jetbrains.com/embeddable/install/22072"><img src="https://img.shields.io/jetbrains/plugin/d/22072-kursor.svg?style=flat-square"></a>
<a href="https://plugins.jetbrains.com/plugin/22072-kursor"><img src="https://img.shields.io/jetbrains/plugin/v/22072-kursor.svg?style=flat-square"></a>
</p>
![Kursor Logo](./src/main/resources/META-INF/pluginIcon_dark.svg)

# Kursor

*IntelliJ plugin for tracking keyboard language*

![](https://github.com/siropkin/kursor/blob/main/screenshots/kurso.gif)
[![Rating](https://img.shields.io/jetbrains/plugin/r/stars/22072?style=flat-square)](https://plugins.jetbrains.com/plugin/22072-kursor)
[![Downloads](https://img.shields.io/jetbrains/plugin/d/22072-kursor.svg?style=flat-square)](https://plugins.jetbrains.com/embeddable/install/22072)
[![Version](https://img.shields.io/jetbrains/plugin/v/22072-kursor.svg?style=flat-square)](https://plugins.jetbrains.com/plugin/22072-kursor)

![Kursor Demo](./screenshots/demo.png)
</div>

<!-- Plugin description -->
Kursor is a simple IntelliJ plugin that helps you keep track of your keyboard language.
Kursor simplifies language tracking directly on your IntelliJ IDE.

It shows the current language on the cursor and lets you change the cursor color based on the language.
It dynamically displays the current keyboard language on your cursor, offering the added functionality of changing the cursor's color to match the language in use.

It's useful for developers who work with multiple languages and want to avoid typing errors.
This feature is particularly beneficial for developers juggling multiple languages, significantly reducing the likelihood of typing errors.
<!-- Plugin description end -->

## Install
## Installation

<a href="https://plugins.jetbrains.com/embeddable/install/22072">
<img src="https://user-images.githubusercontent.com/12044174/123105697-94066100-d46a-11eb-9832-338cdf4e0612.png" width="300"/>
</a>
[![Install Kursor](https://user-images.githubusercontent.com/12044174/123105697-94066100-d46a-11eb-9832-338cdf4e0612.png)](https://plugins.jetbrains.com/plugin/22072-kursor)

Or you could install it inside your IDE:
Alternatively, you can install it directly inside your IDE:

For Windows & Linux - <kbd>File</kbd> > <kbd>Settings</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "Kursor"</kbd> > <kbd>Install Plugin</kbd> > <kbd>Restart IntelliJ IDEA</kbd>
- **For Windows & Linux:** `File` > `Settings` > `Plugins` > `Marketplace` > Search for "Kursor" > `Install Plugin` > Restart IntelliJ IDEA
- **For Mac:** `IntelliJ IDEA` > `Preferences` > `Plugins` > `Marketplace` > Search for "Kursor" > `Install Plugin` > Restart IntelliJ IDEA

For Mac - <kbd>IntelliJ IDEA</kbd> > <kbd>Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "Kursor"</kbd> > <kbd>Install Plugin</kbd> > <kbd>Restart IntelliJ IDEA</kbd>
## Features and Settings

![Settings Screenshot](./screenshots/settings.png)

## Settings
<img src="./screenshots/settings.png" alt="settings"/>
- **Default Language:** The default language for your IDE.
- **Use Keyboard Layout:** Determines the language based on the keyboard layout.
- **Change Color on Non-Default Language:** Changes the cursor color if the language is not the default.
- **Show Text Indicator:** Displays a language indicator on the cursor. If disabled, only the cursor color will be changed.
- **Show Default Language:** Shows the default language on the cursor when enabled.
- **Indicate Caps Lock:** Displays a Caps Lock indicator on the cursor. The language will be shown in uppercase.
- **Font:** The font used for the language indicator.
- **Size:** Font size of the language indicator.
- **Opacity:** Opacity of the language indicator (0 - transparent, 255 - opaque).
- **Vertical Position:** Vertical position of the language indicator (top, middle, or bottom).
- **Horizontal Offset:** Horizontal offset of the language indicator.

- Default language - default language
- Change color on non-default language - change cursor color if language is not default
- Show text indicator - show language indicator on the cursor (if disabled, only cursor color will be changed)
- Show default language - if disabled, default language will not be shown on the cursor
- Indicate Caps Lock - show Caps Lock indicator on the cursor (language will be in uppercase)
- Font - font of the language indicator
- Size - font size of the language indicator
- Opacity - opacity of the language indicator (0 - transparent, 255 - opaque)
- Vertical position - vertical position of the language indicator (top, middle, or bottom)
- Horizontal offset - horizontal offset of the language indicator
## Support

## Buy Me a Coffee
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/ivan.seredkin)
[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/ivan.seredkin)
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pluginGroup = com.github.siropkin.kursor
pluginName = Kursor
pluginRepositoryUrl = https://github.com/siropkin/kursor
# SemVer format -> https://semver.org
pluginVersion = 1.0.5
pluginVersion = 1.1.0

# Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
pluginSinceBuild = 221
Expand Down
Binary file added screenshots/demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed screenshots/kurso.gif
Binary file not shown.
Binary file modified screenshots/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ private const val LABEL_SPACING = 10
private const val COMPONENT_SPACING = 35

class KursorSettingsComponent {
private val defaultLanguageComponent = JBTextField("", 10)
private val defaultLanguageComponent = JBTextField("", 5)
private val useKeyboardLayoutComponent = JBCheckBox("Use keyboard layout")

private val changeColorOnNonDefaultLanguageComponent = JBCheckBox("Change color on non-default language")
private val colorOnNonDefaultLanguageComponent = ColorPanel()

private val showIndicatorComponent = JBCheckBox("Show text indicator")
private val indicateCapsLockComponent = JBCheckBox("Indicate 'Caps Lock'")
private val indicateDefaultLanguageComponent = JBCheckBox("Show default language")
private val useKeyboardLayoutComponent = JBCheckBox("Use keyboard layout")

private val indicatorFontNameComponent = ComboBox(GraphicsEnvironment.getLocalGraphicsEnvironment().availableFontFamilyNames)
private val indicatorFontStyleComponent = ComboBox(arrayOf(Font.PLAIN.toString(), Font.BOLD.toString(), Font.ITALIC.toString()))
Expand All @@ -34,6 +34,7 @@ class KursorSettingsComponent {

var panel: JPanel = FormBuilder.createFormBuilder()
.addLabeledComponent("Default language:", defaultLanguageComponent, 1, false)
.addComponent(useKeyboardLayoutComponent)
.addComponent(createColorPanel())
.addComponent(createIndicatorPanel())
.addComponent(createPositionPanel())
Expand All @@ -49,6 +50,12 @@ class KursorSettingsComponent {
defaultLanguageComponent.text = value
}

var useKeyboardLayout: Boolean
get() = useKeyboardLayoutComponent.isSelected
set(value) {
useKeyboardLayoutComponent.isSelected = value
}

var changeColorOnNonDefaultLanguage: Boolean
get() = changeColorOnNonDefaultLanguageComponent.isSelected
set(value) {
Expand Down Expand Up @@ -81,12 +88,6 @@ class KursorSettingsComponent {
indicateDefaultLanguageComponent.isSelected = value
}

var useKeyboardLayout: Boolean
get() = useKeyboardLayoutComponent.isSelected
set(value) {
useKeyboardLayoutComponent.isSelected = value
}

var indicatorFontName: String
get() = indicatorFontNameComponent.selectedItem as String
set(value) {
Expand Down Expand Up @@ -156,7 +157,6 @@ class KursorSettingsComponent {
checkBoxPanel.layout = GridBagLayout()
checkBoxPanel.add(showIndicatorComponent, createRbc(0, 0, 0.0))
checkBoxPanel.add(indicateDefaultLanguageComponent, createRbc(1, 0, 0.0, COMPONENT_SPACING))
checkBoxPanel.add(useKeyboardLayoutComponent, createRbc(2, 0, 0.0, COMPONENT_SPACING))
checkBoxPanel.add(indicateCapsLockComponent, createRbc(2, 0, 1.0, COMPONENT_SPACING))

val fontPanel = JPanel()
Expand Down
14 changes: 10 additions & 4 deletions src/main/resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
<idea-plugin require-restart="true">
<id>com.github.siropkin.kursor</id>
<name>Kursor</name>
<version>1.0.5</version>
<version>1.1.0</version>
<vendor email="[email protected]">Ivan Seredkin</vendor>

<description><![CDATA[
Kursor is a simple IntelliJ plugin that helps you keep track of your keyboard language.<br />
It shows the current language on the cursor and lets you change the cursor color based on the language.<br />
It's useful for developers who work with multiple languages and want to avoid typing errors.
Kursor simplifies language tracking directly on your IntelliJ IDE.<br />
It dynamically displays the current keyboard language on your cursor, offering the added functionality of changing the cursor's color to match the language in use.<br />
This feature is particularly beneficial for developers juggling multiple languages, significantly reducing the likelihood of typing errors.
]]></description>

<change-notes><![CDATA[
1.1.0 (2024-07-19)<br />
++++++++++++++++++<br />
- Add "Use Keyboard Layout" setting to determine the language based on the keyboard layout
- Update Gradle to 8.9
<br />
<br />
1.0.5 (2023-12-07)<br />
++++++++++++++++++<br />
- Unspecify `pluginUntilBuild` (include all future builds)<br />
Expand Down

0 comments on commit 5b5f202

Please sign in to comment.