Screenshot Organizer

An application to organize World of Warcraft screenshots based on their timestamps.

Note: This is an experimental project and it's expected to have bugs and limitations.

Motivation

World of Warcraft screenshots are saved in the game's folder with a timestamp that's not well sorted by OS file managers due to the way the date is formated: month, day and year. So playing the game for a long time will likely result in a folder full of screenshots that are sorted first by month, then by day, and then by year, which doesn't make much sense, as they should be sorted by year, month, and day.

This application aims to solve this problem by organizing the screenshots into folders based on their timestamps, so players can easily find the screenshots they want to share or keep with a better sense of timeline.

❤️ Support this project

If you like this addon and want to support its development, you can buy the author a coffee.

Every contribution or subscription is deeply appreciated and also supports the Stormwind Library project, which is the framework used to build this addon.

How to use it

Requirements

• Node.js 20.0.0 or higher - although it may work with older versions, it was developed and tested with v20, so it's not guaranteed to work with older versions.

Installation

1. Unzip the application files to a folder of your choice
2. Open a terminal and navigate to the folder where you unzipped the files
3. Run npm install to install the dependencies

Configuration

The application has a configuration file that you need to copy and update with your settings. To do that, follow these steps:

1. Copy the config-example.json file to a new file named config.json
2. Open config.json with any text editor like Notepad
3. Replace the clients array with a list of clients you want to organize
   • The client path must be a folder containing the Screenshots folder,
     which means it will work if the World of Warcraft folder is not entirely matching Blizzard's default installation path
4. Replace the destinationFolder path with the root folder where you want the screenshots to be organized
5. Feel free to leave the syncMethod with its default value, but if you want your screenshots to be moved instead of copied, change it to move

Running the application

Once the requirements are met and the configuration is set, you can run the application by:

1. Open a terminal and navigate to the folder where Screenshot Organizer is installed
2. Run node index

Note: The first version of this application won't print any log messages to the terminal, so you won't see any output while it's running. You can check the destination folder to see if the screenshots are being organized. Informative output messages are already on the roadmap for future versions.

What's on the roadmap for the next versions

The best way to know what should be done next is to have feedback from users. If you have any suggestions or ideas, please let me know by opening an issue.

• A graphical interface to make it easier to use the application
• Better error handling, covering more edge cases
• More log messages to help users understand what the application is doing
• More detailed settings for better customization

For developers

If you want to contribute to this project, you can fork it and submit a pull request.

How to run the unit tests

This project uses Jest for unit testing. To run the tests, use the following command:

npm test

Changelog

2024.04.18 - v1.0.0

• First version of the organizer
• Organizes screenshots based on their timestamps
• Copies or moves screenshots to a destination folder
• Add minimal configuration options