diff dep/animone/README.md @ 258:862d0d8619f6

*: HUUUGE changes animia has been renamed to animone, so instead of thinking of a health condition, you think of a beautiful flower :) I've also edited some of the code for animone, but I have no idea if it even works or not because I don't have a mac or windows machine lying around. whoops! ... anyway, all of the changes divergent from Anisthesia are now licensed under BSD. it's possible that I could even rewrite most of the code to where I don't even have to keep the MIT license, but that's thinking too far into the future I've been slacking off on implementing the anime seasons page, mostly out of laziness. I think I'd have to create another db file specifically for the seasons anyway, this code is being pushed *primarily* because the hard drive it's on is failing! yay :)
author Paper <paper@paper.us.eu.org>
date Mon, 01 Apr 2024 02:43:44 -0400
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/dep/animone/README.md	Mon Apr 01 02:43:44 2024 -0400
@@ -0,0 +1,36 @@
+# Animia
+Animia is a work-in-progress cross-platform hard fork of Anisthesia and part of
+Minori.
+
+Most (if not all) Anisthesia configs should also work in this library as well
+(at least on Windows).
+
+## License
+Changes divergent from Anisthesia are under the BSD 3-clause license. You can
+find a copy of the original MIT license bundled with Anisthesia at `LICENSE.MIT`
+in the root folder.
+
+## Support
+Unlike Anisthesia, Animia currently does not support UI automation, i.e., most
+web browsers will not work properly, if at all.
+
+Animia will first attempt to connect to a windowing system. If that fails, it falls
+back to just enumerating over the open processes in the system.
+
+## Platform-specific quirks
+
+### Windows
+To get the currently opened file handles on Windows, Animia has to use internal
+kernel functions. However, these functions aren't likely to change anytime soon.
+
+### macOS
+The code to retrieve executable names on macOS uses internal functions. However,
+if these functions cannot be found for whatever reason, it falls back to parsing
+the arguments, and then to calling the kernel.
+
+Additionally, macOS does not have the concept of class names, rather, it has
+bundle identifiers, which are a suitable replacement in most use cases, and are
+what Animia will try to grab before falling back to the Quartz window name.
+
+### X11
+Animia requires that the XRes extension is installed to retrieve window PIDs.