Git Product home page Git Product logo

arducraft's Introduction

ArduCraft

ArduCraft is a Node.js and Electron-based software that enables the connection between Arduino and the Minecraft game. This application facilitates interaction between the physical world of Arduino and the virtual environment of Minecraft, opening up new possibilities for automation and hardware device integration into your gaming world.

The combined use of Minecraft command blocks and ArduCraft presents unique possibilities. Minecraft command blocks allow for the creation of complex mechanisms and automations within the game, while ArduCraft links these virtual elements to the physical world through Arduino. This integration enables the incorporation of real-world hardware devices into the game dynamics, opening new frontiers in automation, STEM learning, and the immersive experience of Minecraft.

Achieve Arduino-Minecraft integration effortlessly with ArduCraf no mods required. Unleash creativity and STEM learning in the vanilla game environment.

Screenshot 2023-11-26 224309

Key Features

  • Arduino-Minecraft Connection: ArduCraft streamlines communication between Arduino and Minecraft, allowing control over physical devices in the game.
  • Automation: Automate actions in Minecraft based on inputs from Arduino. For example, you can control doors, lights, or other elements in the game using physical sensors connected to Arduino.
  • STEM ArduCraft merges Arduino and Minecraft, fostering hands-on STEM learning. It integrates coding, electronics, and automation, making STEM concepts tangible. Students collaborate, solve problems, and explore real-world applications, enhancing coding proficiency in an engaging, gamified environment.

System Requirements

  • Node.js installed
  • Electron installed (npm install electron -g)
  • Minecraft version 1.19 or 1.20

Installation

Navigate to the folder where the downloaded arducraft.js file is located from this repository. The file is in the "Client" folder.

Example possible path:

$ user\downloads\Arducraft\Client
  1. Install dependencies:
npm install
  1. Force update:
npm update
  1. Install Electron:
npm install electron -g
  1. Install electron-packager (for compiling the executable application):
npm install electron-packager -g
  1. Resolve any vulnerabilities:
npm audit fix --force
  1. Start the Arducraft client:
electron arducraft
  1. Compile the Arducraft client (optional):
# Windows
electron-packager . --overwrite --asar=true --platform=win32 --arch=ia32 --prune=true --out=release-builds --version-string.CompanyName=FiloConnesso --version-string.FileDescription=CE --version-string.ProductName="Arducraft Client"

# macOS
electron-packager . --overwrite --platform=darwin --arch=x64 --prune=true --out=release-builds

# Linux
electron-packager . --overwrite --asar=true --platform=linux --arch=x64 --prune=true --out=release-builds

Startup

  1. Connect Arduino to your computer.
  2. Launch the Arduino IDE.
  3. Install "Arducraft" from the Library Manager.
  4. Open one of the examples available in the library, for example, "LedDemo."
  5. Upload the code to your Arduino.
  6. Start Minecraft version 1.19 or 1.20.
  7. Create a new world and open the LAN game, using the port suggested by the game or set a preferred port (e.g., 11111).
  8. Launch the Arducraft Client (as described above).
  9. Select the port where Arduino is connected.
  10. Specify the IP of the local server or your PC; if you want to access the same shared game from your computer, specify "localhost."
  11. Specify the port used for the shared game.
  12. Specify the server version (1.19 or 1.20).
  13. Give your bot a name (e.g., ArduCraft).
  14. The bot will log in to your game and display a welcome message in chat when it's ready.
  15. By typing the message "ledon" or "ledoff" in chat, the builtin LED of your Arduino should turn on and off according to the command!

Screenshot 2023-11-26 235640

Screenshot 2023-11-26 235653

Screenshot 2023-11-27 111202

Screenshot 2023-11-27 111550

Screenshot 2023-11-27 111533

Enjoy!

Contributions

We welcome contributions and improvements! If you have suggestions, bug reports, or want to contribute to development, fork the repository and submit a pull request.

License

This project is distributed under the MIT License.

This software bases its operation using mineflayer. Mineflayer


Note: Make sure to respect the licenses of Minecraft and Arduino when using this software.

arducraft's People

Contributors

mirkopac avatar filoconnesso avatar dependabot[bot] avatar alessandromrc avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.