diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 0000000..57095de --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,7 @@ + \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..f75425d --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,8 @@ + \ No newline at end of file diff --git a/README.md b/README.md index 4bf396b..35e89a4 100644 --- a/README.md +++ b/README.md @@ -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. -- `-.png` filename. +- PNG format with alpha transparent background. +- 512x512px size. +- `-.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 `.png` icon to cover all the games. \ No newline at end of file