https://github.com/aecsocket/demeter
Platform-agnostic weather and season effects
https://github.com/aecsocket/demeter
kotlin minecraft
Last synced: about 1 year ago
JSON representation
Platform-agnostic weather and season effects
- Host: GitHub
- URL: https://github.com/aecsocket/demeter
- Owner: aecsocket
- License: agpl-3.0
- Created: 2022-01-25T20:17:35.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-27T21:58:08.000Z (about 4 years ago)
- Last Synced: 2025-01-05T11:43:56.302Z (about 1 year ago)
- Topics: kotlin, minecraft
- Language: Java
- Homepage: https://gitlab.com/phosphorous/demeter
- Size: 2.54 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
`1.1.0-SNAPSHOT`:
[](https://github.com/aecsocket/demeter/actions/workflows/build.yml)
Provides several features which imitate real-life natural effects,
such as seasons, weather types, and temperature.
# Features
- [x] Time dilation for day/night, influenced by season
- [x] Fully configurable seasons, able to change foliage colour
- [ ] Dynamic climate, determining temperature/humidity at positions in the world
- [ ] Crop fertility based on climate
- [ ] Expanded weather effects like rain, snowstorms, sandstorms
- [x] ...and everything is able to be exposed in a display e.g. boss/action bar
- [x] All licensed under GNU GPL v3
Possibly:
* PAPI support?
# Usage
## Downloads
## Dependencies
Paper
* [Java >=17](https://adoptium.net/)
* [Paper >=1.18.1](https://papermc.io/)
* [Minecommons >=1.4.0](https://github.com/aecsocket/minecommons)
* [ProtocolLib >=4.7.0](https://www.spigotmc.org/resources/protocollib.1997/)
### [Stable Releases](https://github.com/aecsocket/demeter/releases)
### [Latest Snapshots](https://github.com/aecsocket/demeter/actions/workflows/build.yml)
## Packages
Using any package from the GitHub Packages registry requires you to
authorize with GitHub Packages.
To create a token:
1. Visit https://github.com/settings/tokens/new
2. Create a token with only the `read:packages` scope
3. Save that token as an environment variable and use that in builds
**Note: Never include your token directly in your build scripts!**
Always use an environment variable (or similar).
Maven
### [How to authorize](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)
#### In `~/.m2/settings.xml`
```xml
github-demeter
[username]
[token]
```
#### In `pom.xml`
Repository
```xml
github-demeter
https://maven.pkg.github.com/aecsocket/demeter
true
```
Dependency
```xml
com.github.aecsocket
demeter-[module]
[version]
```
Gradle
The Kotlin DSL is used here.
### [How to authorize](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry)
When building, make sure the `GPR_USERNAME` and `GPR_TOKEN` environment variables are set.
Repository
```kotlin
repositories {
maven {
url = uri("https://maven.pkg.github.com/aecsocket/demeter")
credentials {
username = System.getenv("GPR_USERNAME")
password = System.getenv("GPR_TOKEN")
}
}
}
```
Dependency
```kotlin
dependencies {
compileOnly("com.github.aecsocket", "demeter-[module]", "[version]")
}
```
# Documentation
### [Javadoc](https://aecsocket.github.io/demeter/docs)
### [Wiki](https://github.com/aecsocket/demeter/wiki)