An open API service indexing awesome lists of open source software.

https://github.com/antonilol/mc_arduino

Displays Minecraft time as human time on a seven segment display via an Arduino
https://github.com/antonilol/mc_arduino

7-segment-display arduino minecraft minecraft-fabric-mod minecraft-mod serial-communication serial-port

Last synced: 10 months ago
JSON representation

Displays Minecraft time as human time on a seven segment display via an Arduino

Awesome Lists containing this project

README

          

[![Build](https://github.com/antonilol/mc_arduino/actions/workflows/push.yml/badge.svg)](https://github.com/antonilol/mc_arduino/actions/workflows/push.yml)

# mc_arduino

## Install and use

This mod runs on [Fabric](https://fabricmc.net/), so make sure you have that installed.

Download the [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files) if you don't have it already. Put it in your mods folder.

Go to [Releases](https://github.com/antonilol/mc_arduino/releases) and download the latest release. Also put it in your mods folder.

The `mods` folder can be found in [.minecraft](https://minecraft.fandom.com/wiki/.minecraft#Locating_.minecraft).
If not, create it.

Start Minecraft and open a world or join a server.

Have an arduino connected (or connect in now) with the [program](https://github.com/antonilol/mc_arduino/blob/master/mc-arduino/mc-arduino.ino) loaded.

Type `/mc_arduino serial list` to list serial devices.

Type `/mc_arduino serial connect ` to connect and start the Minecraft clock on the displays.

Type `/mc_arduino serial disconnect` to stop it and make the serial port available again. (You can't upload any programs to an Arduino when the serial port is busy)

`/mc_arduino serial` is also available as `/serial`.

I will be adding a led strip to it later for the XP bar

## Compiling

#### Linux and Mac OS

Clone the repo

```bash
git clone https://github.com/antonilol/mc_arduino.git
```
or download the [zip](https://github.com/antonilol/mc_arduino/archive/refs/heads/master.zip) and unzip it.

Enter the folder (`cd` or double click).

If you downloaded the zip, make `gradlew` executable.

```bash
chmod +x gradlew
```

And finally, compile.

```bash
./gradlew build
```

#### Windows

Clone or download like mentioned above and build with

```bash
gradlew.bat build
```

## Developing

Clone the repo.

To get completions in your IDE (if applicable) run `./gradlew genSources` (unix) or `gradlew.bat genSources` (windows).

More on that [here](https://fabricmc.net/wiki/tutorial:setup#generating_sources).

## License

MIT