Skip to content

ElectricBlocks/electricblocks

Repository files navigation

Electric Blocks

Electric Blocks is a Minecraft mod that simulates realistic power transmission.

Build Contributors Forks Stargazers Issues License

Table of Contents

About The Project

For all installation and usage information and other documentation, visit our website.

The Electric Blocks mod brings accurate power flow simulation to Minecraft! Rather than using our own power flow implementation, Electric Blocks uses the heavily tested and validated PandaPower API. This means that the results of power flows are very accurate and can be used for real world modeling and testing of power flow.

Built With

Installation

To use this mod, you must have Forge version 1.15.2 and the HWYLA mod installed. For single player, the power flow simulation server EBPP must be installed and running on your computer. For multiplayer, only the computer running the Forge server needs to have EBPP installed. As well, because Electric Blocks still uses Minecraft 1.15.2, if you're hosting a multiplayer server, it is vulnerable to the extremely dangerous Log4j exploit. More about that and how to fix it here.

Prebuilt JAR

First make sure you have MC Forge installed. If you want to play single player or host a multiplayer server then you will need to have EBPP installed and running as well. Then go to our releases page and download the latest release: https://github.com/ElectricBlocks/electricblocks/releases/

Move the JAR file into your mods folder and start up MC Forge.

Building from Source

To build from sources, you will need:

  • Java 8 JDK
  • Gradle (included with source)

Once you have the prerequisites installed, run the following commands:

git clone https://github.com/ElectricBlocks/electricblocks.git
cd electricblocks
gradlew jar

We recommend using the included gradle wrapper. We are using version 4.10.3. Newer versions of gradle may cause this build to fail.

This may take a while. Once built, the JAR should be located in ./build/reobfJar/output.jar.

Copy this JAR file into your mods folder and start MC Forge.

If compiling with an IDE, we recommend IntelliJ. If you encounter errors during compilation, you may need to add the HWYLA sources jar as a library.

Usage

For usage info, check out our website.

Contributing

See CONTRIBUTING.md.

License

Distributed under the GNU Affero General Public License. See LICENSE.md for more information.

Acknowledgements

This software has been developed by the following students at the University of Idaho for the 2020-21 and 2021-22 Senior Capstone Design courses: