[Feature]: Customizable Front Content

[mkuehn]

Description

It would be fun to be able to customize the skyline with a company logo, etc. to personalize it for gift giving!

There may be cases where the user would want to exclude the year information from the front of the model (for example, when including an image and a date range of the user's entire history, maybe they'd just want to show the company logo in place of the date range)

Requirements

• add a flag to include a image file that can be included in the rendering of the information on the front of the skyline
• change the y flag/add new flag to also be able to exclude all year information from the face of the model

Definition of Done

• When a valid image file reference is passed with the image flag
  • it is rendered on the front of the skyline
  • it has the same depth as the invertocat
  • it is aligned to the right of the front of the skyline
  • if white space is present on the right of the image file, it is respected so that white space in the image file can be used to offset the image from the right side of the face of the skyline
  • if white space is present on the right of the image file AND the year is included on the face of the skyline, the white space is respected so that it can be used to center the image between the username and year
    • optionally, a flag to control the positioning of the image (center between username and year or right edge, right align with margin. etc.)
• When the y flag is used for exclusion, the year information is omitted on the model face

Additional Notes

No response

[chrisreddington]

Thanks for raising this issue @mkuehn 🙏 This is an interesting feature request, and seems to align with an overarching theme with other issues raised around customisation of the generated skyline 😄

I think I can see the use case, but would like to rubber duck a little bit further. What about a scenario where a user wants to print their Skyline annually (with the image example you suggest), how would they differentiate between different years?

[mkuehn]

I think I can see the use case, but would like to rubber duck a little bit further. What about a scenario where a user wants to print their Skyline annually (with the image example you suggest), how would they differentiate between different years?

Sure, the year shouldn't always be excluded, just available to be excluded if the user wants. In your scenario, I guess they wouldn't be able to know which print was from which year. Or maybe they'd just recycle last year's print when they run a new one. :-) Or, they could keep the year, whatever they like.

So, you should be able to do any of the following, as you like:

--------------------------------------------------------------------------------
[github logo] @username                                    [company logo] 2024 |
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
[github logo] @username                                                   2024 |
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
[github logo] @username                                         [company logo] |
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
[github logo] @username                  [company logo]                   2024 |
--------------------------------------------------------------------------------

Hope that clears up what I meant!

[Yash-xoxo]

Great feature idea! A few thoughts on the implementation:

Image Format & Validation:

• Consider supporting common formats (PNG, JPG, SVG) with size limits (e.g., max 2MB)
• SVG would be ideal for logos since it scales without quality loss
• Add validation to check image dimensions match the expected aspect ratio for the skyline front face

Configuration Approach:
You could implement this through a config file or command-line flags:

# .skyline-config.yml
front_content:
  image: "./assets/company-logo.png"
  position: "center" # or "top-right", "top-left"
  exclude_year: false
  exclude_username: false

Or via CLI:

gh-skyline --image ./logo.png --hide-year --hide-username

Year Differentiation Concern:
Regarding @chrisreddington's question about differentiating between years - you could:

1. Keep the year visible by default (opt-in to hide)
2. Add it to the base/bottom of the model instead
3. Include it in the filename when exporting (e.g., username-2024-skyline.stl)
4. Add a small embossed/debossed year on the side faces

Backward Compatibility:
Make sure the default behavior (no custom image) produces the same output as current versions to avoid breaking existing workflows.

Looking forward to seeing this implemented! Happy to help test once there's a PR.

[Joshuawcox5]

ok