67 lines
2.5 KiB
Markdown
67 lines
2.5 KiB
Markdown
|
|
# Overdrive That Matters
|
|
|
|
Minecraft tech-oriented mod with science fiction style, about matter, and energy, combined.
|
|
|
|
### Required mods
|
|
|
|
* [Kotlin for Forge](https://www.curseforge.com/minecraft/mc-mods/kotlin-for-forge) or have Kotlin standard library in classpath (at least 2.0.0 is required)
|
|
|
|
### Recommended mods
|
|
|
|
* [Ferrite Core](https://www.curseforge.com/minecraft/mc-mods/ferritecore), reduces memory usage
|
|
* In case of Overdrive That Matters, ***greatly*** reduces JVM heap bloat caused by model data being duplicated
|
|
* Better Random
|
|
|
|
### Mods with special compatibility code
|
|
|
|
* [JEI](https://www.curseforge.com/minecraft/mc-mods/jei)
|
|
* [Curios](https://www.curseforge.com/minecraft/mc-mods/curios)
|
|
* [Cosmetic Armor Reworked](https://www.curseforge.com/minecraft/mc-mods/cosmetic-armor-reworked)
|
|
|
|
----
|
|
|
|
### Building
|
|
|
|
Bash/Shell:
|
|
|
|
```bash
|
|
./gradlew runData
|
|
./gradlew build
|
|
```
|
|
|
|
Windows command prompt:
|
|
|
|
```cmd
|
|
gradlew runData
|
|
gradlew build
|
|
```
|
|
|
|
Building data is required before building the mod Jar because it is not commited
|
|
to avoid bloating git history with generated blobs.
|
|
|
|
----
|
|
|
|
## License
|
|
|
|
Unless otherwise stated in [NOTICE](NOTICE.md), assets in mod are licensed under **2-Clause BSD**
|
|
|
|
Copyright 2021-Present DBotThePony, GearShocky, YuRaNnNzZZ, Overdrive That Matters Contributors
|
|
|
|
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
|
|
|
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
|
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
|
|
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
|