Skip to content

Commit

Permalink
fish@kriegcc: Release v0.2.0 (linuxmint#6775)
Browse files Browse the repository at this point in the history
* Changes:
  - Fix a crash on popup menu replacement
  - Add advanced settings
  • Loading branch information
kriegcc authored Jan 20, 2025
1 parent 0587fe3 commit dc43f4c
Show file tree
Hide file tree
Showing 30 changed files with 2,367 additions and 433 deletions.
10 changes: 10 additions & 0 deletions fish@kriegcc/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## [Unreleased]

## [0.2.0] - 2025-01-20

### Fixed

- Fix a crash when popup menu is replaced (e.g. transition from error to normal message) while it is still open.

### Added

- Add an advanced settings tab to the preferences window with options to adjust animation size and margin.

## [0.1.1] - 2024-09-11

### Fixed
Expand Down
15 changes: 8 additions & 7 deletions fish@kriegcc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,20 +87,21 @@ The properties are:
- **File**: You can change the animation here. You can select an image that is supplied with the applet or a personal image.
- **Total frames in animation**: You need to specify here the number of frames of the selected image.
- **Pause between frames**: You can specify here the pause in seconds between each frame in the animation. The default is 0.3 seconds, but the range is from 0.1 to 10 seconds.
- **Rotate on vertical panels**: This checkbox is used for vertical panels, and when checked, the fish will appear swimming upwards on a vertical panel. If it is not checked, it will appear the same way as on a horizontal panel.
- **Flip sideways on vertical panels**: This checkbox is used for vertical panels, and when checked, the fish will appear swimming upwards on a vertical panel. If it is not checked, it will appear the same way as on a horizontal panel.

### Advanced Settings

The **Advanced Settings** tab in the Preferences dialog allows further customization of the animation, such as adjusting its size and configuring margins around it within the panel.

## Known Bugs and Limitations

This Cinnamon port of the Fish applet is in early development.
If you prefer a stable and clean experience, check out the original applet for GNOME and MATE desktops.
This Cinnamon port of the Fish applet is currently under development.
For a more stable and polished experience, consider using the original applet available for GNOME and MATE desktops.

### Known Issues

- lack of tests
- missing translations
- inconsistent, ugly styles
- style issues:
- message in popup might be cut or overlapped by scroll bars
- lot's of TODOs in code

Please feel free to provide feedback, report problems, or support the development of this applet.

Expand Down
27 changes: 27 additions & 0 deletions fish@kriegcc/docs/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,31 @@ The coding guidelines are not definitive. Feel free to suggest changes or additi
- If you copy code from another applet, add a comment and give credit.
- Ensure that no copyright is violated and the applet's license is retained (GPL-3.0-or-later).

## Developer Options

There is a hidden **Developer Options** section in the **Advanced Settings** tab of the Preferences dialog. This section contains options intended for debugging and development purposes. For example, it includes an option to trigger the Fool's Day easter egg without changing the system date. You can also add additional options here that should remain hidden from normal users.

![Developer Options][advanced-settings-developer-options]

### Enable Display of Developer Options

The visibility of the **Developer Options** section is controlled by the `keyDeveloperOptionsEnabled` setting, which is of type `generic`. To enable it:

1. Locate the Fish applet's configuration JSON file under: `~/.config/cinnamon/spices/fish@kriegcc`
2. Modify the `keyDeveloperOptionsEnabled` value to `true`. The updated JSON entry should look like this:

```json
"keyDeveloperOptionsEnabled": {
"type": "generic",
"default": false,
"value": true
}
```

3. Close the Preferences dialog (if it is open) and reopen it.

The next time you open the applet preferences, the **Developer Options** section will be visible in the Advanced Settings tab.

## Troubleshooting

Unhandled errors can easily lead to a crash of the Cinnamon desktop. When this happens, window decorations may disappear, and nothing may be clickable.
Expand Down Expand Up @@ -266,3 +291,5 @@ Source code of the original Fish applet:

- [GNOME](https://gitlab.gnome.org/GNOME/gnome-panel/-/tree/master/modules/fish)
- [MATE](https://github.com/mate-desktop/mate-panel/tree/master/applets/fish)

[advanced-settings-developer-options]: ./images/applet/advanced-settings-developer-options.png
7 changes: 4 additions & 3 deletions fish@kriegcc/docs/TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,8 @@

- [ ] Display error messages directly for invalid input

- [ ] Advanced settings page in preferences window
- [] Advanced settings

- [ ] Add options for animation width and height
- [ ] Include toggle for original size display
- [ ] Add option to allow change of message popup size (max-width, max-height)

- [ ] Improve notifications
Expand All @@ -42,3 +40,6 @@
### Completed Tasks ✓

- [x] Scale animation image to fit in panel
- [x] Advanced settings in preferences window
- [x] Add options for animation width and height
- [x] Include toggle for original size display
12 changes: 11 additions & 1 deletion fish@kriegcc/docs/TRANSLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,17 @@ However, there are some deviations (like error handling) in this applet from the

## Available Translations and Their Authors

- German (de): kriegcc (copied from mate-panel and adjusted)
- Catalan (ca): Odyssey
- German (de): kriegcc
- Spanish (es): haggen88
- French (fr): Claudiux
- Hungarian (hu): bossbob88
- Italian (it): Dragone2
- Dutch (nl): qadzek

[Generated Translation Status Table](https://github.com/linuxmint/cinnamon-spices-applets/blob/translation-status-tables/.translation-tables/tables/fish%40kriegcc.md)

Thank you to everyone who has contributed translations to make this applet available in multiple languages.

## Translating

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified fish@kriegcc/docs/images/applet/settings-window.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit dc43f4c

Please sign in to comment.