Ren'Py Steam Quickstart

A place for Ren'Py tutorials and reusable Ren'Py code.
Forum rules
Do not post questions here!

This forum is for example code you want to show other people. Ren'Py questions should be asked in the Ren'Py Questions and Announcements forum.
Post Reply
Message
Author
User avatar
jack_norton
Lemma-Class Veteran
Posts: 4030
Joined: Mon Jul 21, 2008 5:41 pm
Completed: Too many! See my homepage
Projects: A lot! See www.winterwolves.com
Tumblr: winterwolvesgames
Contact:

Ren'Py Steam Quickstart

#1 Post by jack_norton » Thu Nov 27, 2014 5:40 am

I've been asked a lot of questions though PM, so I thought to do this post. I don't have much time so I'll keep it short :)
Your game has been greenlit! Yay! now, time to put it on Steam.

Steam API integration
You need to ask Pytom for the steam lib download link, they're not publicly available.
Also remember that achievements AREN'T essential for a successful title. The example I always make is the game of my friend Kao, To The Moon (is a narrative game too albeit done with RPGMaker) which is an absolute topseller and has 1 achievement :D
So for now I think is best for you to wait until pytom does the integration - you can always add achievements later!

Trading Cards
The trading cards don't need any particular integration. Everything is done through the Steam control panel. You go in your app->Steamwork settings->Community->Trading Cards and from there you need to prepare the various assets and upload them. I'm not going to explain this process since everything is explained on the site.

Uploading the game
You need to use a commandline program. Before you run away in panic, is actually a very simple solution, you only need to learn a bit how it works. I can't explain the details even in this case since is long and besides everything is written in the docs. I want instead to share a tip: use the "Build All" option of Ren'Py when building the game.
Why? Because then you have a SINGLE ZIP, with all the OSes, to upload (of course you need to unzip it before uploading!). Since Steam allows players to play the game any OS after you buy it, is smarter to do this. Then, you go in the Installation->Configuration tab, and you define the launch options like this:
launch.png
In practice tells Steam which file to launch for each OS: the base filename will be the same, but we'll have:
SOTW.exe -> Windows
SOTW.app -> Mac
SOTW.sh -> Linux
all in the directory root, so when users click "Launch" they run the game for the right OS.
Another advantage of using the "zip-all" system is that you don't need to mess with the depots configuration, which is a headache. Also you don't need to upload the same resources (like the archive) 3 times for each OS.

Smart depot config
On Steam site there are all the docs to build depots and so on. However I wanted to suggest a "smart" way to do it. Since the Renpy Steam lib might be updated, is wiser to put them in a separate folder, and include them in the depot script, like this:

Code: Select all

"DepotBuildConfig"
{
  "DepotID" "XXXX"

	// include all files recursivley
	"ContentRoot"	""

  "FileMapping"
  {
    "LocalPath" "- steamlibs\*"
    "DepotPath" "."
    "recursive" "1"
  }

  "FileMapping"
  {
    "LocalPath" "BionicHeart\*"
    "DepotPath" "."
    "recursive" "1"
  }

}
This way, if a new version of Ren'Py Steam lib are available, you only need to extract them and update that folder (in my example above, "- steamlibs") and run the build script again. In theory you could do the same for all common Ren'Py directories and just have specific "game" subfolder for each title, but might become a bit of headache :)

OK I hope the post will be useful to someone! I am afraid I can't provide more support than that (no time, ugh) so don't ask me how to build depots, script files, etc. You need to study the Steam docs for this :wink:
Last edited by jack_norton on Fri May 29, 2015 12:07 pm, edited 2 times in total.
follow me on Image Image Image Image
computer games

User avatar
noeinan
Eileen-Class Veteran
Posts: 1080
Joined: Sun Apr 04, 2010 10:10 pm
Projects: Ren'Py QuickStart, Crimson Rue
Organization: Statistically Unlikely Games
Deviantart: daikiraikimi
Github: daikiraikimi
Location: Washington State, USA
Contact:

Re: Ren'Py Steam Quickstart

#2 Post by noeinan » Thu Nov 27, 2014 6:20 am

Wow, thanks for sharing this, Jack!
Image

Image
Image

User avatar
jack_norton
Lemma-Class Veteran
Posts: 4030
Joined: Mon Jul 21, 2008 5:41 pm
Completed: Too many! See my homepage
Projects: A lot! See www.winterwolves.com
Tumblr: winterwolvesgames
Contact:

Re: Ren'Py Steam Quickstart

#3 Post by jack_norton » Tue Apr 28, 2015 12:05 pm

I've updated the first post with some info on how to configure the depots, now that the Steam Ren'Py lib are available.
Maybe some mod could make this post sticky since seems many people ask for help with Steam?
follow me on Image Image Image Image
computer games

User avatar
storykween
Regular
Posts: 151
Joined: Mon Sep 30, 2013 1:17 pm
Completed: Serafina's Saga, Quantum Conscience, Echoes of the Fey, miraclr - Divine Dating Sim
Organization: Woodsy Studio
Location: St Louis
Contact:

Re: Ren'Py Steam Quickstart

#4 Post by storykween » Thu May 28, 2015 9:36 pm

Putting up one of my games on Steam for the first time now... so thanks a lot for this!
Image
My website: woodsy-studio.com

User avatar
Bryy
Veteran
Posts: 368
Joined: Thu Dec 20, 2012 10:12 pm
Completed: Army of Tentacles 1 & 2, Paper Shakespeare: To Date or Not To Date?
Projects: Furries & Scalies & Bears OH MY!, The Ghost of Joe Papp 2: The Dragons of Joe Papp
Organization: Stegalosaurus Game Development
Location: Bay Area, CA
Contact:

Re: Ren'Py Steam Quickstart

#5 Post by Bryy » Sun Dec 13, 2015 8:56 pm

Sorry for the necro, but the .exe is the filename of the game, right? The main application file? Because I just built my beta build, and it says it is missing an executable when I try to launch it on Steam.

My current .exe path is Army of Tentacles.exe; should it be ArmyofTentacles.exe?

User avatar
storykween
Regular
Posts: 151
Joined: Mon Sep 30, 2013 1:17 pm
Completed: Serafina's Saga, Quantum Conscience, Echoes of the Fey, miraclr - Divine Dating Sim
Organization: Woodsy Studio
Location: St Louis
Contact:

Re: Ren'Py Steam Quickstart

#6 Post by storykween » Mon Dec 14, 2015 9:30 am

@Bryy Leaving spaces out of your file names is always a good idea. But first try disabling your antivirus software before launching; that could cause the problem
Image
My website: woodsy-studio.com

User avatar
ChronoWorkS
Newbie
Posts: 16
Joined: Mon Dec 28, 2015 4:58 am
Contact:

Re: Ren'Py Steam Quickstart

#7 Post by ChronoWorkS » Mon Dec 28, 2015 5:25 am

Thank you for this! Hopefully sometime soon I want to put my game on Steam and I knew nothing, so this helps me a lot

User avatar
Taju
Newbie
Posts: 16
Joined: Tue Feb 03, 2015 10:16 am
Projects: Con Amore
Contact:

Re: Ren'Py Steam Quickstart

#8 Post by Taju » Wed Jun 29, 2016 8:37 am

Thank you so much for this! It has really helped me to understand how to proceed. Getting Greenlighted and trying to figure out how to get the game to Steam can be a little overwhelming.

User avatar
Shagwrath
Regular
Posts: 70
Joined: Tue Apr 12, 2016 8:08 pm
Projects: Shison L, Cosmic Raven
Organization: Progeny Gaming, LLC.
IRC Nick: Shagwrath
Deviantart: shawnbaybo
Location: St. Louis, MO. USA.
Contact:

Re: Ren'Py Steam Quickstart

#9 Post by Shagwrath » Thu Jun 30, 2016 5:19 am

Bookmarking this, thank you for making an awesome guide on this process.
Image
Cosmic Raven - Episode 1
[KN][Comedy][Sci-Fi][Short][18+]

User avatar
jack_norton
Lemma-Class Veteran
Posts: 4030
Joined: Mon Jul 21, 2008 5:41 pm
Completed: Too many! See my homepage
Projects: A lot! See www.winterwolves.com
Tumblr: winterwolvesgames
Contact:

Re: Ren'Py Steam Quickstart

#10 Post by jack_norton » Thu Jun 30, 2016 6:29 am

You're welcome, hoped that some mod could make this thread sticky maybe?
follow me on Image Image Image Image
computer games

User avatar
Kinmoku
Veteran
Posts: 463
Joined: Mon Aug 11, 2014 9:39 am
Completed: One Night Stand
Projects: Love IRL, Memories
Tumblr: gamesbykinmoku
itch: kinmoku
Location: Germany
Contact:

Re: Ren'Py Steam Quickstart

#11 Post by Kinmoku » Thu Oct 27, 2016 4:35 am

Thanks for this! I was having a headache with all the depots until I saw that I could just create an "all" build! Now, my game is working, hurray!

I'm wondering, though, what the steamlibs is about? I haven't put that in mine and it works okay. Am I missing something? I don't know what it's for.

User avatar
jack_norton
Lemma-Class Veteran
Posts: 4030
Joined: Mon Jul 21, 2008 5:41 pm
Completed: Too many! See my homepage
Projects: A lot! See www.winterwolves.com
Tumblr: winterwolvesgames
Contact:

Re: Ren'Py Steam Quickstart

#12 Post by jack_norton » Thu Oct 27, 2016 4:54 am

Without steamlib the achievements won't work - you need to ask Pytom about the steamlib URL.
As for the build-all, looks like Apple managed to screw developers once again with the new OS and their "security features". I think that soon won't be possible to use that method anymore. Personally I'm considering dropping Mac support altogether, since the % of users is really small and it's the platform that causes most problems (not just for Ren'Py, in general for all development tools).
follow me on Image Image Image Image
computer games

User avatar
Kinmoku
Veteran
Posts: 463
Joined: Mon Aug 11, 2014 9:39 am
Completed: One Night Stand
Projects: Love IRL, Memories
Tumblr: gamesbykinmoku
itch: kinmoku
Location: Germany
Contact:

Re: Ren'Py Steam Quickstart

#13 Post by Kinmoku » Thu Oct 27, 2016 5:35 am

jack_norton wrote:Without steamlib the achievements won't work - you need to ask Pytom about the steamlib URL.
As for the build-all, looks like Apple managed to screw developers once again with the new OS and their "security features". I think that soon won't be possible to use that method anymore. Personally I'm considering dropping Mac support altogether, since the % of users is really small and it's the platform that causes most problems (not just for Ren'Py, in general for all development tools).
Thanks Jack, I'll message him.

It's a shame about Mac (since I'm using Mac) but it is a real pain, I understand. Really wishing I had a PC at this point as uploading to Steam with Mac is difficult, to say the least!

Post Reply

Who is online

Users browsing this forum: Tesspolar