@jeremyckahn/farmhand 1.19.0 → 1.19.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -24,9 +24,9 @@ Community links:
24
24
 
25
25
  Storefront links:
26
26
 
27
- - https://jeremyckahn.itch.io/farmhand
28
- - https://plaza.dsolver.ca/games/farmhand
29
- - https://www.appimagehub.com/p/1859153
27
+ - <https://jeremyckahn.itch.io/farmhand>
28
+ - <https://plaza.dsolver.ca/games/farmhand>
29
+ - <https://www.appimagehub.com/p/1859153>
30
30
 
31
31
  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!
32
32
 
@@ -84,6 +84,16 @@ npm run dev
84
84
 
85
85
  To run the native app locally, run:
86
86
 
87
+ > [!NOTE]
88
+ > If you are developing on Linux, you will need to run the following commands first:
89
+ >
90
+ > ```sh
91
+ > sudo chown root node_modules/electron/dist/chrome-sandbox
92
+ > sudo chmod 4755 node_modules/electron/dist/chrome-sandbox
93
+ > ```
94
+ >
95
+ > This is a [safe best practice](https://g.co/gemini/share/36d2d91e3031) for working with Electron on Linux.
96
+
87
97
  ```sh
88
98
  npm run dev:native
89
99
  ```
@@ -94,7 +104,7 @@ Note that you will need a Vercel account and be logged into locally for this to
94
104
  npm start
95
105
  ```
96
106
 
97
- 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/.
107
+ 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/>.
98
108
 
99
109
  ### Coding conventions
100
110
 
@@ -157,11 +167,11 @@ Use this GitHub Action to deploy a new version of Farmhand: [![Release New Versi
157
167
 
158
168
  As an authenticated repo owner or collaborator, click "Run workflow" and enter the argument to be passed to [`npm version`](https://docs.npmjs.com/cli/v7/commands/npm-version) and press the green "Run workflow". For updates that do not change [`farmhand.state`](https://jeremyckahn.github.io/farmhand/docs/farmhand.html#.state) (which is most of them), use the default `patch` version. This workflow will deploy Farmhand to:
159
169
 
160
- - https://www.farmhand.life/
161
- - https://jeremyckahn.github.io/farmhand/
162
- - https://jeremyckahn.itch.io/farmhand
163
- - https://www.npmjs.com/package/@jeremyckahn/farmhand
164
- - Playable from https://unpkg.com/browse/@jeremyckahn/farmhand/build/
170
+ - <https://www.farmhand.life/>
171
+ - <https://jeremyckahn.github.io/farmhand/>
172
+ - <https://jeremyckahn.itch.io/farmhand>
173
+ - <https://www.npmjs.com/package/@jeremyckahn/farmhand>
174
+ - Playable from <https://unpkg.com/browse/@jeremyckahn/farmhand/build/>
165
175
 
166
176
  The Action will also publish [the latest release to GitHub](https://github.com/jeremyckahn/farmhand/releases/latest).
167
177
 
@@ -183,7 +193,7 @@ VITE_ENABLE_MINING=true
183
193
 
184
194
  Would enable the `MINING` feature only for the local development environment. You can access the enabled feature flags at runtime by `import`ing the `features` Object from [`config.js`](https://github.com/jeremyckahn/farmhand/blob/develop/src/config.js). See [Adding Custom Environment Variables](https://create-react-app.dev/docs/adding-custom-environment-variables/) for more information on how to use environment variables.
185
195
 
186
- 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.
196
+ 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>.
187
197
 
188
198
  ## License
189
199