https://github.com/bufferhead-code/react-minecraft

react-minecraft allows you to create Minecraft builds using react.js components
https://github.com/bufferhead-code/react-minecraft

Last synced: 4 days ago
JSON representation

react-minecraft allows you to create Minecraft builds using react.js components

• Host: GitHub
• URL: https://github.com/bufferhead-code/react-minecraft
• Owner: bufferhead-code
• Created: 2023-11-14T16:05:26.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2023-11-15T17:07:57.000Z (8 months ago)
• Last Synced: 2024-04-24T11:15:42.306Z (2 months ago)
• Language: JavaScript
• Size: 47.9 KB
• Stars: 28
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Lists

• awesome-react-renderer - React-Minecraft - Create Minecraft builds using React.js components (Miscellaneous)

README

        
# React Minecraft

React Minecraft is a project that allows you to create Minecraft worlds using React components.

Just like React-DOM and React-Native, React Minecraft uses the React.js Framework and JSX to craft custom builds in Minecraft. With Minecraft Blocks.

**You can watch how i made it [here](http://www.youtube.com/watch?v=YaX5ZAEqXD8)**

[![Youtube Video about how this project was made](http://img.youtube.com/vi/YaX5ZAEqXD8/0.jpg)](http://www.youtube.com/watch?v=YaX5ZAEqXD8 "I built a Minecraft house using React.js")

An Example for the Top Layer Component for a Minecraft house could look like this:

```javascript

export default function House() {

    return (

        <>

            

                

                

                

                

                

                

                

            

        >

    )

}

```

## Run the project

To run the project type `npm run start`. 

This will start a local minecraft server on port 25565.

You can connect to this server using the Minecraft Java Edition via localhost:25565.

Currently only Minecraft Version **v1.16.1** is supported.  

## How to use

After logging in you can type `/reload` to reload the component.

## State of this project

This is a very early release of this project (you could call it a prototype), the API is still subject to change. 

Depending on the Feedback this project will be further developed to provide a stable API.

## Minecraft Block Index + Block States

For documentation of blocks and available states

https://minecraftitemids.com/

## Roadmap / Ideas: 

 * Add better component reloading (after file updates) without server restart

 * Add rotation and mirror possibility for blocks/sections

 * Probably make it faster, not really sure how well it performs on larger structures yet

 * Check if we can make events (f.e. button press) work

 * If events work, add reactivity

 * If reactivity works see if functions can work

## Contributing

If you are interested in contributing feel free to either contact me or open tickets for what you would like to contribute. 

Please don't open PRs for new features without prior discussion. Bugfixes and small changes are of course welcome without prior ticket.