Put Edition files in a .zip archive; add version checking to zipped resources
- Dominant language
- Java
- Stars
- 2.7k
- Forks
- 1.1k
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 158
Description
Users frequently update Forge by installing a new version overtop their old one. Merging the resource directory in this way can cause issues if files have been renamed or removed from directories that parse every file inside them. In addition, users frequently neglect to merge or overwrite certain directories while doing this, meaning the versions of their engine and resources end up mismatched.
The `editions` directory is a common victim of this, with users missing certain editions or indefinitely retaining old copies of renamed ones. The `cardsfolder` is more resistant to this user behavior, since it behaves as a single file to be replaced in its entirety. Applying this behavior to card editions would mitigate potential user error.
What would go a step further though is to add metadata to these archives, containing the Forge version number they were distributed with. This would likely be in the form of a `version.txt` file included in the file (or maybe a `YOU DO NOT NEED TO EXTRACT THIS.txt` file if we want to resolve another potential user misunderstanding at the same time). Forge could check this file and display a warning message on startup if it doesn't match the current version of Forge.
Contributor guide
Assessment
This issue has not been assessed yet.