Skip to content

Commit deed983

Browse files
Samarium150Samarium150
committed
feat: initialize the fabric version
0 parents  commit deed983

97 files changed

Lines changed: 1312 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.editorconfig‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = crlf
6+
indent_size = 4
7+
indent_style = space
8+
insert_final_newline = true
9+
max_line_length = 120
10+
tab_width = 4
11+
12+
[*.json]
13+
indent_size = 2

‎.gitattributes‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Disable autocrlf on generated files, they always generate with LF
2+
# Add any extra files or paths here to make git stop saying they
3+
# are changed when only line endings change.
4+
src/generated/**/.cache/cache text eol=lf
5+
src/generated/**/*.json text eol=lf

‎.github/workflows/Gradle CI.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Gradle CI
2+
3+
# Controls when the action will run.
4+
on: [push, pull_request, workflow_dispatch]
5+
6+
jobs:
7+
8+
build:
9+
10+
name: Gradle-Build
11+
12+
# The type of runner that the job will run on
13+
runs-on: ubuntu-latest
14+
15+
# Steps represent a sequence of tasks that will be executed as part of the job
16+
steps:
17+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
18+
- name: Checkout
19+
uses: actions/checkout@v2
20+
21+
# Setup JDK
22+
- name: Setup Java JDK
23+
uses: actions/setup-java@v2
24+
with:
25+
distribution: 'temurin'
26+
java-version: 8
27+
28+
# Validate Gradle Wrapper
29+
- name: Gradle Wrapper Validation
30+
uses: gradle/wrapper-validation-action@v1.0.4
31+
32+
# Build
33+
- name: Make gradlew executable
34+
run: chmod +x ./gradlew
35+
- name: Build with Gradle
36+
run: ./gradlew build

‎.gitignore‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# gradle
2+
3+
.gradle/
4+
build/
5+
out/
6+
classes/
7+
8+
# eclipse
9+
10+
*.launch
11+
12+
# idea
13+
14+
.idea/
15+
*.iml
16+
*.ipr
17+
*.iws
18+
19+
# vscode
20+
21+
.settings/
22+
.vscode/
23+
bin/
24+
.classpath
25+
.project
26+
27+
# macos
28+
29+
*.DS_Store
30+
31+
# fabric
32+
33+
run/

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎LICENSE‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎README.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Structures' Compass
2+
3+
[![Forge](http://cf.way2muchnoise.eu/491151.svg)](https://www.curseforge.com/minecraft/mc-mods/structures-compass)
4+
[![Minecraft](http://cf.way2muchnoise.eu/versions/For%20MC_491151_all.svg)](https://minecraft.fandom.com/wiki/Java_Edition_1.16.5)
5+
[![GitHub](https://img.shields.io/github/license/Samarium150/StructuresCompass)](https://github.com/Samarium150/StructuresCompass/blob/master/LICENSE)
6+
[![Gradle CI](https://github.com/Samarium150/StructuresCompass/actions/workflows/Gradle%20CI.yml/badge.svg)](https://github.com/Samarium150/StructuresCompass/actions/workflows/Gradle%20CI.yml)
7+
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FSamarium150%2FStructuresCompass.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FSamarium150%2FStructuresCompass?ref=badge_shield)
8+
9+
[简体中文](docs/README-zh.md)
10+
11+
Structures' Compass a Minecraft Forge mod allows player to quickly locate a specific [structure](https://minecraft.fandom.com/wiki/Generated_structures).
12+
13+
This mod is inspired by [Nature's Compass](https://github.com/MattCzyr/NaturesCompass), and part of our code is from their mod.
14+
15+
<div align="center">
16+
<p>
17+
<sub>Need a server to play with friends? Don't know how to set up one? Just rent already configured server!</sub>
18+
</p>
19+
<a href="https://www.bisecthosting.com/FishToucher" target="_blank">
20+
<img src="docs/images/BisectHostingBanner.png" alt="Banner" width="50%">
21+
</a>
22+
<p>
23+
<sub>Click on the picture above, select plan, use our code <strong>FishToucher</strong> to get 25% off your first month and enjoy playing with your friends!</sub>
24+
</p>
25+
</div>
26+
27+
## Features
28+
- Sneak + right click with the Structures' Compass in hand to open the searching GUI.
29+
- search structure's name directly
30+
- search structure's source by starting with '@'
31+
- search structure's available dimensions by starting with '#'
32+
- Right click to search the selected structure again.
33+
- When the compass is not pointing at a structure, or the structure is in another dimension,
34+
it will point at random position, just like the normal compass in the Nether or the End.
35+
- The compass supports all registered structures (vanilla and modded).
36+
37+
## Images
38+
39+
![GUI](docs/images/GUI.png)
40+
The GUI for searing structures
41+
42+
![HUD](docs/images/HUD.png)
43+
The HUD for displaying the information of a found structure
44+
45+
46+
## Recipe
47+
48+
![Recipe](docs/images/Recipe.png)
49+
50+
4 of any dead coral at 4 corners, 4 of mossy stone bricks at 4 edges and 1 compass at the center
51+
52+
We think the compass is too op, so we increase the crafting difficulty to balance it.
53+
54+
~~**v1.1.0**: Now you can change the config to use iron bars instead of dead corals~~
55+
(deprecated in **v1.2.0** because of bug [#8](https://github.com/Samarium150/StructuresCompass/issues/8))
56+
57+
## Further Development
58+
59+
We're too busy to develop, so we just list some possibilities
60+
- [ ] Port to another version like 1.12.2
61+
- [ ] Port to Fabric
62+
63+
## Contribute
64+
65+
Structures and dimensions don't have localized names by default.
66+
If you see something like `structure.<modid>.<name>` in the GUI or HUD, that essentially means there is not localized name for it.
67+
If you would like to add translations,
68+
create corresponding JSON files under [`resources/assets/<modid>/lang/`](/src/main/resources/assets) and send Pull Requests to us.
69+
We've put `zh_cn` translations of structures and dimensions in vanilla Minecraft there as a template,
70+
and your translations should also follow the same style.
71+
```json
72+
{
73+
"dimension.minecraft.overworld": "Overworld",
74+
"structure.minecraft.bastion_remnant": "Bastion Remnant"
75+
}
76+
```
77+
78+
## License
79+
80+
As stated in the introduction, part of our code is from [Nature's Compass](https://github.com/MattCzyr/NaturesCompass),
81+
which is under [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0)
82+
and we've annotated it in the doc string.
83+
Because CC BY-NC-SA 4.0 is not a software license, we choose [GNU General Public License 3.0](https://www.gnu.org/licenses/gpl-3.0.html)
84+
for other parts of the code to discourage commercial usage.
85+
86+
87+
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FSamarium150%2FStructuresCompass.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FSamarium150%2FStructuresCompass?ref=badge_large)

0 commit comments

Comments
 (0)