Skip to content

communitycenter/stardew.me

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Stardew.me Logo

stardew.me
Highly efficient Stardew Valley 1.5 player sprite renderer API, built in Python

Overview

Stardew.me is a full-stack application (and RESTful API) that, upon being given a body of data from a Stardew Valley save file, will generate a 128x256 PNG file of the player. As it currently stands, stardew.me is the only player renderer capable of processing a version 1.5 Stardew Valley save.

How to use the API

TBD.

Technical breakdown

This Git repository is split into two different parts:

  • backend/: contains all the backend Python code
  • frontend/ contains all the frontend Next.js code

Backend: Python

Under the hood, the player renderer uses Python, as well as Python Image Library and Pillow to generate player sprites. We do this with a combination of a few things:

The renderer searches out for all of the assets, combines them into an image, upscales it, and uploads it into a Cloudflare R2 bucket for storage. Once uploaded, the API returns a Cloudflare R2 object URL that returns the image.

Frontend: Next.js

The frontend is composed of a stack of Next.js, shadcn's UI kit, and TailwindCSS.

Contributing guidelines

TBD

Self-hosting

TBD

About

πŸ‘• Generate Stardew Valley player sprites from save files

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published