Initial master branch structure.

This commit is contained in:
stfwi 2019-02-10 16:42:44 +01:00
parent f14ae91689
commit 9447dd06b8
4 changed files with 212 additions and 0 deletions

98
Makefile Normal file
View file

@ -0,0 +1,98 @@
# @file Makefile
# @author Stefan Wilhelm (wile)
# @license MIT
#
# GNU Make makefile for, well, speeding
# up the development a bit.
# You very likely need some tools installed
# to use all build targets, so this file is
# not "official". If you work on windows and
# install GIT with complete shell PATH (the
# red marked option in the GIT installer) you
# should have the needed unix tools available.
# For image stripping install imagemagick and
# also put the "magick" executable in the PATH.
#
MOD_JAR_PREFIX=engineersdecor-
MOD_JAR=$(filter-out %-sources.jar,$(wildcard build/libs/${MOD_JAR_PREFIX}*.jar))
ifeq ($(OS),Windows_NT)
GRADLE=gradlew.bat --no-daemon
GRADLE_STOP=gradlew.bat --stop
INSTALL_DIR=$(realpath ${APPDATA}/.minecraft)
SERVER_INSTALL_DIR=$(realpath ${APPDATA}/minecraft-server-forge-1.12.2-14.23.5.2768)
DJS=djs
else
GRADLE=./gradlew --no-daemon
GRADLE_STOP=./gradlew --stop
INSTALL_DIR=~/.minecraft
SERVER_INSTALL_DIR=~/.minecraft-server-forge-1.12.2-14.23.5.2768
DJS=djs
endif
wildcardr=$(foreach d,$(wildcard $1*),$(call wildcardr,$d/,$2) $(filter $(subst *,%,$2),$d))
#
# Targets
#
.PHONY: default mod init clean clean-all all run install sanatize dist-check dist start-server sync-main-repo
default: mod
all: clean clean-all mod | install
mod:
@echo "Building mod using gradle ..."
@$(GRADLE) build $(GRADLE_OPTS)
clean:
@echo "Cleaning ..."
@rm -f build/libs/*
@$(GRADLE) clean
clean-all: clean
@echo "Cleaning using gradle ..."
@rm -f dist/*
@$(GRADLE) clean cleanCache
init:
@echo "Initialising eclipse workspace using gradle ..."
@$(GRADLE) setupDecompWorkspace
run:
@echo "Running client ..."
@$(GRADLE) runClient
install: $(MOD_JAR) |
@sleep 2s
@if [ ! -d "$(INSTALL_DIR)" ]; then echo "Cannot find installation minecraft directory."; false; fi
@echo "Installing '$(MOD_JAR)' to '$(INSTALL_DIR)/mods' ..."
@[ -d "$(INSTALL_DIR)/mods" ] || mkdir "$(INSTALL_DIR)/mods"
@rm -f "$(INSTALL_DIR)/mods/${MOD_JAR_PREFIX}"*.jar
@cp -f "$(MOD_JAR)" "$(INSTALL_DIR)/mods/"
@echo "Installing '$(MOD_JAR)' to '$(SERVER_INSTALL_DIR)/mods' ..."
@rm -f "$(SERVER_INSTALL_DIR)/mods/${MOD_JAR_PREFIX}"*.jar
@[ -d "$(SERVER_INSTALL_DIR)/mods" ] && cp -f "$(MOD_JAR)" "$(SERVER_INSTALL_DIR)/mods/"
start-server: install
@echo "Starting local dedicated server ..."
@cd "$(SERVER_INSTALL_DIR)" && java -jar forge-1.12.2-14.23.5.2768-universal.jar nogui
sanatize:
@echo "Running sanatising tasks ..."
@djs scripts/sanatize-trailing-whitespaces.js
@djs scripts/sanatize-tabs-to-spaces.js
@djs scripts/sanatize-sync-languages.js
@djs scripts/sanatize-version-check.js
@djs scripts/task-update-json.js
@git status -s
dist-check:
@echo "Running dist checks ..."
@djs scripts/sanatize-dist-check.js
dist: sanatize dist-check clean-all mod
@echo "Distribution files ..."
@mkdir -p dist
@cp build/libs/$(MOD_JAR_PREFIX)* dist/
@djs scripts/task-dist.js

Binary file not shown.

After

Width:  |  Height:  |  Size: 346 KiB

21
license Normal file
View file

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2018-2018 Stefan Wilhelm (wile)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

93
readme.md Normal file
View file

@ -0,0 +1,93 @@
## Engineer's Decor
A [Minecraft](https://minecraft.net) (Java Edition) mod based on
[`Forge`](http://www.minecraftforge.net/), adding cosmetic blocks
for the Engineer's factory, workshop, and home.
![](documentation/engineers-decor-v100a-summary.png)
----
### Details
The mod has its focus on non-functional, decorative blocks. If anyhow possible,
no tile entities or user interactions are used. Current feature set:
- *Clinker bricks*: Slightly darker and more colorful version of the vanilla brick
block. Eight position dependent texture variations are implemented to make the
wall look more "alive". Crafted 3x3 with a brick block in the centre and any
combination of bricks and nether bricks around (actually, anything where the
ore dictionary says it's a "brick ingot"). Higher explosion resistance than the
vanilla brick wall. Also available as stairs, crafted as usual. There is a
reverse recipe to get three clinker brick blocks back from four stairs.
- *Slag bricks*: Gray-brownish brick, also eight texture variations. Crafted 3x3
from slag in the centre and any kind of bricks ("brick ingot") around. Has a higher
explosion resistance than the vanilla brick wall. Also available as stairs, also
with reverse recipe.
- *Treated wood ladder*: Crafted 3x3 with the known ladder pattern, items are
treated wood sticks.
- *Metal rung ladder*: Industrial wall-fixed ladder with horizontal bent rods.
Crafted 3x3 with five iron or steel rods in a "U" pattern.
- *Staggered metal steps*: Industrial wall-fixed sparse ladder with steps in a
zip pattern. Crafted 3x3 with six iron or steel rods in a zip pattern.
- *Treated wood table*: Four leg table made out of treated wood. Crafted 3x3
with three treated wood slabs and four treated wood poles. Guess the pattern.
- *Treated wood pole*: Pole fragment that can be placed in all directions. It
does intentionally not connect to posts, fences, etc - just a straigt pole.
Can be used e.g. for structural support or wire relay post, where the height
of the IE wire posts does not match.
More to come slowly but steadily.
----
### Mod pack integration, forking, back ports, bug reports, testing
- Packs: If your mod pack ***is open source as well and has no installer***,
you don't need to ask and simply integrate this mod.
- Bug reports: Yes, please let me know. Drop a mail or better open an issue
for the repository.
- Pull requests: Happily accepted. Please make sure that use the ***develop
branch*** for pull requests. The master branch is for release versions only.
I might merge the pull request locally if I'm ahead of the github repository,
we will communicate this in the pull request thread then.
- The mod config has an "include testing features" option. Enabling this causes
blocks under development to be registered as well.
----
## Revision history
- v1.0.0-b1 [A] Initial structure.
[A] Added clinker bricks and clinker brick stairs.
[A] Added slag bricks and slag brick stairs.
[A] Added metal rung ladder.
[A] Added staggered metal steps ladder.
[A] Added treated wood ladder.
[A] Added treated wood pole.
[A] Added treated wood table.
### Community references
Mods covering similar features, or may fit well together with IE and the decorations of this mod:
- [Immersive Engineering](https://github.com/BluSunrize/ImmersiveEngineering/): Without IE, my
little mod here does not make much sense ;). It works without IE, but quite a few blocks are
not craftable.
- [Engineer's doors](https://www.curseforge.com/minecraft/mc-mods/engineers-doors) has brilliant
doors, trapdoors, and fence doors, all made of the IE materials.
- [Dirty Bricks](https://www.curseforge.com/minecraft/texture-packs/dirty-bricks-vanilla-add-on) applies
position dependent variations to the vanilla bricks, similar to the clinkers and slag bricks in this
mod.
- [Chisel](https://www.curseforge.com/minecraft/mc-mods/chisel) needless to say, Chisel has a variety
of factory blocks.