Guide:Ren'Py visual novels on Steam: Difference between revisions

From VNDev Wiki
split out most of the content to subpages
Tag: Replaced
text formatting, removed unused headers
Line 1: Line 1:
{{guide|[https://bobcgames.com Bob Conway]|contrib=no}}
{{guide|[https://bobcgames.com Bob Conway]|contrib=no}}
Ren’Py Visual Novels on Steam: A Step-by-Step Guide<br>
Ren’Py Visual Novels on Steam: A Step-by-Step Guide<br>
By Bob Conway ([https://bobcgames.com])<br>
By Bob Conway ([https://bobcgames.com https://bobcgames.com])<br>
With thanks to BaiYu / Project Ensō ([https://twitter.com/projectenso_])<br>
With thanks to BaiYu / Project Ensō ([https://twitter.com/projectenso_ https://twitter.com/projectenso_])<br>
Created: August 11, 2021<br>
Created: August 11, 2021<br>
Last Updated: March 26, 2024 (see [[#Document Changelog|Document Changelog]])<br>
Last Updated: March 26, 2024 (see [[#Document Changelog|Document Changelog]])<br>
Line 19: Line 19:


You must create the following assets for the Steam store page, community, and client:
You must create the following assets for the Steam store page, community, and client:
*Five game screenshot images (hit the “s” key while playing to easily generate these) ([[#5 or More Screenshots|details]])
*Five game screenshot images (hit the “s” key while playing to easily generate these) ([[Guide:Ren%27Py_visual_novels_on_Steam/Store_page#5 or More Screenshots|details]])
*One game trailer video ([[#Add a Trailer|details]])
*One game trailer video ([[Guide:Ren%27Py_visual_novels_on_Steam/Store_page#Add a Trailer|details]])
*Four capsule images for the store ([[#Capsule Images|details]])
*Four capsule images for the store ([[Guide:Ren%27Py_visual_novels_on_Steam/Store_page#Capsule Images|details]])
**A 460x215px header image, which will appear at the top of your store page and in other store views
**A 460x215px header image, which will appear at the top of your store page and in other store views
**A 231x87px small image, which will appear in search results and recommendations
**A 231x87px small image, which will appear in search results and recommendations
**A 616x353px main image that appears on the front page (and will probably never get used unless you are popular)
**A 616x353px main image that appears on the front page (and will probably never get used unless you are popular)
**A 374x448px tall image that will also be used in the store
**A 374x448px tall image that will also be used in the store
*Three images for players’ game libraries ([[#Library Images|details]])
*Three images for players’ game libraries ([[Guide:Ren%27Py_visual_novels_on_Steam/Store_page#Library Images|details]])
**A 600x900px capsule image to represent your game in the large library view
**A 600x900px capsule image to represent your game in the large library view
**A 3840x1240px header image to display (and scale) at the top of the game page in the library
**A 3840x1240px header image to display (and scale) at the top of the game page in the library
**A 1280x720px logo image to overlay on top of the header image above
**A 1280x720px logo image to overlay on top of the header image above
*An image for the Steam community ([[#Community Images|details]])
*An image for the Steam community ([[Guide:Ren%27Py_visual_novels_on_Steam/Store_page#Community Images|details]])
**A 184x69px capsule image for wishlists
**A 184x69px capsule image for wishlists
*An icon for the client distributable ([[#Client Icon|details]])
*An icon for the client distributable ([[Guide:Ren%27Py_visual_novels_on_Steam/Store_page#Client Icon|details]])
**A 32x32px ico file, which can automatically generate the TGA and community image
**A 32x32px ico file, which can automatically generate the TGA and community image


You must create the following game build ZIP to upload:
You must create the following game build ZIP to upload:
*A “markets” game build created with a Steam-library-enabled Ren’Py ([[#Setting up Archiving For Your Game (Optional)|details]])
*A “markets” game build created with a Steam-library-enabled Ren’Py ([[Guide:Ren%27Py_visual_novels_on_Steam/Upload#Setting up Archiving For Your Game (Optional)|details]])


You may optionally create the following assets for the Steam store page:
You may optionally create the following assets for the Steam store page:
*A trailer screenshot image (as a loading placeholder for the trailer video) ([[#Add a Trailer|details]])
*A trailer screenshot image (as a loading placeholder for the trailer video) ([[Guide:Ren%27Py_visual_novels_on_Steam/Store_page#Add a Trailer|details]])
*A 1438x810px background image that will appear on your game page  ([[#Capsule Images|details]])
*A 1438x810px background image that will appear on your game page  ([[Guide:Ren%27Py_visual_novels_on_Steam/Store_page#Capsule Images|details]])


You may optionally create the following asset for the Steam community
You may optionally create the following asset for the Steam community
*A 32x32px JPG for the community icon (which can be automatically generated from your ico file above) ([[#Community Images|details]])
*A 32x32px JPG for the community icon (which can be automatically generated from your ico file above) ([[Guide:Ren%27Py_visual_novels_on_Steam/Store_page#Community Images|details]])


You may optionally create the following asset for the client
You may optionally create the following asset for the client
*A 16x16px TGA for the client icon (which can be automatically generated from your ico file above) ([[#Client Icon|details]])
*A 16x16px TGA for the client icon (which can be automatically generated from your ico file above) ([[Guide:Ren%27Py_visual_novels_on_Steam/Store_page#Client Icon|details]])


You may optionally create the following assets for achievements:
You may optionally create the following assets for achievements:
*Two 256x256px JPG images for each achievement, representing the locked and unlocked states ([[#Create the Images|details]])
*Two 256x256px JPG images for each achievement, representing the locked and unlocked states ([[Guide:Ren%27Py_visual_novels_on_Steam/Achievements#Create the Images|details]])


For more step-by-step guidance, read on.
For more step-by-step guidance, read on.


(The above steps do not all apply for additive content such as a demo, DLC, a soundtrack, or bundles. Reference the appropriate sections for details.)
(The above steps do not all apply for additive content such as a demo, DLC, a soundtrack, or bundles. Reference the appropriate sections for details.)
==Create the Steam App==
==Create Your Store Page==
==Upload Your Game to Steam==
==Add Achievements==
==Test Your Game==
==Add a Demo==
==Create DLC==
==Create a Bundle==
==Create an Externally-Distributed Nudity Patch==


==Document Changelog==
==Document Changelog==
August 11, 2021 - Document first published
*August 11, 2021 - Document first published
August 26, 2021 - Added info on Fixing a Bad Upload (with thanks to Thugzilla)
*August 26, 2021 - Added info on [[Guide:Ren%27Py_visual_novels_on_Steam/Upload#Fixing a Bad Upload (via Web UIs)|Fixing a Bad Upload]] (with thanks to Thugzilla)
February 13, 2022 - Fixed some info on Achievement Stats
*February 13, 2022 - Fixed some info on [[Guide:Ren%27Py_visual_novels_on_Steam/Achievements#Achievement Stats|Achievement Stats]]
March 27, 2022 - Added this changelog section, added I Ran My Game Before Re-Zipping and Uploading, added Create an Externally-Distributed Nudity Patch
*March 27, 2022 - Added this changelog section, added [[Guide:Ren%27Py_visual_novels_on_Steam/Upload#I Ran My Game Before Re-Zipping and Uploading|I Ran My Game Before Re-Zipping and Uploading]], added [[Guide:Ren%27Py_visual_novels_on_Steam/External_patch|Create an Externally-Distributed Nudity Patch]]
July 20, 2022 - Added additional SteamPipe and Ren’Py 8 references
*July 20, 2022 - Added additional SteamPipe and Ren’Py 8 references
October 7, 2023 - Added link to Bob's Ren'Py Achivements Framework, SuperBiasedGary confirmed that stat achievements work
*October 7, 2023 - Added link to Bob's [https://bobcgames.itch.io/bobcachievements Ren'Py Achievements Framework], SuperBiasedGary confirmed that stat achievements work
March 26, 2024 - Added details about save file sharing in Provide Save Files to Steam Support, with thanks to Cyan
*March 26, 2024 - Added details about save file sharing in [[Guide:Ren%27Py_visual_novels_on_Steam/Upload#Provide Save Files to Steam Support|Provide Save Files to Steam Support]], with thanks to Cyan


==Suggestions and Contact Information==
==Suggestions and Contact Information==
Bob welcomes suggestions, corrections, and additions to this document. You can reach him at bobcgames(at)gmail.com, from his website bobcgames.com, or on Mastodon as @bobcgames@peoplemaking.games.
Bob welcomes suggestions, corrections, and additions to this document. You can reach him at bobcgames(at)gmail.com, from his website [https://bobcgames.com bobcgames.com], or on Mastodon as [https://peoplemaking.games/@bobcgames @bobcgames@peoplemaking.games].


However, he requests you do not contact him with questions relating to Ren’Py code, including questions about screen language, patch file creation, and achievement code. For such questions, he recommends the official Ren’Py Discord server.
However, he requests you do not contact him with questions relating to Ren’Py code, including questions about screen language, patch file creation, and achievement code. For such questions, he recommends [https://discordapp.com/invite/6ckxWYm the official Ren’Py Discord server].


If you found this guide useful, please consider supporting him by donating to YAGS on itch.io or picking up some YAGS swag.
If you found this guide useful, please consider supporting him by [https://bobcgames.itch.io/yags donating to YAGS on itch.io] or [https://yags.bobcgames.com/?swag picking up some YAGS swag].


{{Template:Renpy steam guide nav}}
{{Template:Renpy steam guide nav}}

Revision as of 11:06, 19 February 2025

Ren’Py Visual Novels on Steam: A Step-by-Step Guide
By Bob Conway (https://bobcgames.com)
With thanks to BaiYu / Project Ensō (https://twitter.com/projectenso_)
Created: August 11, 2021
Last Updated: March 26, 2024 (see Document Changelog)
Short Link to original version (may be more up-to-date): https://bit.ly/2VOH4vf

This is a step-by-step guide with screenshots for getting your Ren’Py based game onto Steam. (This guide can be used for non-Ren’Py games too. Just ignore the portions about Ren’Py.)

This guide assumes you have already registered as a Steamworks partner and purchased an app credit.

Please note: You will not be able to release your game on Steam until 30 days after purchasing an app credit, or two weeks after your game page goes live after undergoing Steam review and receiving approval, whichever is later. Please plan ahead.

This is a long document. You can either follow all of the steps roughly in order, or use this table of contents to jump directly to a section.

TL;DR

Want to figure things out on your own, and just want to know the images and builds you have to make, or just want a checklist of images before tackling Steamworks configuration?

You must create the following assets for the Steam store page, community, and client:

  • Five game screenshot images (hit the “s” key while playing to easily generate these) (details)
  • One game trailer video (details)
  • Four capsule images for the store (details)
    • A 460x215px header image, which will appear at the top of your store page and in other store views
    • A 231x87px small image, which will appear in search results and recommendations
    • A 616x353px main image that appears on the front page (and will probably never get used unless you are popular)
    • A 374x448px tall image that will also be used in the store
  • Three images for players’ game libraries (details)
    • A 600x900px capsule image to represent your game in the large library view
    • A 3840x1240px header image to display (and scale) at the top of the game page in the library
    • A 1280x720px logo image to overlay on top of the header image above
  • An image for the Steam community (details)
    • A 184x69px capsule image for wishlists
  • An icon for the client distributable (details)
    • A 32x32px ico file, which can automatically generate the TGA and community image

You must create the following game build ZIP to upload:

  • A “markets” game build created with a Steam-library-enabled Ren’Py (details)

You may optionally create the following assets for the Steam store page:

  • A trailer screenshot image (as a loading placeholder for the trailer video) (details)
  • A 1438x810px background image that will appear on your game page (details)

You may optionally create the following asset for the Steam community

  • A 32x32px JPG for the community icon (which can be automatically generated from your ico file above) (details)

You may optionally create the following asset for the client

  • A 16x16px TGA for the client icon (which can be automatically generated from your ico file above) (details)

You may optionally create the following assets for achievements:

  • Two 256x256px JPG images for each achievement, representing the locked and unlocked states (details)

For more step-by-step guidance, read on.

(The above steps do not all apply for additive content such as a demo, DLC, a soundtrack, or bundles. Reference the appropriate sections for details.)

Document Changelog

Suggestions and Contact Information

Bob welcomes suggestions, corrections, and additions to this document. You can reach him at bobcgames(at)gmail.com, from his website bobcgames.com, or on Mastodon as @bobcgames@peoplemaking.games.

However, he requests you do not contact him with questions relating to Ren’Py code, including questions about screen language, patch file creation, and achievement code. For such questions, he recommends the official Ren’Py Discord server.

If you found this guide useful, please consider supporting him by donating to YAGS on itch.io or picking up some YAGS swag.