Skip to content

Commit

Permalink
this is why docs are important
Browse files Browse the repository at this point in the history
  • Loading branch information
Yoghurt4C committed Nov 26, 2020
0 parents commit ca8de3c
Show file tree
Hide file tree
Showing 88 changed files with 7,462 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# gradle

.gradle/
build/
out/
classes/

# eclipse

*.launch

# idea

.idea/
*.iml
*.ipr
*.iws

# vscode

.settings/
.vscode/
bin/
.classpath
.project

# macos

*.DS_Store

# fabric

run/
trash/
15 changes: 15 additions & 0 deletions COPYING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004

Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>

Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. You just DO WHAT THE FUCK YOU WANT TO.

yog addendum 1: p.s.: warranty null when void
87 changes: 87 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
Minecraft Mod Public License Japanese Transration (MMPL_J)

Version 1.0.1


(A.序文)

一条 [MMPL_J]
 本ライセンスは、"Minecraft Mod Public License"(以下MMPL) (原文:http://tsoft-web.com/nokiyen/minecraft/modding/MMPL)の日本語訳及びその拡張であり、"Minecraft Mod Public License Japanese Transration"(以下MMPL_J)と呼称する。

二条 [構成と効力]
 MMPL_JはA.序文、B.翻訳からなる。MMPL_Jをライセンスとして使用する場合、特に表示のない限りA及びBの両方がライセンスとして効力を持つ。

三条 [Bの効力]
 B.翻訳は、MMPLの翻訳部分であり、MMPLと同等の意味内容を持つ。B.翻訳のいかなる翻訳間違えも無効となり、MMPLの該当部分が代わりに適用される。

四条 []
 B.翻訳はMMPL Version1.0.1の翻訳である。


(B.翻訳)

0. 定義
--------

Minecraft: Mojang ABがライセンスを持つMinecraftというゲームの複製を指す。

利用者: 以下のいずれかの方法で当該ソフトウェアに関わるすべての者。
- プレイする
- デコンパイルする
- リコンパイルまたコンパイルする
- 改変する
- 配布する

Mod: ゲーム拡張のためのコードであり、本ライセンスでは、ソース形式またはバイナリ形式の、それ単体で入手されるもの、より大きな配布の一部分、またはオリジナルのソースもしくは改変されたソースをコンパイルしたものを示す。

依存: 当該modが正しく機能するために必要とされるコード。これは、当該コードをコンパイルするのに必要な依存、及び当該modが機能するために明示的または暗黙に必要とされるすべてのファイルまたは改変を含む。


1. 範囲
--------

本ライセンスは当該modのすべての利用者に適用される。前提条件として、利用者は法的に正しく取得されたMinecraftの複製を所持していなければならない。


2. 責任
--------

当該modは、暗黙にせよそうでないにせよ、"現状のもの"が保証なしに提供される。当該modの権利所有者は当該modの利用により受けたいかなる損害に対しても責任を持たない。当該modはMinecraftというゲームの根本的な部分を変えるものであり、Minecraftの一部分が当該modが導入されたことにより機能しない場合がある。当該modの利用や誤用により引き起こされるすべての損害は、利用者が負うこととなる。


3. プレイする権利
--------

利用者は、制限なしに、当該modをクライアントまたはサーバに導入し、プレイすることができる。


4. 改変する権利
--------

利用者は、当該modのソースコードをデコンパイルする、デコンパイルされたまたはオリジナルのソースコードを見る、及びそれを改変する権利を持つ。


5. 引用する権利
--------

利用者は、当該modのコードを引用する、すなわち、当該modのクラスまたはインターフェースを継承またはインスタンス化する、当該modのオブジェクトを参照する、及び当該modの関数をコールする権利を持つ。こうしたコードは"引用"コードとして知られ、当該modと異なるライセンスの元で保障されうる。


6. オリジナルないし改変された著作権物の配布
--------

当該mod全体が、様々な形式において、配布に関する権利に従う。様々な形式とは以下を含む。
- オリジナルの、バイナリまたはソース形式の当該modファイル
- これらのバイナリまたはソースファイルを改変したもの、及びソースを改変することにより得られたバイナリ
- 当該modのソースまたはバイナリファイルへのパッチ
- 当該modのバイナリまたはソースファイルの一部の複製

利用者は、当該modの一部分または全体を再配布する、もしくは配布物に含めて再配布することができる。

バイナリファイルを配布する場合は、利用者は当該modのソースまたは改変したソース全体を入手する手段を無償で提供しなければならない。

当該modの配布物のライセンスは、すべてMMPLのままでなければならない。

当該modが他のModやクラスに持つ依存はすべて、現行版のMMPLに相当する条件のもとでライセンスが適用されなければならない。ただし、MinecraftのコードとModを読みこむフレームワーク(ModLoader、ModLoaderMP, Bukkitなど)についてはこの限りでない。

バイナリ及びソースを改変したもの、並びに当該modを複製して得られた部分を含むファイルは、本ライセンスの条項の元で配布されなければならない。
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Sips
A Minecraft Mod that adds small fluid containers you can drink from!
<br>
[**CF project**](<https://www.curseforge.com/minecraft/mc-mods/sips>) / [**Demo Website**](<https://yoghurt4c.github.io/Sips/index.html>)
<p align="center">
<a href="https://github.com/Yoghurt4C/Sips/blob/fabric-1.16/LICENSE.md"><img src="https://github.com/Yoghurt4C/Sips/blob/fabric-1.16/docs/sips/icon.png" alt="" width=250 height=250></a>
<br>
<a href="https://gist.github.com/poop-person/991e80f390384bbeef09d208bff208f4"><img alt="POOP badge" src="https://raw.githubusercontent.com/gist/poop-person/991e80f390384bbeef09d208bff208f4/raw/a9ef83add84a70f2202896c2d81117ff7b169be1/poop-badge.svg"></a>
</p>
105 changes: 105 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
plugins {
id 'fabric-loom' version '0.5-SNAPSHOT'
id 'maven-publish'
id 'org.jetbrains.gradle.plugin.idea-ext' version '0.7'
}

sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8

archivesBaseName = project.archives_base_name
version = project.mod_version+"+"+project.minecraft_version
group = project.maven_group

repositories {
mavenLocal()
maven { url = "https://jitpack.io" }
maven {
name = "BuildCraft"
url = "https://mod-buildcraft.com/maven"
}
maven { url = 'https://maven.dblsaiko.net' }

flatDir {
dirs "libs"
}
}

dependencies {
minecraft "com.mojang:minecraft:${project.minecraft_version}"
mappings "net.fabricmc:yarn:${project.yarn_mappings}:v2"
modImplementation "net.fabricmc:fabric-loader:${project.loader_version}"

implementation 'org.jetbrains:annotations:15.0'
compileOnly "com.google.code.findbugs:jsr305:3.0.2"

modImplementation "net.fabricmc.fabric-api:fabric-api:${project.fabric_version}"
modImplementation "io.github.prospector:modmenu:${project.mod_menu_version}"
modImplementation ("me.shedaniel:RoughlyEnoughItems:${project.rei_version}") { exclude(module: "ModMenu") }
modImplementation "alexiil.mc.lib:libblockattributes-all:${project.lba_version}"
modImplementation "alexiil.mc.mod:simplepipes-all:0.4.3"
modRuntime 'net.dblsaiko:winwonders:0.1.2-4'
}

processResources {
inputs.property "version", project.version

filesMatching("fabric.mod.json") {
expand "version": project.version
}
}

tasks.withType(JavaCompile).configureEach {
// ensure that the encoding is set to UTF-8, no matter what the system default is
// this fixes some edge cases with special characters not displaying correctly
// see http://yodaconditions.net/blog/fix-for-java-file-encoding-problems-with-gradle.html
// If Javadoc is generated, this must be specified in that task too.
it.options.encoding = "UTF-8"

// The Minecraft launcher currently installs Java 8 for users, so your mod probably wants to target Java 8 too
// JDK 9 introduced a new way of specifying this that will make sure no newer classes or methods are used.
// We'll use that if it's available, but otherwise we'll use the older option.
def targetVersion = 8
if (JavaVersion.current().isJava9Compatible()) {
it.options.release = targetVersion
}
}

java {
// Loom will automatically attach sourcesJar to a RemapSourcesJar task and to the "build" task
// if it is present.
// If you remove this line, sources will not be generated.
withSourcesJar()
}

jar {
from "LICENSE.md"
}

idea.project.settings {
delegateActions {
delegateBuildRunToGradle = false
testRunner = org.jetbrains.gradle.ext.ActionDelegationConfig.TestRunner.PLATFORM
}
}

// configure the maven publication
publishing {
publications {
mavenJava(MavenPublication) {
// add all the jars that should be included when publishing to maven
artifact(remapJar) {
builtBy remapJar
}
artifact(sourcesJar) {
builtBy remapSourcesJar
}
}
}

// Select the repositories you want to publish to
// To publish to maven local, no extra repositories are necessary. Just use the task `publishToMavenLocal`.
repositories {
// See https://docs.gradle.org/current/userguide/publishing_maven.html for information on how to set up publishing.
}
}
54 changes: 54 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Sips</title>
<link rel="icon" type="image/png" href="sips/sip.png">
<link rel="stylesheet" type="text/css" href="sips/sips.css">
</head>
<body>

<h1>Sips</h1>
<hr>
<br>
<strong>Yoghurt4C:</strong> This mod adds 2 items: Lil Sip and Big Chug, which are functionally identical, with the only difference being the amount of Fluid they can hold.<br><br>
<img src="sips/sips_1.png" alt="Creative Tab">
<br><br><br>

<strong>Yoghurt4C:</strong> Let's use a Lil Sip as an example. To fill it, grab it in your main hand and click on any fluid block.<br><br>
<img src="sips/sips_2.gif" alt="Filling from block">
<br><br><br>

<strong>Yoghurt4C:</strong> You can also empty and fill Sips to/from any Lib Block Attributes-compatible containers, such as Simple Pipes tanks.<br><br>
<img src="sips/sips_3.gif" alt="Filling from container">
<br><br><br>

<strong>Yoghurt4C:</strong> Once you have a fluid inside your Lil Sip, you can take a Sip from it! If your beverage of choice has a Sippable associated with it, you should receive a new effect!<br><br>
<img src="sips/sips_4.gif" alt="Taking Sips">
<br><br><br>

<strong>Yoghurt4C:</strong> Sips also adds some "new" fluids to the game, like Milk and Mushroom Stew. You can get them from their respective Cow, or shift click a Milk Bucket or a bowl of Mushroom Stew in the world, or on an LBA fluid container!<br>Of course, their default Sippables are virtually identical to those items.<br><br>
<video controls>
<source src="sips/sips_5.webm" type="video/webm">
Sorry, your browser doesn't support embedded videos. If it didm you could watch cows being milked rather passionately. But it doesn't. So you can't.
</video>
<br><br><br>

<strong>Yoghurt4C:</strong> You may be wondering: "What are Sippables? How do I add my own effects to a fluid?". Sippables are collections of various data applied to the player on each Sip, and they're also entirely data-driven! Define your own Sip effects for fluids in JSON!<br>Sips also has builtin compatibility for some modded fluids, from mods such as TechReborn, Astromine and Modern Industrialization!<br><br>
<img src="sips/sips_6.png" alt="JSON">
<br><br><br>

<strong>Yoghurt4C:</strong> Sips also has a config, which lets you change some of the things about the mod. For example, you can increase the maximum amount of Sips that Lil Sip and Big Chug can hold, or turn off "fancy" 3D Sip rendering for that classic look!<br>Or, if you're a modpack maker, you can prevent the default Sippables from loading!<br><br>
<img src="sips/sips_7.png" alt="Config">
<br><br><br>

<strong>Yoghurt4C:</strong> If you have REI installed, you will be able to view details about every drinkable fluid in the game in this beverage list designed to catch your attention! You will be gripped by the legally distinct complimentary slogans!<br>Yes, you can also fill Sips with potions! (Currently LBA-exclusive.)<br><br>
<img src="sips/sips_8.png" alt="REI">
<br><br><br>

<strong>Yoghurt4C:</strong> Seeing this image means you've reached the end of this small showcase. Good job. So, get merry and have a Sip!<br><br>
<img src="sips/sips_9.png" alt="Sendoff">
<hr>

</body>
</html>
Binary file added docs/sips/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/sips/sip.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions docs/sips/sips.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
img { height: auto; max-width: 90%; }

body { text-align: center; background-color: #36393E; color: #DCDDDE; }

.code { background-color: #2F3136; font: monospace; }

.spoiler { color: black; background-color: black; }

strong { color: white; }

.spoiler:hover { background-color: #36393E; color: #DCDDDE; }

hr { background: url(sipsborder.png); border: none; height: 32px; }
Binary file added docs/sips/sips_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/sips/sips_2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/sips/sips_3.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/sips/sips_4.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/sips/sips_5.webm
Binary file not shown.
Binary file added docs/sips/sips_6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/sips/sips_7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/sips/sips_8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/sips/sips_9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/sips/sipsborder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
org.gradle.jvmargs=-Xmx1G
minecraft_version=1.16.4
yarn_mappings=1.16.4+build.6
loader_version=0.10.6+build.214

mod_version = 0.6.0
maven_group = mod.codewarrior
archives_base_name = sips

fabric_version=0.25.1+build.416-1.16
mod_menu_version=1.14.9+build.13
rei_version=5.8.5
lba_version=0.8.4
Binary file added gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
5 changes: 5 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
Loading

0 comments on commit ca8de3c

Please sign in to comment.