ICONS: Clarify guidelines

This commit is contained in:
SupSuper 2020-09-07 22:31:16 +01:00
commit ed5f49c3c7
3 changed files with 23 additions and 10 deletions

7
.github/issue_template.md vendored Normal file
View file

@ -0,0 +1,7 @@
<!--
* Put all your files in a single ZIP instead of uploading them individually.
* Just drag and drop your ZIP here to attach it to the issue.
* Let us know if you wanna be credited by something other than your Github username.
-->

8
.github/pull_request_template.md vendored Normal file
View file

@ -0,0 +1,8 @@
<!--
* Prefix your commit messages with `ICONS:` for consistency with ScummVM guidelines.
* Make sure to update the TOC and AUTHORS files appropriately.
Thanks for contributing!
-->

View file

@ -1,22 +1,20 @@
# ScummVM Game Icons
This repository contains icons of [ScummVM-supported games](https://www.scummvm.org/compatibility/) for features like:
- Discord rich presence
- Taskbar integration
Or just plain old shortcuts.
This repository contains high-resolution icons of [ScummVM-compatible games](https://www.scummvm.org/compatibility/) that can be used with [integrations](https://wiki.scummvm.org/index.php?title=User_Manual/Appendix:_Integrations) like Discord or plain old desktop shortcuts.
## Contributing
Check the [Table of Contents](TOC.md) to see what icons we're missing. This covers every stable ScummVM game, so prioritize mainstream titles over minor fan games and tech demos.
Just send us a [pull request](https://github.com/scummvm/scummvm-icons/pulls) with new icons, or put them in an [issue](https://github.com/scummvm/scummvm-icons/issues) if Git's not your thing (you can attach files to issues via drag'n'drop). Be sure to update the TOC when you do.
To send us your icons:
- If you're familiar with Git, use a [pull request](https://github.com/scummvm/scummvm-icons/pulls). Be sure to update the `TOC.md` accordingly.
- Otherwise just open an [issue](https://github.com/scummvm/scummvm-icons/issues) with your icons attached. Put them inside a ZIP so Github doesn't mangle the images.
Icons should follow this format:
- PNG format with alpha transparency.
- 512x512 size.
- `<engine>-<game>.png` filename.
- PNG format with alpha transparent background.
- 512x512px size.
- `<engine>-<game>.png` filename (use the IDs in the TOC).
Variants of the same game can have the same icon. For engines with lots of games (eg. Wintermute, Glk) it might be better to have a generic `<engine>.png` icon to cover all the games.