This fork reverts most of the changes to FavCat, brings back avatar favorites and the ability for FavCat to index public avatars that you see.
An all-in-one local favorites mod. Unlimited favorite lists with unlimited favorites in them and a searchable local database of content and players.
Requires UI Expansion Kit 0.2.0 or newer
- Unlimited lists (categories) for favorites, each of unlimited size
- Lag-free even with large lists
- Freely changeable list height
- Avatar, world, and player favorites supported
- Modifiable list order and multiple list sorting options
- Fully searchable database of everything you have ever seen
- Changeable database location (it's recommended to store the database in a directory backed up to cloud storage, such as Dropbox or OneDrive, see below for setup)
- Local image cache for even better performance
- Categorize your own private avatars
- Import avatar favorites from other local favorite mods (read below)
- Exchange search database with friends (read below)
- Hide default lists that you never use
- Many more small things
- Player favorites don't show online status
- Lists with over a thousand elements can take a bit of time on game startup/list creation
- Reconsider the approach to paywalling extra avatar favorite slots/groups
- The ability to categorize avatars
- Search avatars
- Personal avatar sorting
Steps to change database location:
- Run VRChat with the mod at least once
- Make sure that VRChat is closed
- Navigate to VRChat install directory (i.e. by clicking "Browse Local Files" in Steam)
- Navigate to
UserData
folder and openMelonPreferenes.cfg
with Notepad or other text editor - Find the line with
[FavCat]
- Find the line with
DatabasePath
under it - Change the value to absolute path to new storage folder. The new line should look like this:
DatabasePath = "C:/Users/username/OneDrive"
(with your own path, naturally; make sure to use forward clashes/
instead of backslashes\\
) - Save and close the text file
- Copy the two (or four) database files (
favcat-favs.db
andfavacat-store.db
, andfavcat-favs-log.db
andfavcat-store-log.db
if they exist) from the old location (they are inUserData
by default) to the new one.
If you want to move the image cache, use the same steps as above, but modify the line with ImageCachePath
and copy favcat-images.db
instead. It's not recommended to store the image cache in cloud storage due to its big size.
You can exchange the search database with friends to be able to find things they have seen. Only accept databases from friends you trust - an intentionally malformed database can overwrite parts of yours with garbage
How to send database to a friend:
- Run VRChat with the mod at least once (duh)
- Make sure that VRChat is closed
- Navigate to where your database is stored (see "Changing database location")
- Make sure that there is no file named
favcat-store-log.db
. If there is one, it means that the game was not closed properly. In that case, run the game again, and use "Exit VRChat" button in settings menu to close it. - Send
favcat-store.db
to your friend.
How to receive database from a friend:
- Run VRChat with the mod at least once
- Navigate to VRChat install directory (i.e. by clicking "Browse Local Files" in Steam)
- Put the database your friend sent you into
UserData/FavCatImport
folder. If you want to import multiple databases at once, you can rename them, as long as .db extension is kept. - In-game, click "More FavCat" on any big menu page, then click "Import databases and text files"
- Import process can take some time. Once it is done, the corresponding database will be deleted from
UserData/FavCatImport
folder.
Note that your favorites are stored in favcat-favs.db
- don't send it to your friends, favorite import is not supported. Most certainly don't send favcat-images.db
to your friends - it's just a boring image cache.
- LiteDB for all data storage
- ImageSharp, because unity is bad at loading images from streams on background thread
A long time ago this was based on Slaynash's AvatarFav and VRCTools, both licensed under the MIT license. Who knows how much of that still remains inside?
With the following exceptions, all mods here are provided under the terms of GNU GPLv3 license
- ILRepack.Lib.MSBuild.Task is covered by its own license
- ILRepack is covered by Apache 2.0 license