hpeinar / stardewplanner

Stardew Valley farm planner
Apache License 2.0
243 stars 49 forks source link

Stardew Valley farm planner

Source code of https://stardew.info/planner/

Author

Henrik Peinar @hpeinar

Special note

This project is built with tools offered by JetBrains
JetBrains

How to contribute

Some stuff that community has asked but are not yet implemented

Donate

Donations in any sum are very appreciated.

Installation & running

Alternative 1

npm install
node index.js
open http://127.0.0.1:3000

Contributors

Integration

POST /api/import
CORS enabled endpoint which imports given save game file to the planner.
Expects saveGame.xml or saveGame.zip as file parameter in the post. Please note that it implements regular zip format, not gzip.

Note: This endpoint is rate limited to 600 requests per 15m (40 requests per minute)
Note: saveGame.xml limit is 25mb

Usage:
curl --form "file=@saveFile.xml" https://stardew.info/api/import

Response:

{
  "id": "readable-id-of-the-save",
  "absolutePath": "https://stardew.info/planner/readable-id-of-the-save"
}

Error response:

{
  "message": "Missing file"
}

Credits

License

Stardew Valley by ConcernedApe, Chucklefish LTD Copyright 2012
Stardew Planner licensed under the Apache License v2