From 5300f0cde5f526272836c4e3d812f2d830bc2c2b Mon Sep 17 00:00:00 2001 From: Vitaly Date: Wed, 9 Aug 2023 16:24:22 +0300 Subject: [PATCH] remove not needed files --- .github/dependabot.yml | 7 --- .github/workflows/ci.yml | 61 ----------------------- HISTORY.md | 34 ------------- README.md | 105 --------------------------------------- README_PT.md | 104 -------------------------------------- README_RU.md | 105 --------------------------------------- 6 files changed, 416 deletions(-) delete mode 100644 .github/dependabot.yml delete mode 100644 .github/workflows/ci.yml delete mode 100644 HISTORY.md delete mode 100644 README.md delete mode 100644 README_PT.md delete mode 100644 README_RU.md diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index 4872c5af..00000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,7 +0,0 @@ -version: 2 -updates: -- package-ecosystem: npm - directory: "/" - schedule: - interval: daily - open-pull-requests-limit: 10 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml deleted file mode 100644 index c46e0626..00000000 --- a/.github/workflows/ci.yml +++ /dev/null @@ -1,61 +0,0 @@ -name: CI - -on: - push: - branches: [ master ] - pull_request: - branches: [ master ] - -jobs: - build: - - runs-on: ubuntu-latest - - strategy: - matrix: - node-version: [18.x] - - steps: - - uses: actions/checkout@v2 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v1 - with: - node-version: ${{ matrix.node-version }} - - run: npm install - - run: npm run build - - run: npm test - DeployPages: - runs-on: ubuntu-latest - if: ${{ github.event_name == 'push' }} - steps: - - name: Checkout 🛎️ - uses: actions/checkout@v2.3.1 # If you're using actions/checkout@v2 you must set persist-credentials to false in most cases for the deployment to work correctly. - with: - persist-credentials: false - fetch-depth: 0 - - name: Edit config - run: | - sed -i -E 's/^ "defaultProxy": ""/ "defaultProxy": "pproxy.rom1504.fr"/g' config.json - sed -i -E 's/^ "defaultProxyPort": 0/ "defaultProxyPort": 443/g' config.json - - name: Build - run: | - npm install - npm run build - cp -R public/ ../ - rm -Rf ./* - git checkout gh-pages - rm -Rf ./* - rm -Rf .github .gitignore .gitpod .gitpod.DockerFile .npmignore .npmrc - cp -R ../public/* ./ - - name: Create commits - run: | - git config user.name 'rom1504bot' - git config user.email 'rom1504bot@users.noreply.github.com' - git add --all - git commit --amend -m "Update gh-pages" - - name: Deploy 🚀 - uses: ad-m/github-push-action@master - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - branch: gh-pages - force: true diff --git a/HISTORY.md b/HISTORY.md deleted file mode 100644 index 07c58661..00000000 --- a/HISTORY.md +++ /dev/null @@ -1,34 +0,0 @@ -## History - -### 1.5.0 - -* Add BossBars @sverben (PrismarineJS#319) -* save all play screen options @Fury-101 (PrismarineJS#326) - -### 1.4.0 - -* so much - -### 1.3.0 - -* a lot - -### 1.2.0 - -* custom proxy selection (@Karang) -* loading screen (@AwesomestCode) -* better chat (@AwesomestCode) -* default random name (@rom1504) -* fix pixelated (@Karang) -* placing and breaking (@ShrimpyStuff) -* crosshairs (@AwesomestCode) - -### 1.1.0 - -* chat -* better font -* pitch fix - -### 1.0.1 - -* initial implementation diff --git a/README.md b/README.md deleted file mode 100644 index 6a1a9ea9..00000000 --- a/README.md +++ /dev/null @@ -1,105 +0,0 @@ -# prismarine-web-client -[![NPM version](https://img.shields.io/npm/v/prismarine-web-client.svg)](http://npmjs.com/package/prismarine-web-client) -[![Build Status](https://github.com/PrismarineJS/prismarine-web-client/workflows/CI/badge.svg)](https://github.com/PrismarineJS/prismarine-web-client/actions?query=workflow%3A%22CI%22) -[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/GsEFRM8) -[![Try it on gitpod](https://img.shields.io/badge/try-on%20gitpod-brightgreen.svg)](https://gitpod.io/#https://github.com/PrismarineJS/prismarine-web-client) - -| 🇺🇸 [English](README.md) | 🇷🇺 [Russian](README_RU.md) | 🇵🇹 [Portuguese](README_PT.md) | -| ----------------------- | -------------------------- | ---------------------------- | - -A Minecraft client running in a web page. **Live demo at https://prismarinejs.github.io/prismarine-web-client/** - - -## How it Works -prismarine-web-client runs mineflayer and prismarine-viewer in the browser, which connects over WebSocket to a proxy -which translates the WebSocket connection into TCP to connect to normal Minecraft servers. Prismarine-web-client is based on: -* [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer) for the world rendering -* [mineflayer](https://github.com/PrismarineJS/mineflayer) for the high-level Minecraft client API - -Check these modules if you want to understand more how it works and contribute! - -## Screenshot -![Screenshot of prismarine-web-client in action](screenshot.png) - -## Live Demo -Click on this link to open it in your browser, no installation necessary: https://prismarinejs.github.io/prismarine-web-client/ - -*Tested on Chrome & Firefox for desktop platforms.* - -## Usage -To host it yourself, run these commands in bash: -```bash -$ npm install -g prismarine-web-client -$ prismarine-web-client -``` -Finally, open `http://localhost:8080` in your browser. - -## Features - -* Display mobs and players -* Display blocks -* Movement (you can move, and you see entities moving live) -* Place and break blocks - -## Roadmap -* Containers (inventory, chests, etc.) -* Sounds -* More world interactions (attacking entities, etc.) -* Cosmetic rendering features (day night cycle, fog, etc.) - -## Development - -If you're contributing/making changes, you need to install it differently. - -First, clone the repo. - -Then, set your working directory to that of the repo. For example: -```bash -$ cd ~/prismarine-web-client/ -``` - -Finally, run - -```bash -$ npm install -$ npm start -``` - -This will start express and webpack in development mode; whenever you save a file, the build will be redone (it takes 5s), -and you can refresh the page to get the new result. - -Connect to http://localhost:8080 in your browser. - -You may want to disable auto saving in your IDE to avoid constant rebuilding; see https://webpack.js.org/guides/development/#adjusting-your-text-editor. - -To check the production build (will take a minute to build), you can run `npm run build-start`. - -If you're interested in contributing, you can check projects at https://github.com/PrismarineJS/prismarine-web-client/projects. - -Some variables are exposed in the global ``window`` object for debugging: -* ``bot`` -* ``viewer`` -* ``mcData`` -* ``worldView`` -* ``Vec3`` -* ``pathfinder`` -* ``debugMenu`` - -### Adding stuff to the debugMenu - -debugMenu.customEntries['myKey'] = 'myValue' -delete debugMenu.customEntries['myKey'] - -### Some debugging examples - -In Chrome DevTools: - -* `bot.chat('test')` allows you to use the chat -* `bot.chat(JSON.stringify(Object.values(bot.players).map(({username, ping}) => ({username, ping}))))` display the ping of everyone -* `window.bot.entity.position.y += 5` jumps -* `bot.chat(JSON.stringify(bot.findBlock({matching:(block) => block.name==='diamond_ore', maxDistance:256}).position))` finds the position of a diamond block -* `bot.physics.stepHeight = 2` allows you to walk about blocks -* `bot.physics.sprintSpeed = 5` walks faster -* `bot.loadPlugin(pathfinder.pathfinder)` then `bot.pathfinder.goto(new pathfinder.goals.GoalXZ(100, 100))` goes to position 100, 100 - -For more debugging ideas, read the [mineflayer](https://github.com/PrismarineJS/mineflayer) doc. diff --git a/README_PT.md b/README_PT.md deleted file mode 100644 index 14375942..00000000 --- a/README_PT.md +++ /dev/null @@ -1,104 +0,0 @@ -# prismarine-web-client -[![NPM version](https://img.shields.io/npm/v/prismarine-web-client.svg)](http://npmjs.com/package/prismarine-web-client) -[![Build Status](https://github.com/PrismarineJS/prismarine-web-client/workflows/CI/badge.svg)](https://github.com/PrismarineJS/prismarine-web-client/actions?query=workflow%3A%22CI%22) -[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/GsEFRM8) -[![Try it on gitpod](https://img.shields.io/badge/try-on%20gitpod-brightgreen.svg)](https://gitpod.io/#https://github.com/PrismarineJS/prismarine-web-client) - -| 🇺🇸 [English](README.md) | 🇷🇺 [Russian](README_RU.md) | 🇵🇹 [Portuguese](README_PT.md) | -| ----------------------- | -------------------------- | ---------------------------- | - -Um cliente de Minecraft a funcionar numa página web. **Demostração em https://prismarinejs.github.io/prismarine-web-client/** - -## Como funciona -prismarine-web-client executa mineflayer e prismarine-viewer no teu navegador, que se conecta por WebSocket a uma proxy -que traduz o conexão do WebSocket em TCP para poderes conectar-te a servidores normais do Minecraft. Prismarine-web-client é basiado em: -* [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer) para renderizar o mundo -* [mineflayer](https://github.com/PrismarineJS/mineflayer) um API incrível do cliente de Minecraft - -Da uma olhada nestes módulos se quiseres entender mais sobre como isto funciona e poderes contribuir! - -## Captura de tela -![Captura de tela do prismarine-web-client em ação](screenshot.png) - -## Demostração ao vivo -Clica neste endereço para o abrires no navegador, sem instalação necessária: https://prismarinejs.github.io/prismarine-web-client/ - -*Testado no Chrome & Firefox para plataformas desktop.* - -## Uso -Para hospedá-lo por si próprio, execute estes comandos no bash: -```bash -$ npm install -g prismarine-web-client -$ prismarine-web-client -``` -Finalmente, abra `http://localhost:8080` no seu navigador. - -## Conteúdos - -* Mostra criaturas e os jogadores -* Mostra os blocos -* Movimento (podes mover-te, e também ver entidades a mover-se em tempo real) -* Colocar e destruir blocos - -## Planeamentos -* Containers (inventário, baús, etc.) -* Sons -* Mais interações no mundo (atacar entidades, etc.) -* Renderizar cosméticos (ciclo dia-noite, nevoeiro, etc.) - -## Desenvolvimentos - -Se estiveres a contribuir/fazer alterações, precisas intalá-lo de outra forma. - -Primeiro, clona o repositório. - -Depois, defina o seu diretório de trabalho para o do repositório. Por examplo: -```bash -$ cd ~/prismarine-web-client/ -``` - -Finalmente, execute - -```bash -$ npm install -$ npm start -``` - -Isto vai começar o express e webpack no modo de desenvolvimento; quando salvares um arquivo, o build vai ser executado de novo (demora 5s), -e podes atualizar a página para veres o novo resultado. - -Conecta em http://localhost:8080 no teu navegador. - -Poderás ter que desativar o auto salvar no teu IDE para evitar estar constantemente a reconstruir; see https://webpack.js.org/guides/development/#adjusting-your-text-editor. - -Para conferir a build de produção (vai demorar alguns minutos para terminar), podes executar `npm run build-start`. - -Se estiveres interessado em contribuir, podes dar uma vista de olhos nos projetos em https://github.com/PrismarineJS/prismarine-web-client/projects. - -Algumas variáveis estão expostas no objeto global ``window`` para depuração: -* ``bot`` -* ``viewer`` -* ``mcData`` -* ``worldView`` -* ``Vec3`` -* ``pathfinder`` -* ``debugMenu`` - -### Adicionar coisas no debugMenu - -debugMenu.customEntries['myKey'] = 'myValue' -delete debugMenu.customEntries['myKey'] - -### Alguns exemplos de depuração - -Na devtools do chrome: - -* `bot.chat('test')` permite usar o chat -* `bot.chat(JSON.stringify(Object.values(bot.players).map(({username, ping}) => ({username, ping}))))` display the ping of everyone -* `window.bot.entity.position.y += 5` saltar -* `bot.chat(JSON.stringify(bot.findBlock({matching:(block) => block.name==='diamond_ore', maxDistance:256}).position))` encontrar a posição de um bloco de diamante -* `bot.physics.stepHeight = 2` permite andar sobre os blocos -* `bot.physics.sprintSpeed = 5` andar mais rápido -* `bot.loadPlugin(pathfinder.pathfinder)` em seguida `bot.pathfinder.goto(new pathfinder.goals.GoalXZ(100, 100))` para ir para a posição 100, 100 - -Para mais ideas de depuração, leia o documento [mineflayer](https://github.com/PrismarineJS/mineflayer). diff --git a/README_RU.md b/README_RU.md deleted file mode 100644 index 40704df4..00000000 --- a/README_RU.md +++ /dev/null @@ -1,105 +0,0 @@ -# prismarine-web-client -[![NPM version](https://img.shields.io/npm/v/prismarine-web-client.svg)](http://npmjs.com/package/prismarine-web-client) -[![Build Status](https://github.com/PrismarineJS/prismarine-web-client/workflows/CI/badge.svg)](https://github.com/PrismarineJS/prismarine-web-client/actions?query=workflow%3A%22CI%22) -[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/GsEFRM8) -[![Try it on gitpod](https://img.shields.io/badge/try-on%20gitpod-brightgreen.svg)](https://gitpod.io/#https://github.com/PrismarineJS/prismarine-web-client) - -| 🇺🇸 [English](README.md) | 🇷🇺 [Russian](README_RU.md) | 🇵🇹 [Portuguese](README_PT.md) | -| ----------------------- | -------------------------- | ---------------------------- | - -Клиент Minecraft, запущенный на веб-странице. **Демонстрация на https://prismarinejs.github.io/prismarine-web-client/** - - -## Как это работает -prismarine-web-client запускает mineflayer и prismarine-viewer в вашем браузере, которые подключаются к прокси через WebSocket -который переводит соединение WebSocket в TCP для подключения к обычным серверам Minecraft. Prismarine-web-client основан на: -* [prismarine-viewer](https://github.com/PrismarineJS/prismarine-viewer) для рендера мира -* [mineflayer](https://github.com/PrismarineJS/mineflayer) для высокоуровневого API клиента minecraft - -Проверьте эти модули, если вы хотите больше понять, как это работает, и внести свой вклад! - -## Скриншот -![Screenshot of prismarine-web-client in action](screenshot.png) - -## Демонстация -Нажмите на эту ссылку, чтобы открыть ее в вашем браузере, установка не требуется: https://prismarinejs.github.io/prismarine-web-client/ - -*Протестировано в Chrome и Firefox для настольных платформ.* - -## Использование -Чтобы хостить его самостоятельно, выполните эти команды в bash: -```bash -$ npm install -g prismarine-web-client -$ prismarine-web-client -``` -Наконец, откройте `http://localhost:8080` в вашем браузере. - -## Функции - -* Показывание мобов и игроков -* Показывание блоков -* Передвижение (Вы можете двигаться, и вы можете видеть передвижение других сущностей) -* Установка и ломание блоков - -## Roadmap -* Контейнеры (Инвентарь, сундуки, и так далее.) -* Звуки -* Больше взаимодействий с Миром (Атаковать мобов и других игроков, и так далее.) -* Косметические особенности рендера (Цикл дня и ночи, fog, и так далее.) - -## Разработка - -Если вы ввносите изменения, вам нужно установить его по-другому. - -Во-первых, клонируйте репозиторий. - -Затем установите свой рабочий каталог в каталог репозитория. Например: -```bash -$ cd ~/prismarine-web-client/ -``` - -Наконец, запустите. - -```bash -$ npm install -$ npm start -``` - -Это запустит express и webpack в режиме разработки: всякий раз, когда вы сохраняете файл, сборка будет переделана (это займет 5 секунд), -и вы можете обновить страницу, чтобы получить новый результат. - -Для входа в Prismarine Web Client откройте http://localhost:8080 в вашем браузере. - -Если вы захотите отключить автоматическое сохранение в своем IDE, чтобы избежать постоянной пересборки Web Client'а, смотрите: https://webpack.js.org/guides/development/#adjusting-your-text-editor - -Чтобы проверить сборку Web Client'а (на сборку потребуется минута), вы можете запустить `npm run build-start` - -Если вы заинтересованы в участии, вы можете проверить проекты [тут](https://github.com/PrismarineJS/prismarine-web-client/projects) - -Некоторые переменные которые отображаются в окне для отладки: -* bot -* viewer -* mcData -* worldView -* Vec3 -* pathfinder -* debugMenu - -### Как добавить дополнительные элементы в меню отладки ? - -debugMenu.customEntries['myKey'] = 'myValue' -delete debugMenu.customEntries['myKey'] - -### Некоторые примеры отладки - -В инструментах chrome dev - -* `bot.chat('test')` позволяет вам использовать чат -* `bot.chat(JSON.stringify(Object.values(bot.players).map(({username, ping}) => ({username, ping}))))` показывает пинг всех игроков -* `window.bot.entity.position.y += 5` прыжок -* `bot.chat(JSON.stringify(bot.findBlock({matching:(block) => block.name==='diamond_ore', maxDistance:256}).position))` ищет позицию алмазной руды -* `bot.physics.stepHeight = 2` позволяет вам взбиратся по блокам -* `bot.physics.sprintSpeed = 5` более быстрый бег -* `bot.loadPlugin(pathfinder.pathfinder)` затем `bot.pathfinder.goto(new pathfinder.goals.GoalXZ(100, 100))` идет к координатам 100, 100 - -Для получения дополнительных идей по отладке прочитайте [mineflayer](https://github.com/PrismarineJS/mineflayer) документацию