Skip to content

Commit 2143690

Browse files
committed
Update README with better attribution and to conform with the terms of the MIT license
1 parent 4a1f854 commit 2143690

File tree

2 files changed

+40
-18
lines changed

2 files changed

+40
-18
lines changed

LICENSE.BE

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Substantial portions of this mod--including most of its assets--were adapted from the
2+
BetterEnd and BCLib projects under the following license:
3+
4+
MIT License
5+
6+
Copyright (c) 2020 paulevsGitch
7+
8+
Permission is hereby granted, free of charge, to any person obtaining a copy
9+
of this software and associated documentation files (the "Software"), to deal
10+
in the Software without restriction, including without limitation the rights
11+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12+
copies of the Software, and to permit persons to whom the Software is
13+
furnished to do so, subject to the following conditions:
14+
15+
The above copyright notice and this permission notice shall be included in all
16+
copies or substantial portions of the Software.

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,14 @@ ethos—that of a brighter dimension, teeming with life—to future versions of
2626

2727
## Roadmap
2828

29-
Subject, of course, to change
30-
31-
- [x] **Proof of Concept**: Re-implement a select few BetterEnd blocks—at least one each of stone,
32-
soil, plant and crop—but no biomes or worldgen.
33-
- [x] **Alpha 2**: First "features"—at least two trees, plus either a ruin or a lake—that can be
34-
`/place`d into a world, along with their associated blocks (read: wood sets) and at least one mob
35-
- [x] **Alpha 3**: An armored elytra (see below)
36-
- [x] **Alpha 4** Bring back the music discs and modify the vanilla loot tables to provide them
37-
- [x] **First Beta**: Introduce the first biomes and a start modifying the worldgen so stuff
38-
naturally spawns
39-
- [ ] **First Release**: A full mod experience where a player can start in The End and "beat the
40-
game" from The End
29+
The intent of this mod is **not** to be a 1-to-1 recreation of BetterEnd, and while no biomes
30+
are explicitly being excluded, porting them is subject to interest (the developers' and the
31+
community's). You can find a list of features slated for development, tied to the
32+
["milestone"](https://github.com/OpenBagTwo/LighterEnd/milestones) (release) they're targeted for,
33+
on the [issues page](https://github.com/OpenBagTwo/LighterEnd/issues).
34+
35+
If there's a specific biome of BetterEnd feature you'd like to see prioritized, feel free to open
36+
an issue requesting it, after first having read through the following sections:
4137

4238
### Out of Scope
4339

@@ -46,15 +42,14 @@ The completed version of LighterEnd:
4642
- Will likely feature ore, but not Thallasium or Ender Ore (and thus, there will be no Terminite
4743
nor Aeternium)—these material types are either redundant or overpowered.
4844
- Will not include Crystalite armor. Which, again, is overpowered.
49-
- While there _will_ be an armored elytra, it will be heavily nerfed (with the glide decay of
45+
- While the mod features an armored elytra, it is heavily nerfed (with the glide decay of
5046
Aeternium elytra and sub-Diamond levels of protection) in order to balance it with vanilla
5147
elytra
5248
- Will only feature one type of end soil, though this soil may take on different appearances in
5349
different biomes, and bonemealing the soil in different biomes will produce different plants
5450
- Will not include Eternal Portals
5551
- Will not implement hammers, forging, infusing or alloying
56-
- Will make the End Veil enchantment available exclusively as _extremely rare_ loot (cannot be
57-
obtained from villagers or the enchantment table)
52+
- Will feature the End Veil effect, but solely as a potion effect, not as an enchantment
5853

5954
### New Features
6055

@@ -67,9 +62,10 @@ On the flip side, LighterEnd has or will have features not present in BetterEnd
6762
- [x] Sniffers that sploot on End Moss will dig up rare End saplings
6863
- [x] Obelisks that you can teleport to upon almost dying (meaning your stuff is safe even if you
6964
fall into The Void)
65+
- [x] Ice stars will be more common and will contain ice enriched with metals (copper, gold, iron)
7066
- [ ] New trim materials (and possibly trim patterns)
7167

72-
### Broad Compatibility
68+
## Broad Compatibility
7369

7470
LighterEnd is compatible out-of-the-box with
7571
both [Nullscape](https://modrinth.com/datapack/nullscape)
@@ -123,9 +119,17 @@ If there is a BetterEnd feature you would like to take responsibility for portin
123119
All code in this repository is licensed under
124120
[GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).
125121

126-
All assets (textures, models) were created by the BetterX team.
122+
Substantial portions of this mod—including most of its assets—were adapted from BetterEnd and BCLib,
123+
developed primarily by
124+
[**Paulevs**](https://github.com/paulevsGitch) and [**quiqueck**](https://github.com/quiqueck),
125+
in accordance with the terms of their respective licenses:
126+
127+
- https://github.com/quiqueck/BCLib/blob/9607e2e50818c9059505c32c72eb2d8d00bf6e9d/LICENSE
128+
- https://github.com/quiqueck/BetterEnd/blob/00e4892827c4f1b0d2e213348f63e57a647a8011/LICENSE
129+
130+
The Chorus Crab was designed by **Pegnok** of the BetterX Discord.
127131

128-
Music discs were composed, performed and recorded by Firel.
132+
Music discs were composed, performed and recorded by [Firel](https://www.youtube.com/@FirelMusic).
129133

130134
Many thanks:
131135

@@ -139,6 +143,8 @@ Many thanks:
139143
examples of library-free worldgen and terrain modification
140144
- to [Vanilla Tweaks](https://vanillatweaks.net/picker/resource-packs/) for the concept of grooved
141145
levers
146+
- to the [BetterX Discord](https://discord.gg/kYuATbYbKW) for their feedback in shaping this mod's
147+
development
142148

143149
You **may** use, modify and redistribute this mod, and you **may** include this mod within your
144150
modpack or run it on a server, so long as you abide by the terms of

0 commit comments

Comments
 (0)