Ren’Py Sprite Customizer

Documentation | Itch.io

A pluggable sprite customization framework that allows the creation of any number of playtime-customizable sprites using Ren’Py’s LayeredImages.

The goal of this project is to allow game creators to plug in their own assets and screens to set up character or sprite customization in their own games.

Important

Presently this framework is only compatible with Ren’Py 8+ and Python 3.

Project Layout

customized_sprites.rpy

This is where the sprite customization options are defined. This is the point where your assets meet the library.

images.rpy

Demonstration of using "normal" Ren’Py images in conjunction with customized sprites. This file defines some layeredimages that are based on customized sprites and add expressions.

script.rpy

The demo script that makes use of the sprite customizer library.

The Sprite Customizer Library

The sprite customizer library lives under the game/lib/fxcpds/sprite_customizer directory.

Config File

This file which lives at game/lib/fxcpds/sprite_customizer/config.rpy is the primary configuration for the sprite customizer.

This is where you go if you want to change the style of the sprite customization screens.

The Customizer Directory

This directory is where the customizer screens and images are defined. If you intend to create your own character customization screens, this is a good place to look to understand how the screens are built.

Everything Else

Everything else is library internals and shouldn’t need to be touched unless you want to hack the behavior of the sprite customizer.

Credits

Resources Used

• Example Sprite Layers - https://butterymilk.itch.io/awfully-sweet

• Classroom Background - https://alte.itch.io/uncle-mugens-school

• Cover Image Background - pikisuperstar on Freepik

Contributors

Foxcapades

GemmySystem