Stardew Valley farm planner
JavaScript HTML CSS
Latest commit f71f5e4 Jan 7, 2017 @hpeinar Updated css cache version

README.md

Stardew Valley farm planner

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

Author

Henrik Peinar @hpeinar

How to contribute

  • Make PR
  • I'll review it and merge if it checks out
  • I'll update https://stardew.info/planner/ with your code in it so other people can also enjoy new features
  • I'll add you to contributors list (feel free to do so in the PR).

Some stuff that community has asked but are not yet implemented

  • Count for different stuff placed (how many sprinkers, roads etc)
  • Image export
  • More trees, tappers.
  • Depth rendering so buildings etc could be fully drawn out
  • Save exporting
  • Better highlights
  • Also would be cool to have list of done plans

Donate

Donations in any sum are very appreciated.

Installation & running

Alternative 1

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

Alternative 2: Vagrant

Vagrant can be used to automatically install the project in a virtual machine.

To use the provided Vagrant configuration you should: 1. Install Vagrant and VirtualBox. 2. Run vagrant up in the repository's root directory, using your terminal/command prompt. 3. Once the setup has finished, open http://127.0.0.1:3000 in your browser.

Repeat steps 2 and 3 whenever you wish to start the VM. Subsequent startups are significantly faster.

For more in-depth instructions on how to use Vagrant, refer to the Vagrant documentation.

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

Background image exported from game by /u/zaxcz
Building sizes and door locations by /u/Jurk0wski
Base save importing code by /u/ThisIsMyName777
Tons of suggestions, fixes, testing and ideas by R3ality
Providing test save file with most of the items and ID's Mai from #stardewvalley
Being a cool guy and pointing me in the right direction with some coding stuff TeMPOraL from #stardewvalley
Helping to test and improve v2 version of the tool speeder from #stardewvalley
Sharing their epic farm saves /u/ky13 & /u/Halfbloood
Stardew Valley by ConcernedApe

License

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