Merge branch 'next' into perf-test

Author: zardoy

.dockerignore

@@ -1,5 +1,3 @@
-# we dont want default config to be loaded in the dockerfile, but rather using a volume
-config.json
 # build stuff
 node_modules
 public

.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-name: Deploy to GitHub pages
+name: Release
 env:
   VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
   VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
@@ -17,6 +17,7 @@ jobs:
       # - run: pnpm install
       # - run: pnpm build
       - run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}
+      - run: node scripts/replaceFavicon.mjs ${{ secrets.FAVICON_MAIN }}
       # will install + build to .vercel/output/static
       - run: vercel build --token=${{ secrets.VERCEL_TOKEN }} --prod
       - run: pnpm build-storybook

.storybook/preview.tsx

@@ -1,17 +1,18 @@
 import React from 'react'
 
-import type { Preview } from "@storybook/react";
+import type { Preview } from "@storybook/react"
 
-import '../src/styles.css'
 import './storybook.css'
+import '../src/styles.css'
+import '../src/scaleInterface'
 
 const preview: Preview = {
   decorators: [
     (Story, c) => {
       const noScaling = c.parameters.noScaling
       return <div id={noScaling ? '' : 'ui-root'}>
         <Story />
-      </div>;
+      </div>
     },
   ],
   parameters: {
@@ -23,6 +24,6 @@ const preview: Preview = {
       },
     },
   },
-};
+}
 
-export default preview;
+export default preview

CONTRIBUTING.md

@@ -21,7 +21,7 @@ How different modules are used:
 
 - `mineflayer` - provider `bot` variable and as mineflayer states it is a wrapper for the `node-minecraft-protocol` module and is used to connect and interact with real Java Minecraft servers. However not all events & properties are exposed and sometimes you have to use `bot._client.on('packet_name', data => ...)` to handle packets that are not handled via mineflayer API. Also you can use almost any mineflayer plugin.
 
-## Making protocol changes
+## Making protocol-related changes
 
 You can get a description of packets for the latest protocol version from <https://wiki.vg/Protocol> and for previous protocol versions from <https://wiki.vg/Protocol_version_numbers> (look for *Page* links that have *Protocol* in URL).
 
@@ -37,6 +37,7 @@ Also there are [src/generatedClientPackets.ts](src/generatedClientPackets.ts) an
 - Some data are cached between restarts. If you see something doesn't work after upgrading dependencies, try to clear the by simply removing the `dist` folder.
 - The same folder `dist` is used for both development and production builds, so be careful when deploying the project.
 - Use `start-prod` script to start the project in production mode after running the `build` script to build the project.
+- If CI is failing on the next branch for some reason, feel free to use the latest commit for release branch. We will update the base branch asap. Please, always make sure to allow maintainers do changes when opening PRs.
 
 ### Would be useful to have
 

Dockerfile

@@ -1,9 +1,22 @@
-FROM node:14-alpine
+FROM node:18-alpine
 # Without git installing the npm packages fails
 RUN apk add git
 RUN mkdir /app
 WORKDIR /app
 COPY . /app
-RUN npm install
-RUN npm run build
+# install python and other dependencies
+RUN apk add python3 make g++ cairo-dev pango-dev jpeg-dev giflib-dev librsvg-dev
+# install pnpm
+RUN npm i -g pnpm@9.0.4
+RUN pnpm install
+# only for prod
+RUN pnpm run build
+# ---
+EXPOSE 8080
+# uncomment for development
+# EXPOSE 9090
+# VOLUME /app/src
+# VOLUME /app/prismarine-viewer
+# ENTRYPOINT ["pnpm", "run", "run-all"]
+# only for prod
 ENTRYPOINT ["npm", "run", "prod-start"]

README.MD

@@ -4,14 +4,14 @@
 
 A true Minecraft client running in your browser! A port of the original game to the web, written in JavaScript using modern web technologies.
 
-If you encounter any bugs or usability issues, please report them!
+If you encounter any bugs or usability issues, please report them! For development, see [development](#development--debugging).
 
 You can try this out at [mcraft.fun](https://mcraft.fun/), [pcm.gg](https://pcm.gg) (short link) [mcon.vercel.app](https://mcon.vercel.app/) or the GitHub pages deploy. Every commit from the `develop` (default) branch is deployed to [s.mcraft.fun](https://s.mcraft.fun/) - so it's usually newer, but might be less stable.
 
 ### Big Features
 
 - Open any zip world file or even folder in read-write mode!
-- Connect to cracked servers* (it's possible because of proxy servers, see below)
+- Connect to Java servers running in both offline (cracked) and online mode* (it's possible because of proxy servers, see below)
 - Singleplayer mode with simple world generations!
 - Works offline
 - Play with friends over internet! (P2P is powered by Peer.js discovery servers)
@@ -39,9 +39,9 @@ Whatever offline mode you used (zip, folder, just single player), you can always
 
 ### Servers
 
-You can play almost on any server, supporting offline connections.
+You can play almost on any Java server, vanilla servers are fully supported.
 See the [Mineflayer](https://github.com/PrismarineJS/mineflayer) repo for the list of supported versions (should support majority of versions).
-There is a builtin proxy, but you can also host a your one! Just clone the repo, run `pnpm i` (following CONTRIBUTING.MD) and run `pnpm prod-start`, then you can specify `http://localhost:8080` in the proxy field.
+There is a builtin proxy, but you can also host your one! Just clone the repo, run `pnpm i` (following CONTRIBUTING.MD) and run `pnpm prod-start`, then you can specify `http://localhost:8080` in the proxy field.
 MS account authentication will be supported soon.
 
 ### Rendering
@@ -67,9 +67,9 @@ There are many many settings, that are not exposed in the UI yet. You can find o
 
 To open the console, press `F12`, or if you are on mobile, you can type `#debug` in the URL (browser address bar), it wont't reload the page, but you will see a button to open the console. This way you can change advanced settings and see all errors or warnings. Also this way you can access global variables (described below).
 
-### Debugging
+### Development & Debugging
 
-It should be easy to build/start the project locally. See [CONTRIBUTING.MD](./CONTRIBUTING.md) for more info.
+It should be easy to build/start the project locally. See [CONTRIBUTING.MD](./CONTRIBUTING.md) for more info. Also you can look at Dockerfile for reference.
 
 There is world renderer playground ([link](https://mcon.vercel.app/playground.html)).
 
@@ -113,10 +113,10 @@ Press `Y` to set query parameters to url of your current game state.
 - `?version=<version>` - Set the version for server
 - `?lockConnect=true` - Disable cancel / save buttons, useful for integrates iframes
 - `?reconnect=true` - Reconnect to the server on page reloads. Available in **dev mode only** and very useful on server testing.
-<!-- - `?password=<password>` - Set the password on load -->
 - `?loadSave=<save_name>` - Load the save on load with the specified folder name (not title)
 - `?singleplayer=1` - Create empty world on load. Nothing will be saved
 - `?noSave=true` - Disable auto save on unload / disconnect / export. Only manual save with `/save` command will work
+<!-- - `?requiresAuth=true` - Show the Microsoft login screen on server connect. Useful for servers that require authentication (running in online mode) -->
 
 - `?map=<map_url>` - Load the map from ZIP. You can use any url, but it must be CORS enabled.
 - `?setting=<setting_name>:<setting_value>` - Set the and lock the setting on load. You can set multiple settings by separating them with `&` e.g. `?setting=autoParkour:true&setting=renderDistance:4`

README.NPM.MD

@@ -1,9 +1,13 @@
 # Minecraft React
 
+Minecraft UI components for React.
+
 ```bash
-yarn add minecraft-react
+pnpm i minecraft-react
 ```
 
+![demo](https://github-production-user-asset-6210df.s3.amazonaws.com/46503702/346295584-80f3ed4a-cab6-45d2-8896-5e20233cc9b1.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240706%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240706T195400Z&X-Amz-Expires=300&X-Amz-Signature=5b063823a57057c4042c15edd1db3edd107e00940fd0e66a2ba1df4e564a2809&X-Amz-SignedHeaders=host&actor_id=46503702&key_id=0&repo_id=432411890)
+
 ## Usage
 
 ```jsx

assets/extra-textures/loading.png

@@ -14,7 +14,7 @@ const compareRenderedFlatWorld = () => {
 }
 
 const testWorldLoad = () => {
-  return cy.document().then({ timeout: 20_000 }, doc => {
+  return cy.document().then({ timeout: 25_000 }, doc => {
     return new Cypress.Promise(resolve => {
       doc.addEventListener('cypress-world-ready', resolve)
     })