Skip to content

jamdays/FarmsBurner

Repository files navigation

Farms Burner

Created by Maximillian Djaya, Punnawit Payapvattanavong, Aayush Karki, and Melody Mo.

Table of Contents

About

Overview

Farms Burner is an idle farming game in which the in-game weather is dependent on real world weather data, based on a user-chosen location.

What does Farms Burner do?

  • In Farms Burner, players get the full farming simulation game experience
  • Choose a starting city to base your in-game weather off of
  • Till open grassland, and plant numerous different types of crops on these tilled areas
  • Water and fertilize your crops, and log off to give them ample time to grow and mature
  • Harvest and sell matured crops, earning BarnBucks that can be used to buy powerful farming tools
  • Use these tools to make your farm more efficient, and develop your Agro-Empire!

Why was Farms Burner created?

  • As a video game, Farms Burner was ultimately created for the purposes of user enjoyment
  • We wanted to craft an overall experience that captures the comfort of an idle farming sim, while also being innovative through features like incorporating real world weather data
  • We hope that users of Farms Burner find the game satisfying and rewarding to play, and a good (but temporary, don't get addicted) escape from the perils of the modern day world

What problem does Farms Burner solve? Is Farms Burner right for me?

  • Although many farming games exist on the market today, none of them incorporate real world weather data in their gameplay
  • The experience of playing Farms Burner is one that allows for the lines between the virtual and physical world to be blurred
  • Farms Burner is right for users who want the experience of starting a farm in their hometown, but don't actually have the ridiculous sums of money required to buy any sort of property these days
  • Moreover, the game is great for players who want to experience what different climates are like through the comfort of their own home (and once again without spending ridiculous amounts of money to travel)

Software Features

Choose Game Location

  • You can set your city within the welcome screen
  • Doing this syncs the real-world weather in that city with the in-game weather of your Farms Burner save file
  • Weather has impacts on the growth rate of crops, the accumulation of power as well as the sell price of crops

Claim, Water and Fertilize Plots of Land

  • The game allows you to claim plots of land to get them ready for farming
  • Once tilled, the land can be watered or fertilized, both of which will update its appearance and effect on crops
  • Plots of land must be tilled before plants can be planted there

Grow, Harvest and Sell Crops

  • Tilled pieces of land can have crops grown on them; what you choose to grow is totally up to you!
  • Different crops have different attributes, and will grow better in some climates than others
  • Once mature, crops can be harvested and sent to your farm storage
  • Crops in farm storage can be sold for BarnBucks

Use BarnBucks to Purchase Powerful Farm Upgrades

  • Selling crops provides you with the currency of Farms Burner, BarnBucks
  • This currency can be used to purchase farm upgrades such as sprinklers, which help to make the farming process more efficient

Installation Instructions

  • Download a Java IDE such as IntelliJ
  • Open this repository in your chosen IDE
  • Run the FarmsBurnerApplication class
  • Enjoy the game!

Usage Guide

Welcome Screen

  • When first loading the game, you'll find yourself at the welcome screen, where you'll have the option to start a new game or load one from a save file
  • If beginning a new game, simply type in the name of the city whose weather you wish to sync your in-game weather to
  • If loading from a save file, you'll find that your chosen city, as well as progress you previously made on your farm, will be ready for you once the game loads in

Working the Land

  • To claim a piece of land, hold down shift and then click on the plot
  • To water a piece of land that has been claimed, hold down alt and then click on the plot
  • To fertilize a piece of land that has been claimed, hold down ctrl + alt and then click on the plot

Planting Crops

  • To select a crop type to plant, click on the button labelled "Select Crop Type" and choose from the available options
  • To plant a chosen crop on a piece of claimed land, hold down ctrl and then click on the plot

Harvesting Crops

  • To harvest a crop that is ready to be harvested, click on the plot while not holding down any other key
  • This will harvest the crop and add it to your farm storage, allowing you to sell it for BarnBucks

Selling Crops

  • To sell your crops that have been harvested, click on the sell button on the top of the screen to access the sell crop interface

Buying Tools

  • To buy farm tools, click on the buy button on the top of the screen to access the buy crop interface

Using Tools

  • To select a tool to use, click on the button labelled "Select Tool" and choose from the available options
  • To use a chosen tool on a piece of claimed land, simply use the input that the tool corresponds to (ex. to use sprinkler, hold down alt and click on a plot to water a larger area)

Check the Weather

  • To check the current weather at anytime, click on the weather button on the top of the screen to access the weather interface
  • Similarly, you can find the forecast weather for the next 5 days (in 3 hour increments) by clicking on the forecast button on the top of the screen

Feedback

How to Reach Us

  • Although it is pretty great, Farms Burner isn't perfect; it is still a work in progress
  • On that note, we'd love to hear your feedback on how to make Farms Burner the best farming simulator it can be!
  • If you notice any bugs during gameplay, we'd love to hear from you to try and quash them as soon as possible
  • Before reaching out to us, however, make sure that the bug isn't already in the "Known Issues" section below
  • To allow for user feedback on bugs, we have opened a google form
  • When submitting a request, please make sure to provide a good description on when and how the bug occurs, so that we can replicate it ourselves
  • If we are able to replicate your bug successfully and verify that it is an issue, it will be added to the list of known issues below

Known Issues

  • There are currently no known issues to report

Contributions

  • If you're looking to make a contribution to Farms Burner, we would be happy to take a look at what you can do!
  • To get an idea of where to start with contributions, read through the issues log in the repository to see what features and fixes are needed
  • To contribute, begin by forking this repository (for a tutorial on how, click here) and make your desired changes
  • Once done, create a pull request by following the instructions here
  • After doing this, give us some time to take a look at your pull request and review it
  • We'll respond with some feedback on the pull request, as well as a decision regarding whether it is going to be approved or denied
  • If denied, don't fret! You can always improve upon your code and resubmit when its ready for another look

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages