Skip to content

Latest commit

 

History

History
55 lines (44 loc) · 4.4 KB

DEVICES.md

File metadata and controls

55 lines (44 loc) · 4.4 KB

Adding New Systems and System Images

Included System Image Packs

You may download one of the image packs that will change how the collection list looks. Download the zip file, which includes a folder of .png files, a CollectionData.qml file, and a CollectionItem.qml file.

  • delete and replace the .png files in /assets/images/devices/
  • replace /components/resources/CollectionData.qml
  • and /components/collectionList/CollectionItem.qml
theme dreamcast ngpc pcengine snes
original
centered
offset
33 files		 original dreamcast original ngpc original pcengine original snes
pixel
71 files		 pixel dreamcast pixel ngpc pixel pcengine pixel snes
br1ans
58 files		 br1ans dreamcast br1ans ngpc br1ans pcengine br1ans snes
clusterm
54 files		 clusterm dreamcast clusterm ngpc clusterm pcengine clusterm snes

Alternate Files

Additionally, there are some zip files including some images I chose not to use from each of the themes. Mostly some of the more obscure systems that aren't in the metadata. You can check them out if you're missing something that you want to use.

Create Your Own

  • add image files into /assets/images/devices/shortname.png
    • images should not have any padding, but can be worked around if it does
    • images may include dropshadow, or the shadow can be generated in the theme
    • images are not required for a collection to work
  • add new metadata into /components/resources/CollectionData.qml
    • this metadata is not required for a collection to work
    • alias notes
      • this defines alternate shortnames for systems
      • useful if a collection can be known by multiple shortnames, like dc/dreamcast
    • metadata notes
      • color: background color for the collection page
      • vendor: name of the manufacturer
      • year: years of production
      • image: alternate image from a different collection
        • useful if multiple collections share an image, like arcade/atomiswave
      • summary: Summary text displayed on collection item page.
      • any of these bits of metadata may be excluded, and the collection will still work
  • adjust /components/collectionList/CollectionItem.qml if necessary
    • you can adjust the image sizes here
      • useful if you are using images that have padding or dropshadows.
    • you can uncomment the DropShadow element here if your image doesn't include dropshadows.
      • also it's best to set the Image element here to invisible to prevent the image from drawing twice
    • you can also adjust the smoothing on image resizing here
      • setting it to false is good for pixelated themes, so pegasus doesn't try to smooth out the pixelly goodness