Improve the README, compress the icon
This commit is contained in:
parent
ff51eb8abc
commit
2d47d8607e
40
README.md
Normal file
40
README.md
Normal file
@ -0,0 +1,40 @@
|
||||
<div align="center">
|
||||
|
||||
<img src="src/main/resources/assets/smooth-chunks/icon.png" width="100">
|
||||
|
||||
# Smooth Chunks
|
||||
|
||||
[](https://fabricmc.net)
|
||||

|
||||
|
||||
An enhanecd fork of [cadenkriese's mod](https://github.com/cadenkriese/smooth-chunks) for the latest versions of the game, with a completely different code base.
|
||||
|
||||
</div>
|
||||
|
||||
## What is this?
|
||||
|
||||
Smooth Chunks is a Fabric mod that adds animations of currently loading chunks. This makes chunk loading generally seem much more pleasant than them appearing out of thin air. There are multiple built-in animations and ease types, and if this isnt't enough, there's an API which will allow you to add your own animations and eases (with ease :trollface:)
|
||||
|
||||
Generally, this is what you'd call an "eye-candy" mod.
|
||||
|
||||
### Currently supported animations:
|
||||
|
||||
- Rise
|
||||
- Fall
|
||||
- Scale
|
||||
|
||||
### Currently supported interpolation types:
|
||||
|
||||
- Linear
|
||||
- Sine
|
||||
- Quadratic
|
||||
- Elastic
|
||||
|
||||
## Future plans
|
||||
|
||||
In the future, I plan to extend the scope of this mod to not only smoothen the chunk loading, but entity spawning/despawning/dying, liquid flowing, crops growing etc.
|
||||
|
||||
## License
|
||||
|
||||
This mod is under the [MIT License](LICENSE).
|
||||
|
27
readme.md
27
readme.md
@ -1,27 +0,0 @@
|
||||
# Smooth chunks
|
||||
|
||||
This is a fork of [flogic](https://github.com/cadenkriese/smooth-chunks)'s mod (although code bases have nothing in common)
|
||||
|
||||
## What is this?
|
||||
|
||||
This is a mod that adds animations of currently loading chunks. This makes chunk loading generally seem much more pleasant than them appearing out of thin air. There are multiple built-in animations and ease types, and if this isnt't enough, there's an API which will allow you to add your own animations and eases (with ease)
|
||||
|
||||
Generally, this is what you'd call an "eye-candy" mod.
|
||||
|
||||
## Currently supported animations:
|
||||
|
||||
- Rise
|
||||
- Fall
|
||||
- Scale
|
||||
|
||||
## Currently supported interpolation types:
|
||||
|
||||
- Linear
|
||||
- Sine
|
||||
- Quadratic
|
||||
- Elastic
|
||||
|
||||
## Future plans:
|
||||
|
||||
In the future, I plan to extend the scope of this mod to not only smoothen the chunk loading, but entity spawning / despawning / dying, liquid flowing, crops growing, etc.
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 4.9 KiB |
Loading…
Reference in New Issue
Block a user