= gentoo-xcursors
:toc: preamble
:project: gentoo-xcursors
:uri-base: https://schlomp.space/tastytea/{project}
:uri-branch-main: {uri-base}/src/branch/main
:imagesdir: {uri-base}/raw/branch/main/previews

A high quality set of animated mouse cursors.

The original authors are unknownfootnote:[If you are one of the authors, please
get in touch so that you can be properly attributed.], the source of the initial
commit is the file `gentoo-cursors-tad-0.3.1.tar.bz2` from the Gentoo
mirrors. If you have the source files used to generate the cursors, please get
in touch.

== Previews

The conversion from X11 cursor to PNG I've used is a bit lossy. In reality the
cursors look better than in the pictures.

image:preview_gentoo.png[title=gentoo]
image:preview_gentoo-blue.png[title=gentoo-blue]
image:preview_gentoo-silver.png[title=gentoo-silver]

== Install

=== Gentoo

[source,shell]
--------------------------------------------------------------------------------
emerge -a x11-themes/gentoo-xcursors
--------------------------------------------------------------------------------

=== Other

Copy the contents of `cursors/` into `/usr/share/icons/` or `~/.icons/`.

== Configuration

See https://wiki.gentoo.org/wiki/Cursor_themes[Gentoo Wiki: Cursor themes]. The
available sizes are 16, 24, 32, 48 and 64.

== License

gentoo-xcursors is licensed under the MIT license. See
link:{uri-branch-main}/LICENSE[LICENSE] for details.

== How to contribute
:uri-coc: {uri-branch-main}/CODE_OF_CONDUCT.adoc
:contact-email: tastytea@tastytea.de
:uri-git-format-patch: https://git-scm.com/docs/git-format-patch
:uri-git-send-email: https://git-scm.com/docs/git-send-email

Read the link:{uri-coc}[Code of Conduct].

=== Reporting bugs or suggesting enhancements

Before reporting a bug, please
https://schlomp.space/tastytea/{project}/issues[perform a search] to see if the
problem has already been reported. If it has, add a comment to the existing
issue or use reaction-emojis instead of opening a new one. Same for
enhancements.

You can also contact me via mailto:{contact-email}[e-mail] if you don't want to
open an account.

=== Pull requests

Please use the same color theme as the rest of the cursors. If you add or modify
a cursor or alias, please do so in all variants.

You can also send me your patches via mailto:{contact-email}[e-mail], ideally
using link:{uri-git-format-patch}[git format-patch] or
link:{uri-git-send-email}[git send-email].

== To do

=== (Re-)create source files

Since we don't have the sources, creating new cursors or modifying them is not
gonna be easy. Possible solutions are to (semi-automatically?) create SVGs from
the X11 cursors, start from scratch, or work directly with the X11 cursors.
Ideas are welcome.

=== Prettier preview

The script used for preview generation does not yield the best results. If you
know how to generate them without loosing quality, please let us know.

=== Missing cursors

NOTE: dnd = Drag and drop

* bd_double_arrow a.k.a. nwse-resize a.k.a. size_fdiag
  a.k.a. c7088f0f3e6c8088236ef8e1e3e70000
* fd_double_arrow a.k.a. nesw-resize a.k.a. size_bdiag
  a.k.a. fcf1c3c7cd4491d801f1e1c78f100000
* crossed_circle a.k.a. not-allowed a.k.a. 03b6e0fcb3499374a867c041f52298f0
* copy a.k.a. dnd-copy a.k.a. 1081e37283d90000800003c07f3ef6bf
  a.k.a. 6407b0e94181790501fd1e167b474872
* link a.k.a. dnd-link a.k.a. alias a.k.a. 3085a0e285430894940527032f8b26df
  a.k.a. 640fb0e74195791501fd1ed57b41487f
* no-drop a.k.a. dnd-no-drop