Declare automatically images/sprites from your files names

[Ziassan]

edit : note that since 6.10.0 you have an automatic simple version of this by enabling this config http://renpy.org/wiki/renpy/doc/referen ... tic_images
The code below allows you to have control on the thing and to adapt it to your needs.

Starting with Ren'py itself but old in general coding, I thought it was a bit bothering sometimes to have to write exactly the same thing in the pictures names and then in the code. Like "image Satria embarassed = 'img/Satria/embarassed.png" : two time nearly the same thing, in coding, is bad... it needs to be improved.

Data path and variable names looking that similar... a lot of time can surely be earned.

Code: Select all

init python hide:

    for file in renpy.list_files():
        if file.startswith('img/'):
            if file.endswith('.png'):
                name = file.replace('img/','').replace('/', ' ').replace('.png','')
                renpy.image(name, Image(file, yanchor=400))
                continue
            continue

Replace img by your image directory (or the directory where you want Ren'py to use images to make variables). You have to use some conventions in naming files but it works for every picture (sprites, BG, CG, ...).

In short: it takes every files in the directory you want, and see if they are PNG files (you can change the extension too). Then it takes the path of the file and build the image variable from it. "img/Satria/upside_down.png" wille create a "Satria upside_down", "img/CG/black_night.png" will do a "CG black_night".


With that in your directory : http://puu.sh/MfYT http://puu.sh/MfV0
It will avoid you to write these lines :

Code: Select all

image Satria embarassed = 'img/Satria/embarassed.png"
image Satria upside_down = 'img/Satria/upside_down.png"
etc...

An other advantage is that you just have to add a picture to your directory and you can already use it in your code.

[SusanTheCat]

Sweet!

Thank you!

Susan

[Obscura]

OMG, this is awesome Ziassan. Thanks for sharing!

[TrickWithAKnife]

Wow, I can't tell you how useful this will be. And easy to use too!

[Sapphi]

Correct me if I'm wrong, but isn't Ren'Py set up this way so that it can load all the images at the start of the game so that the game works faster in the end? I thought I read that somewhere...

[Ziassan]

Hmm does that make a difference ? I mean, the code I wrote makes pretty much the same thing than declaring the images normally.
This line "renpy.image(name, Image(file, yanchor=400))" is the equivalent of the "image" thing. The difference is that here, I'm building the images declarations from the names of the data directly.

[netravelr]

Just learned about this about a week ago. Python is so cool with having access to doing stuff like this. Great find!

[Sapphi]

Hmm does that make a difference ? I mean, the code I wrote makes pretty much the same thing than declaring the images normally.
This line "renpy.image(name, Image(file, yanchor=400))" is the equivalent of the "image" thing. The difference is that here, I'm building the images declarations from the names of the data directly.

Oh, I'm sorry. That does make sense. (I feel so dumb...)
Now that I know this, I will probably use your code so thanks in advance

[Reizeron]

Not working if file or folder names contains numbers.
Nevermind, just forgot that a number should not be first character.

[Shiz]

This has been in Ren'Py itself since version 6.10.0 already: http://renpy.org/wiki/renpy/doc/referen ... tic_images

[Ziassan]

Oh, indeed, I wonder how many people knew about it.

Well I'll still leave my code as it allows more flexibility and controle if someone wants to do something specific about that. But thanks, I'll edit the first post about that.

[PyTom]

Ziassan's method is probably better than the built in one, as it gives far more control. The built-in method predates me making renpy.list_files() public - if the archive format had been opened up earlier, there never would have been a config.automatic_images.

[leon]

If anyone needs flipped sprites (facing the other way) as well:

Code: Select all

init python hide:
    for file in renpy.list_files():
        if (file.startswith('sprites/')) and (file.endswith('.png')):
            name = file.replace('sprites/','').replace('/', ' ').replace('.png','')
            name_flipped = name + ' flip'
            renpy.image(name, Image(file, yalign=1.0))
            renpy.image(name_flipped, im.Flip(Image(file), horizontal=True, yalign=1.0))

[inarizushi]

I'm using your method to load images but ran into a strange problem with side images. From the documentation I read, it looks like the "side" tag needs to be added to an image the same way "happy" would. So if I have the image "img/side/sue/happy.png", when it loops through the directories it should create an image like so:

renpy.image("side sue happy", Image("img/side/sue/happy.png"))

which is the same, hopefully, as declaring this:

image side sue happy = "img/side/sue/happy.png"

Except I can only get the second way to work. I know the image is being loaded in the first example because "show side sue happy" works.

Any ideas?