jeremyckahn/farmhand - Githubissues

_{Logo art by Kairi}

A farming game by Jeremy Kahn

Latest release
- Includes native app downloads for Linux, MacOS and Windows.
All versioned releases available at unpkg
Wiki
API deployment logs

Community links:

Discord link:
Reddit link:
Instagram 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.

State of the project

Farmhand is completely playable and stable. However, the game should not be considered "finished," inasmuch as it will never be finished. It is an ongoing open source project that will grow and improve organically over time. Stability and cohesiveness are top priorities for the project. 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, or join the Discord.

Versioning system

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 when farmhand.state has 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 when farmhand.state has been changed in a backwards-compatible way.
patch: Is incremented when farmhand.state has been not been changed. This also includes gameplay features and bug fixes that do not result in changes to farmhand.state.
- This implies that significant game changes may only result in patch-level releases.

Branch structure

Active development takes place in develop.
main is updated when develop is stable.
gh-pages contains the built assets and is updated automatically when main is updated.

Project overview

This project uses Vite, so please refer to the documentation of that project to learn about the development toolchain.
Farmhand uses Piskel for the art assets.

Running locally

Requires:

Node/NPM
Docker
nvm (or alternatively asdf)

In your shell, run this to ensure you're using the correct Node version and install all of the dependencies:

nvm i
npm ci --legacy-peer-deps

If npm ci --legacy-peer-deps 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. Alternatively, try npm ci --no-optional --legacy-peer-deps.

To run the game locally with the API, Redis database, and peer pairing server, run:

npm run dev

To run the native app locally, run:

npm run dev:native

Note 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 start

In this case, the local app will be using the Production API, database, and pairing server. However you boot, Farmhand will be accessible from http://localhost:3000/.

Coding conventions

Farmhand uses Prettier and ESLint to ensure a consistent code style. Both tools are run as part of the pre-commit Git hook (please do not override this).
React event handler naming should follow the convention described in this article.
- Any pre-existing code that does not adhere to this convention should be updated to do so.
Regarding automated tests: Write tests. Not too many. Mostly integration.

Multiplayer system architecture

The system design for Farmhand's multiplayer functionality has been detailed in this blog post.

CI/CD

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.

Smoke testing

All are welcome to help with smoke testing Farmhand to ensure the game is stable! All you need is to be logged into GitHub and open a new Smoke Test Report issue. This issue will have interactive checkboxes that you can use to track your progress. Once smoke testing is complete, please close the issue.

It would be a good idea to perform a smoke test whenever there is a significant change to the codebase (such as a major new feature or refactor). The process is intended to catch defects before making a Production release. If any issues are encountered during testing, please leave a comment on the Smoke Test Report issue explaining what you experienced. Non-trivial issues should be addressed by the dev team before releasing to the Production environment.

Releasing updates

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:

The Action will also publish the latest release to GitHub.

The process will take several 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.

Feature flags

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:

VITE_ENABLE_[FEATURE_NAME]=true

Where [FEATURE_NAME] is replaced with the name of your feature. So, adding this to .env.development.local:

VITE_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://www.farmhand.life?enable_MINING=true.

License

All Farmhand code and is licensed under GNU GPL v2. All media assets (such as game art) are licensed under CC BY-NC-SA 4.0.