Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Arcade splash screen #548

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Wills2022
Copy link
Contributor

Description

This guide describes how to replace the default emulationstation splash screen with a custom .svg file. This has been requested in order to align the Arcade Cabinet's "branding" more closely with that of SplashKit core.

This guide can also be followed to add an arbitrary splash screen to emulationstation if so desired.

Type of change

  • Documentation (update or new)

How Has This Been Tested?

Tested locally on my RPI running emulationstation and configured using the Thoth-Tech Arcade Machine setup guide. Using the steps provided here I am able to change to splash screen to an arbitrary .svg

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have requested a review from ... on the Pull Request

Copy link
Contributor

@DarrenSunandar DarrenSunandar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation for "Update Arcade Machine Splash Screen" is well-structured and clear, providing a logical flow from downloading the necessary files to troubleshooting potential issues. The background information on SVG files and vector graphics is particularly informative for users who may be unfamiliar with the format, explaining both its advantages and challenges. The guide also provides a detailed, step-by-step process for converting raster images into SVG format using Inkscape, which is easy to follow, even for beginners. I've follow all the steps to replace the the .svg file and it did change to the new splash screen. Overall, this documentation LGTM.

1. Now toggle the pane selection from "Single Scan" to "Multicolor". In Detection mode select Colors. Then click Smooth, then Apply.
1. You should have three layers of images. The base raster image, a monochrome outline of the image and a colored vector image. Delete all except the colored vector image.
8. Repeat this process for any other image elements you wish to include in the splash.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is some mistake here, can you make the number organize from 1 - 8.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good spot. I've fixed this.

@DarrenSunandar
Copy link
Contributor

Nice work! I'll approve this.

Copy link

@hugglesfox hugglesfox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@WhyPenguins WhyPenguins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good! Mind just fixing the formatting so the linter check passes? (Or use the mdx workaround 😅 )

Comment on lines 13 to 20
1. Open a new project in Inkscape
1. Set your page dimensions to a 16:9 aspect ratio such as 1280x720
1. Drag & drop your raster image file (image.png) into the Inkscape window. Leave the default settings in the "image import" window and click "OK".
1. Select the "Select & transform" tool (mouse icon on the left sidebar, hotkey:S) and click on the image. Then click on the drop down menu for Path > Trace bitmap
1. The right side panel should change to a "Trace Bitmap" menu. Select Single Scan. From the Detection Mode drop down select Autotrace. Then click Apply down the bottom.
1. Now toggle the pane selection from "Single Scan" to "Multicolor". In Detection mode select Colors. Then click Smooth, then Apply.
1. You should have three layers of images. The base raster image, a monochrome outline of the image and a colored vector image. Delete all except the colored vector image.
1. Repeat this process for any other image elements you wish to include in the splash.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also shouldn't these be 1 through to 8 as Darren pointed out? I don't think having them all as step 1 makes much sense 😋

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah sorry just coming back to this, I see this is a pattern used when making markdown auto-generate the numbers. I think it's probably okay to leave as-is? Generally in the documentation repo we're trying to make the non-processed files still read correctly though, so I think it'd be better to fix, but I'll merge it either way 😃

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Beat me to the mark by about ten seconds......

As I was going to say, I've fixed the file so that the auto generated tests should pass now.

In regards to the numbers in the markdown file, when the parser processes them they'll get turned into the "right" numbers per line. This makes it easier to update than explicitly declaring line items. I've updated it as requested.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants