Logo art by Kairi
A farming game by Jeremy Kahn
Play Farmhand in your browser!
develop:
- All versioned releases available at unpkg
- Wiki
- Data model documentation
- API deployment logs
Community links:
- Discord link:
- Twitter link:
- Reddit link:
Storefront links:
Farmhand is a resource management game that puts a farm in your hand. It is designed to be both desktop and mobile-friendly and fun for 30 seconds or 30 minutes at a time. Can you build a thriving farming business? Give it a try and find out!
This is an open source project built with web technologies. It is implemented as a Progressive Web App, which means it can be played in your web browser or installed onto your device for offline play.
I am working on this entirely solo in my free time and am building it strictly with open source development tools (aside from hardware and operating systems). Farmhand is designed such that it would be fun for anyone that is into resource management and farming games, but ultimately my goal to make the game that I wish existed, the way I wish it existed. And I want to have fun doing it! 🙂
At this point, the game is completely playable and stable (and worth playing, I think!). However, I would not consider the game "finished," inasmuch as it will never be finished. I plan to work Farmhand as I can for many years to come. Being an open source project, I hope that it will grow and improve organically over time. All that said, it's my goal as a designer and developer to ensure that this game is always stable and playable. It'll only ever get better and have more content over time!
This GitHub project is used for tracking and organizing work. If you'd like to suggest a feature or ask a question, please open a GitHub issue.
Farmhand uses a SemVer-like versioning system. It differs from SemVer because Farmhand is a game and doesn't expose a public API. Rather than the game version being based on an API, it reflects the internal data structure, farmhand.state.
major: Is incremented whenfarmhand.statehas been changed in a backwards-incompatible way.- When these releases are made, automatic migration functionality will keep this transparent to the player.
minor: Is incremented whenfarmhand.statehas been changed in a backwards-compatible way.patch: Is incremented whenfarmhand.statehas been not been changed. This also includes gameplay features and bug fixes that do not result in changes tofarmhand.state.- This implies that significant game changes may only result in
patch-level releases.
- This implies that significant game changes may only result in
- Active development takes place in
develop. mainis updated whendevelopis stable.gh-pagescontains the built assets and is updated automatically whenmainis updated.
- This project is built with Create React App, so please refer to the documentation of that project to learn about the development toolchain.
- Farmhand uses Piskel for the art assets.
Requires:
In your shell, run this to ensure you're using the correct Node version and install all of the dependencies:
nvm i
npm ciIf npm ci errors out due to PhantomJS installation errors (this has been seen in some WSL/Linux environments), try npm_config_tmp=/tmp npm ci instead. See this related comment.
To run the game locally with the API and Redis database, run:
npm run devNote that you will need a Vercel account and be logged into locally for this to work (at least until Vercel fixes this). Alternatively, if you just want to run the front end with no API or backend, you can run:
npm startIn this case, the local app will be using the Production API and database. However you boot, Farmhand will be accessible from http://localhost:3000/.
Automation is done with GitHub Actions. All changes are tested and built upon Git push. Merges to main automatically deploy to Production (the gh-pages branch) upon a successful test run and build.
Use this GitHub Action to deploy a new version of Farmhand:
As an authenticated repo owner or collaborator, click "Run workflow" and enter the argument to be passed to npm version and press the green "Run workflow". For updates that do not change farmhand.state (which is most of them), use the default patch version. This workflow will deploy Farmhand to:
- https://jeremyckahn.github.io/farmhand/
- https://jeremyckahn.itch.io/farmhand
- https://www.npmjs.com/package/@jeremyckahn/farmhand
- Playable from https://unpkg.com/browse/@jeremyckahn/farmhand/build/
The process will take about 3-4 minutes to complete and it will notify the Discord server's #updates channel. It is customary to explain what you just shipped in the #updates channel as well.
Farmhand supports feature flags for code that should only be enabled in specific environments. To create a feature flag, add a line that looks like this in the relevant .env file:
REACT_APP_ENABLE_[FEATURE_NAME]=true
Where [FEATURE_NAME] is replaced with the name of your feature. So, adding this to .env.development.local:
REACT_APP_ENABLE_MINING=true
Would enable the MINING feature only for the local development environment. You can access the enabled feature flags at runtime by importing the features Object from config.js. See Adding Custom Environment Variables for more information on how to use environment variables.
In addition to enabling features via environment variables, players can manually enable them in the browser (such as for beta testing). This can be done by manually constructing a URL query parameter that looks like ?enable_[FEATURE_NAME]=true. For example, to enable the MINING feature, players could use the URL https://jeremyckahn.github.io/farmhand/?enable_MINING=true.