Initial commit
This commit is contained in:
commit
51a51a6271
GPG key ID:
E366BAEF67E4704D
44 changed files with 3477 additions and 0 deletions
121
.forgejo/issue_template/bugreport.yml
Normal file
121
.forgejo/issue_template/bugreport.yml
Normal file
|
|
@ -0,0 +1,121 @@
|
||||||
|
name: "⚠️ Bug report"
|
||||||
|
about: "Report a bug in the port."
|
||||||
|
title: "bug: "
|
||||||
|
labels:
|
||||||
|
- "Bug/New"
|
||||||
|
body:
|
||||||
|
- type: "markdown"
|
||||||
|
id: "text-introduction"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Hey there! Thank you for taking the time to report a bug to us. \
|
||||||
|
This means a lot to us, as that's the only way to get better... and many people don't file bug reports. \
|
||||||
|
Anyway, please answer the following questions accurately, otherwise we may not be able to diagnose the issue. \
|
||||||
|
\
|
||||||
|
**Please check if the same bug report already exists. If so, participate in that one instead. If another issue is similar, make sure to mention the related issues.** \
|
||||||
|
**Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your bug report, we censor our answers.**
|
||||||
|
- type: "textarea"
|
||||||
|
id: "bug-description"
|
||||||
|
attributes:
|
||||||
|
label: "Bug description"
|
||||||
|
description: "Explain what the bug is about. Include as many details as possible."
|
||||||
|
placeholder: "My cat spontaneously explodes when I try to download from `https://yourdick.zip`."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "textarea"
|
||||||
|
id: "bug-log"
|
||||||
|
attributes:
|
||||||
|
label: "Bug log"
|
||||||
|
description: |
|
||||||
|
Please insert the ENTIRE log output here, so we can understand the problem at hand. \
|
||||||
|
You must give us `DIAGNOSTIC` level logs (pass `-Dsosengine.base.loggerLevel=diagnostic` to the JVM) with the default log template.
|
||||||
|
|
||||||
|
**This field can be left empty if the bug does not involve/require log output.**
|
||||||
|
placeholder: "Your log file here..."
|
||||||
|
value: |
|
||||||
|
```plain
|
||||||
|
Your log file here...
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "textarea"
|
||||||
|
id: "bug-snippet"
|
||||||
|
attributes:
|
||||||
|
label: "Bug snippet"
|
||||||
|
description: |
|
||||||
|
Please insert a snippet of the (mod/plugin and/or port) code which you think is causing the issue.
|
||||||
|
|
||||||
|
**This field can be left empty if you intend on supplying a reproduction project.**
|
||||||
|
value: |
|
||||||
|
```java
|
||||||
|
Your code snippet here...
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "textarea"
|
||||||
|
id: "bug-reproduce"
|
||||||
|
attributes:
|
||||||
|
label: "Bug reproduction guide"
|
||||||
|
description: |
|
||||||
|
Explain how we can reproduce this bug as easy as possible, step by step.
|
||||||
|
|
||||||
|
**This field can be left empty if the bug does not involve/require a reproduction guide.**
|
||||||
|
placeholder: |
|
||||||
|
1. Pass "-Dsosengine.base.optimizeLogging=false" to the JVM
|
||||||
|
2. Start server
|
||||||
|
2. Override logging implementation during plugin initialization
|
||||||
|
4. The nearest cat should explode in the next few seconds
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "input"
|
||||||
|
id: "bug-reproduce-project"
|
||||||
|
attributes:
|
||||||
|
label: "Bug reproduction project"
|
||||||
|
description: |
|
||||||
|
Drop a link to some repository or zip file of an example project showcasing the bug.
|
||||||
|
|
||||||
|
**Only supply a repro project if the bug is a bit more advanced, needs specific timing, etc..** \
|
||||||
|
**Also please make sure that the bug actually occurs in the example project!**"
|
||||||
|
placeholder: "https://your.reproduction.project/download/url/here"
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "input"
|
||||||
|
id: "port-version"
|
||||||
|
attributes:
|
||||||
|
label: "EngineMC version"
|
||||||
|
description: "Input the EngineMC version here."
|
||||||
|
placeholder: "Example: v1-alpha0"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "dropdown"
|
||||||
|
id: "minecraft-version"
|
||||||
|
attributes:
|
||||||
|
label: "Minecraft version"
|
||||||
|
description: "Which Minecraft version is does your plugin or mod target?"
|
||||||
|
options:
|
||||||
|
- "1.20.1"
|
||||||
|
- "1.21.0 and below"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "dropdown"
|
||||||
|
id: "minecraft-loader"
|
||||||
|
attributes:
|
||||||
|
label: "Server software"
|
||||||
|
description: "Which server software are you using?"
|
||||||
|
options:
|
||||||
|
- "SpigotMC"
|
||||||
|
- "PaperMC"
|
||||||
|
- "PaperMC derivative (name it)"
|
||||||
|
- "Fabric"
|
||||||
|
- "NeoForge"
|
||||||
|
- "Forge"
|
||||||
|
- "Hybrid servers (e.g. Magma, Mohist) (name it)"
|
||||||
|
- "Other (name it)"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "markdown"
|
||||||
|
id: "text-tysm"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thank you for filling out this bug report.
|
||||||
|
Please check your answers for *mistaeks* or sensitive information before sending this report.
|
||||||
5
.forgejo/issue_template/config.yml
Normal file
5
.forgejo/issue_template/config.yml
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: "📚 Documentation"
|
||||||
|
about: "Visit the documentation. Maybe you just skipped something important or just haven't found the page you're looking for yet."
|
||||||
|
url: "https://engine.staropensource.de"
|
||||||
20
.forgejo/issue_template/empty.yml
Normal file
20
.forgejo/issue_template/empty.yml
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
name: "👾 Empty"
|
||||||
|
about: "A clean slate. Only use this one for specific, special cases."
|
||||||
|
title: "empty: "
|
||||||
|
labels:
|
||||||
|
- "Empty"
|
||||||
|
body:
|
||||||
|
- type: "markdown"
|
||||||
|
id: "introduction"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
This issue template is meant for specific, special cases, where an empty issue template may be wanted.
|
||||||
|
You should *NOT* use this template to write bug reports, feature or help requests.
|
||||||
|
This issue template should ideally only be used by the repository maintainer.
|
||||||
|
- type: "textarea"
|
||||||
|
id: "content"
|
||||||
|
attributes:
|
||||||
|
label: "Issue content"
|
||||||
|
description: "Write your issue content here."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
59
.forgejo/issue_template/featurerequest.yml
Normal file
59
.forgejo/issue_template/featurerequest.yml
Normal file
|
|
@ -0,0 +1,59 @@
|
||||||
|
name: "✨ Feature Request"
|
||||||
|
about: "Request a feature to be implemented in the port."
|
||||||
|
title: "feat: "
|
||||||
|
labels:
|
||||||
|
- "FeatureRequest/New"
|
||||||
|
body:
|
||||||
|
- type: "markdown"
|
||||||
|
id: "text-introduction"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Hey there! Thank you for taking the time to request a feature to us. \
|
||||||
|
Before filling any of this out, please think for one minute if the feature is really important and necessary enough to implement in the port. If you're unsure, continue. \
|
||||||
|
Please answer the following questions accurately, or we may not be able to implement the feature as you requested it. \
|
||||||
|
\
|
||||||
|
**Please check if the same feature request already exists. If so, participate in that one instead. If another issue is similar, make sure to mention the related issues.** \
|
||||||
|
**Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your bug report, we censor our answers.** \
|
||||||
|
**Submitting a feature request will *not* gurantee it's inclusion into the port. By submitting a feature request, you are at the grace of the community to pick up your suggestion.**
|
||||||
|
- type: "textarea"
|
||||||
|
id: "feature-description"
|
||||||
|
attributes:
|
||||||
|
label: "Feature description"
|
||||||
|
description: "Explain *what* you want added. Include as many details as possible."
|
||||||
|
placeholder: |
|
||||||
|
Example:
|
||||||
|
I want to do X in my project, which would simplify doing Y.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "textarea"
|
||||||
|
id: "feature-implementation"
|
||||||
|
attributes:
|
||||||
|
label: "Feature implementation"
|
||||||
|
description: |
|
||||||
|
Explain *how* you want it added. Include as many details as possible.
|
||||||
|
Also explore alternative ways of implementing the feature in EngineMC (if possible).
|
||||||
|
placeholder: |
|
||||||
|
Example:
|
||||||
|
I would propose to <some description on how to implement your feature>.
|
||||||
|
I've also thought on simply <some other description on how to implement your feature>.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "textarea"
|
||||||
|
id: "feature-alternatives"
|
||||||
|
attributes:
|
||||||
|
label: "Feature alternatives"
|
||||||
|
description: |
|
||||||
|
Explain how to implement the feature without building it into the port directly. Include as many details as possible.
|
||||||
|
placeholder: |
|
||||||
|
Example:
|
||||||
|
I've considered writing a plugin just for this purpose.
|
||||||
|
Otherwise it would be possible to use <link to some project> with some configuration.
|
||||||
|
I've also considered using the normal way of doing it by <how to do it using the normal way>.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "markdown"
|
||||||
|
id: "text-tysm"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thank you for filling out this feature request form.
|
||||||
|
Please check your answers for *mistaeks* before sending this report.
|
||||||
93
.forgejo/issue_template/helprequest.yml
Normal file
93
.forgejo/issue_template/helprequest.yml
Normal file
|
|
@ -0,0 +1,93 @@
|
||||||
|
name: "💬 Help"
|
||||||
|
about: "Request help."
|
||||||
|
title: "help: "
|
||||||
|
labels:
|
||||||
|
- "Help/Wanted"
|
||||||
|
body:
|
||||||
|
- type: "markdown"
|
||||||
|
id: "text-introduction"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Hey there! Seems like you have some kind of issue with the StarOpenSource EngineMC. \
|
||||||
|
Please answer the following questions accurately, otherwise we may not be able to help you. \
|
||||||
|
\
|
||||||
|
**Please check if the same help request already exists. If so, participate in that one instead. If another issue is similar, make sure to mention the related issues.** \
|
||||||
|
**Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your stuff, we censor our answers.**
|
||||||
|
- type: "textarea"
|
||||||
|
id: "help-description"
|
||||||
|
attributes:
|
||||||
|
label: "Problem description"
|
||||||
|
description: "Explain what your problem is as detailed as possible."
|
||||||
|
placeholder: "How can I create a custom LoggerImplementation implementation?"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "textarea"
|
||||||
|
id: "help-log"
|
||||||
|
attributes:
|
||||||
|
label: "Log"
|
||||||
|
description: |
|
||||||
|
Please insert the ENTIRE log output here, so we can understand the problem at hand. \
|
||||||
|
You must give us `DIAGNOSTIC` level logs (pass `-Dsosengine.base.loggerLevel=diagnostic` to the JVM) with the default log template.
|
||||||
|
|
||||||
|
*This field can be left empty if the problem you are faciing does not involve/require log output.**
|
||||||
|
placeholder: "Your log file here..."
|
||||||
|
value: |
|
||||||
|
```plain
|
||||||
|
Your log file here...
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "textarea"
|
||||||
|
id: "help-snippet"
|
||||||
|
attributes:
|
||||||
|
label: "Code snippet"
|
||||||
|
description: |
|
||||||
|
Please insert a snippet of the application code which you think is causing the issue.
|
||||||
|
|
||||||
|
**This field can be left empty if the problem you are faciing does not involve/require code.**
|
||||||
|
value: |
|
||||||
|
```java
|
||||||
|
Your code snippet here...
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: "input"
|
||||||
|
id: "port-version"
|
||||||
|
attributes:
|
||||||
|
label: "EngineMC version"
|
||||||
|
description: "Input the EngineMC version here."
|
||||||
|
placeholder: "Example: v1-alpha0"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "dropdown"
|
||||||
|
id: "minecraft-version"
|
||||||
|
attributes:
|
||||||
|
label: "Minecraft version"
|
||||||
|
description: "Which Minecraft version is does your plugin or mod target?"
|
||||||
|
options:
|
||||||
|
- "1.20.1"
|
||||||
|
- "1.21.0 and below"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "dropdown"
|
||||||
|
id: "minecraft-loader"
|
||||||
|
attributes:
|
||||||
|
label: "Server software"
|
||||||
|
description: "Which server software are you using?"
|
||||||
|
options:
|
||||||
|
- "SpigotMC"
|
||||||
|
- "PaperMC"
|
||||||
|
- "PaperMC derivative (name it)"
|
||||||
|
- "Fabric"
|
||||||
|
- "NeoForge"
|
||||||
|
- "Forge"
|
||||||
|
- "Hybrid servers (e.g. Magma, Mohist) (name it)"
|
||||||
|
- "Other (name it)"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: "markdown"
|
||||||
|
id: "text-tysm"
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thank you for filling out this help form.
|
||||||
|
Please check your answers for *mistaeks* or sensitive information before sending this help request.
|
||||||
12
.forgejo/pull_request_template.md
Normal file
12
.forgejo/pull_request_template.md
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
---
|
||||||
|
name: 'Pull Request'
|
||||||
|
about: 'Submit a pull request.'
|
||||||
|
title: 'new: '
|
||||||
|
ref: 'develop'
|
||||||
|
labels:
|
||||||
|
- 'PRStatus/Open'
|
||||||
|
- 'PR/New'
|
||||||
|
---
|
||||||
|
<!--
|
||||||
|
Please list your changes here.
|
||||||
|
-->
|
||||||
97
.forgejo/workflows/commit.yml
Normal file
97
.forgejo/workflows/commit.yml
Normal file
|
|
@ -0,0 +1,97 @@
|
||||||
|
name: push-build-apidoc
|
||||||
|
|
||||||
|
on:
|
||||||
|
- push
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: git.staropensource.de/staropensource/actions-docker:java
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: https://code.forgejo.org/actions/checkout@v4
|
||||||
|
- name: Restore Gradle cache
|
||||||
|
uses: actions/cache/restore@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
|
- name: Compile
|
||||||
|
run: ./gradlew --no-daemon jar javadocJar sourceJar
|
||||||
|
- name: Save Gradle cache
|
||||||
|
uses: actions/cache/save@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
|
- name: Upload library JARs
|
||||||
|
uses: https://code.forgejo.org/forgejo/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: jars-libraries
|
||||||
|
path: |
|
||||||
|
**/build/libs/*.jar
|
||||||
|
!**/build/libs/*-javadoc.jar
|
||||||
|
!**/build/libs/*-sources.jar
|
||||||
|
if-no-files-found: error
|
||||||
|
- name: Upload API documentation JARs
|
||||||
|
uses: https://code.forgejo.org/forgejo/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: jars-apidocs
|
||||||
|
path: |
|
||||||
|
**/build/libs/*-javadoc.jar
|
||||||
|
if-no-files-found: error
|
||||||
|
- name: Upload source JARs
|
||||||
|
uses: https://code.forgejo.org/forgejo/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: jars-sources
|
||||||
|
path: |
|
||||||
|
**/build/libs/*-sources.jar
|
||||||
|
if-no-files-found: error
|
||||||
|
generate-javadoc:
|
||||||
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: git.staropensource.de/staropensource/actions-docker:java
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: https://code.forgejo.org/actions/checkout@v4
|
||||||
|
- name: Restore Gradle cache
|
||||||
|
uses: actions/cache/restore@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
|
- name: Generate javadoc
|
||||||
|
run: ./gradlew --no-daemon javadoc javadocAll
|
||||||
|
- name: Save Gradle cache
|
||||||
|
uses: actions/cache/save@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
|
- name: Upload separate javadoc
|
||||||
|
uses: https://code.forgejo.org/forgejo/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: javadoc-separate
|
||||||
|
path: |
|
||||||
|
**/build/docs/javadoc/*
|
||||||
|
if-no-files-found: error
|
||||||
|
- name: Upload combined javadoc
|
||||||
|
uses: https://code.forgejo.org/forgejo/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: javadoc-combined
|
||||||
|
path: |
|
||||||
|
build/docs/javadoc/*
|
||||||
|
if-no-files-found: error
|
||||||
33
.forgejo/workflows/pullrequest.yml
Normal file
33
.forgejo/workflows/pullrequest.yml
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
name: pr-apidoc
|
||||||
|
|
||||||
|
on:
|
||||||
|
- pull_request
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
generate-javadoc:
|
||||||
|
runs-on: docker
|
||||||
|
container:
|
||||||
|
image: git.staropensource.de/staropensource/actions-docker:java
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: https://code.forgejo.org/actions/checkout@v4
|
||||||
|
- name: Restore Gradle cache
|
||||||
|
uses: actions/cache/restore@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
|
- name: Generate javadoc
|
||||||
|
run: ./gradlew --no-daemon javadoc
|
||||||
|
- name: Save Gradle cache
|
||||||
|
uses: actions/cache/save@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.gradle/caches
|
||||||
|
~/.gradle/wrapper
|
||||||
|
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||||
|
restore-keys: |
|
||||||
|
gradle-${{ runner.os }}-
|
||||||
44
.gitignore
vendored
Normal file
44
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,44 @@
|
||||||
|
### Gradle ###
|
||||||
|
.gradle
|
||||||
|
build/
|
||||||
|
run/
|
||||||
|
!gradle/wrapper/gradle-wrapper.jar
|
||||||
|
!**/src/main/**/build/
|
||||||
|
!**/src/test/**/build/
|
||||||
|
|
||||||
|
### IntelliJ IDEA ###
|
||||||
|
.idea/modules.xml
|
||||||
|
.idea/jarRepositories.xml
|
||||||
|
.idea/compiler.xml
|
||||||
|
.idea/libraries/
|
||||||
|
.idea/*
|
||||||
|
*.iws
|
||||||
|
*.iml
|
||||||
|
*.ipr
|
||||||
|
out/
|
||||||
|
!**/src/main/**/out/
|
||||||
|
!**/src/test/**/out/
|
||||||
|
|
||||||
|
### Eclipse ###
|
||||||
|
.apt_generated
|
||||||
|
.classpath
|
||||||
|
.factorypath
|
||||||
|
.project
|
||||||
|
.settings
|
||||||
|
.springBeans
|
||||||
|
.sts4-cache
|
||||||
|
bin/
|
||||||
|
!**/src/main/**/bin/
|
||||||
|
!**/src/test/**/bin/
|
||||||
|
|
||||||
|
### NetBeans ###
|
||||||
|
/nbproject/private/
|
||||||
|
/nbbuild/
|
||||||
|
/nbdist/
|
||||||
|
/.nb-gradle/
|
||||||
|
|
||||||
|
### VS Code ###
|
||||||
|
.vscode/
|
||||||
|
|
||||||
|
### Mac OS ###
|
||||||
|
.DS_Store
|
||||||
3
.idea/copyright/profiles_settings.xml
Normal file
3
.idea/copyright/profiles_settings.xml
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
<component name="CopyrightManager">
|
||||||
|
<settings default="sos!enginemc" />
|
||||||
|
</component>
|
||||||
7
.idea/copyright/sos_enginemc.xml
Normal file
7
.idea/copyright/sos_enginemc.xml
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
<component name="CopyrightManager">
|
||||||
|
<copyright>
|
||||||
|
<option name="allowReplaceRegexp" value="Copyright .* The StarOpenSource EngineMC Authors" />
|
||||||
|
<option name="notice" value="STAROPENSOURCE ENGINEMC SOURCE FILE Copyright (c) &#36;today.year The StarOpenSource EngineMC Authors Licensed under the GNU Affero General Public License v3 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>." />
|
||||||
|
<option name="myName" value="sos!enginemc" />
|
||||||
|
</copyright>
|
||||||
|
</component>
|
||||||
122
.idea/workspace.xml
Normal file
122
.idea/workspace.xml
Normal file
|
|
@ -0,0 +1,122 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="RunManager">
|
||||||
|
<configuration name="Build" type="GradleRunConfiguration" factoryName="Gradle">
|
||||||
|
<ExternalSystemSettings>
|
||||||
|
<option name="executionName" />
|
||||||
|
<option name="externalProjectPath" value="$PROJECT_DIR$" />
|
||||||
|
<option name="externalSystemIdString" value="GRADLE" />
|
||||||
|
<option name="scriptParameters" value="" />
|
||||||
|
<option name="taskDescriptions">
|
||||||
|
<list />
|
||||||
|
</option>
|
||||||
|
<option name="taskNames">
|
||||||
|
<list>
|
||||||
|
<option value="build" />
|
||||||
|
</list>
|
||||||
|
</option>
|
||||||
|
<option name="vmOptions" />
|
||||||
|
</ExternalSystemSettings>
|
||||||
|
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
|
||||||
|
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
||||||
|
<DebugAllEnabled>false</DebugAllEnabled>
|
||||||
|
<RunAsTest>false</RunAsTest>
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
|
<configuration name="Clean" type="GradleRunConfiguration" factoryName="Gradle">
|
||||||
|
<ExternalSystemSettings>
|
||||||
|
<option name="executionName" />
|
||||||
|
<option name="externalProjectPath" value="$PROJECT_DIR$" />
|
||||||
|
<option name="externalSystemIdString" value="GRADLE" />
|
||||||
|
<option name="scriptParameters" value="" />
|
||||||
|
<option name="taskDescriptions">
|
||||||
|
<list />
|
||||||
|
</option>
|
||||||
|
<option name="taskNames">
|
||||||
|
<list>
|
||||||
|
<option value="clean" />
|
||||||
|
</list>
|
||||||
|
</option>
|
||||||
|
<option name="vmOptions" />
|
||||||
|
</ExternalSystemSettings>
|
||||||
|
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
|
||||||
|
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
||||||
|
<DebugAllEnabled>false</DebugAllEnabled>
|
||||||
|
<RunAsTest>false</RunAsTest>
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
|
<configuration name="Generate JavaDoc (combined)" type="GradleRunConfiguration" factoryName="Gradle">
|
||||||
|
<ExternalSystemSettings>
|
||||||
|
<option name="executionName" />
|
||||||
|
<option name="externalProjectPath" value="$PROJECT_DIR$" />
|
||||||
|
<option name="externalSystemIdString" value="GRADLE" />
|
||||||
|
<option name="scriptParameters" value="" />
|
||||||
|
<option name="taskDescriptions">
|
||||||
|
<list />
|
||||||
|
</option>
|
||||||
|
<option name="taskNames">
|
||||||
|
<list>
|
||||||
|
<option value="javadocAll" />
|
||||||
|
</list>
|
||||||
|
</option>
|
||||||
|
<option name="vmOptions" />
|
||||||
|
</ExternalSystemSettings>
|
||||||
|
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
|
||||||
|
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
||||||
|
<DebugAllEnabled>false</DebugAllEnabled>
|
||||||
|
<RunAsTest>false</RunAsTest>
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
|
<configuration name="Generate Javadoc (separate)" type="GradleRunConfiguration" factoryName="Gradle">
|
||||||
|
<ExternalSystemSettings>
|
||||||
|
<option name="executionName" />
|
||||||
|
<option name="externalProjectPath" value="$PROJECT_DIR$" />
|
||||||
|
<option name="externalSystemIdString" value="GRADLE" />
|
||||||
|
<option name="scriptParameters" value="" />
|
||||||
|
<option name="taskDescriptions">
|
||||||
|
<list />
|
||||||
|
</option>
|
||||||
|
<option name="taskNames">
|
||||||
|
<list>
|
||||||
|
<option value="javadoc" />
|
||||||
|
</list>
|
||||||
|
</option>
|
||||||
|
<option name="vmOptions" />
|
||||||
|
</ExternalSystemSettings>
|
||||||
|
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
|
||||||
|
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
||||||
|
<DebugAllEnabled>false</DebugAllEnabled>
|
||||||
|
<RunAsTest>false</RunAsTest>
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
|
<configuration name="Run PaperMC server" type="GradleRunConfiguration" factoryName="Gradle">
|
||||||
|
<ExternalSystemSettings>
|
||||||
|
<option name="executionName" />
|
||||||
|
<option name="externalProjectPath" value="$PROJECT_DIR$" />
|
||||||
|
<option name="externalSystemIdString" value="GRADLE" />
|
||||||
|
<option name="scriptParameters" value="" />
|
||||||
|
<option name="taskDescriptions">
|
||||||
|
<list />
|
||||||
|
</option>
|
||||||
|
<option name="taskNames">
|
||||||
|
<list>
|
||||||
|
<option value="platform-bukkit:runServer" />
|
||||||
|
</list>
|
||||||
|
</option>
|
||||||
|
<option name="vmOptions" />
|
||||||
|
</ExternalSystemSettings>
|
||||||
|
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
|
||||||
|
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
||||||
|
<DebugAllEnabled>false</DebugAllEnabled>
|
||||||
|
<RunAsTest>false</RunAsTest>
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
|
<list>
|
||||||
|
<item itemvalue="Gradle.Clean" />
|
||||||
|
<item itemvalue="Gradle.Build" />
|
||||||
|
<item itemvalue="Gradle.Run PaperMC server" />
|
||||||
|
<item itemvalue="Gradle.Generate Javadoc (separate)" />
|
||||||
|
<item itemvalue="Gradle.Generate JavaDoc (combined)" />
|
||||||
|
</list>
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
661
LICENSE
Normal file
661
LICENSE
Normal file
|
|
@ -0,0 +1,661 @@
|
||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
42
README.md
Normal file
42
README.md
Normal file
|
|
@ -0,0 +1,42 @@
|
||||||
|
# StarOpenSource EngineMC
|
||||||
|
EngineMC (or sos!enginemc for short) is a port of the [StarOpenSource Engine](https://git.staropensource.de/StarOpenSource/Engine) to Minecraft and it's various plugin and mod loaders.
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [Using EngineMC](#using-enginemc)
|
||||||
|
- [Bukkit](#bukkit)
|
||||||
|
- [Sponge, Fabric, Quilt, (Neo-)Forge & others](#sponge-fabric-quilt-neo-forge--others)
|
||||||
|
- [The `/enginemc` command](#the-enginemc-command)
|
||||||
|
- [Known issues](#known-issues)
|
||||||
|
- [Reflection is broken](#reflection-is-broken)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
|
||||||
|
## Using EngineMC
|
||||||
|
As a rule of thumb, don't do anything stupid in your plugin or modification.
|
||||||
|
This includes:
|
||||||
|
- initializing the engine manually
|
||||||
|
- accessing undocumented or internal methods, fields, etc.
|
||||||
|
- using `EngineInternals`
|
||||||
|
|
||||||
|
Everything should work out of the box.
|
||||||
|
### Bukkit
|
||||||
|
Simply declare the plugin `sosenginemc` as a hard dependency in your `plugin.yml` file.
|
||||||
|
### Sponge, Fabric, Quilt, (Neo-)Forge & others
|
||||||
|
EngineMC does not yet support these plugin/mod loaders yet, sorry.
|
||||||
|
|
||||||
|
## The `/enginemc` command
|
||||||
|
The `/enginemc` command allows access into the engine without the use of plugins.
|
||||||
|
It can do the following things:
|
||||||
|
- read and modify the engine configuration
|
||||||
|
- parse placeholders using the `PlaceholderEngine` class and return it back
|
||||||
|
- force garbage collection
|
||||||
|
- display JVM information
|
||||||
|
|
||||||
|
## Known issues
|
||||||
|
### Reflection is broken
|
||||||
|
Due to how the mod and plugin loaders load JAR files, scanning the classpath for annotations does not work.
|
||||||
|
This means that the entire event system and automatic subsystem detection is broken.
|
||||||
|
We're waiting for sos!engine developers to implement methods for manually registering subsystems and event listeners.
|
||||||
|
Until then, use other methods for initializing subsystems and sending events and data around.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
Please see [sos!engine's contributing section](https://git.staropensource.de/StarOpenSource/Engine/src/branch/develop/README.md#contributing)
|
||||||
111
build.gradle
Normal file
111
build.gradle
Normal file
|
|
@ -0,0 +1,111 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Plugins
|
||||||
|
plugins {
|
||||||
|
id("java")
|
||||||
|
id("io.freefair.lombok") version("${pluginLombok}")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Register task for Javadoc generation for all subsystems
|
||||||
|
tasks.register("javadocAll", Javadoc) {
|
||||||
|
// Subprojects to exclude
|
||||||
|
def subprojects = [
|
||||||
|
":common",
|
||||||
|
":platform-bukkit",
|
||||||
|
]
|
||||||
|
|
||||||
|
// Task metadata
|
||||||
|
setDescription("Generates Javadoc API documentation for all subprojects.")
|
||||||
|
setGroup("documentation")
|
||||||
|
|
||||||
|
// Make sure the source is delomboked first
|
||||||
|
for (String subproject : subprojects)
|
||||||
|
dependsOn(project(subproject).getTasks().named("delombok"))
|
||||||
|
|
||||||
|
// Set output directory, source and classpath
|
||||||
|
setSource(subprojects.collect({ project(it).projectDir.getPath() + "/build/generated/sources/delombok/java/main/" }))
|
||||||
|
setClasspath(files(subprojects.collect({ project(it).sourceSets.main.compileClasspath })))
|
||||||
|
setDestinationDir(file("build/docs/javadoc"))
|
||||||
|
|
||||||
|
options {
|
||||||
|
if (new File(projectDir, "src/main/javadoc/theme.css").exists())
|
||||||
|
stylesheetFile = new File(projectDir, "src/main/javadoc/theme.css") // Theming is cool :3
|
||||||
|
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
|
||||||
|
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
|
||||||
|
setLocale("en_US") // 你好
|
||||||
|
addStringOption("Xwerror", "-quiet") // Fail build on warning
|
||||||
|
|
||||||
|
setJFlags([
|
||||||
|
"-Duser.language=en_US" // See above
|
||||||
|
])
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fix module collisions
|
||||||
|
doFirst {
|
||||||
|
logger.log(LogLevel.WARN, "If this task fails, make sure to reset all module-info.java files using git or you may encounter issues.")
|
||||||
|
|
||||||
|
for (String subproject : subprojects) {
|
||||||
|
File source = new File(project(subproject).projectDir.getPath() + "/src/main/java/module-info.java")
|
||||||
|
File target = new File(project(subproject).projectDir.getPath() + "/src/main/module-info.java")
|
||||||
|
|
||||||
|
if (source.exists()) {
|
||||||
|
target.delete()
|
||||||
|
source.renameTo(target)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
doLast {
|
||||||
|
for (String subproject : subprojects) {
|
||||||
|
File source = new File(project(subproject).projectDir.getPath() + "/src/main/module-info.java")
|
||||||
|
File target = new File(project(subproject).projectDir.getPath() + "/src/main/java/module-info.java")
|
||||||
|
|
||||||
|
if (source.exists()) {
|
||||||
|
target.delete()
|
||||||
|
source.renameTo(target)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set group, version and repositories for all projects
|
||||||
|
allprojects {
|
||||||
|
version = project.versioningVersion + "-" + project.versioningType + project.versioningTyperelease + project.versioningFork
|
||||||
|
|
||||||
|
java {
|
||||||
|
setSourceCompatibility(JavaVersion.valueOf("VERSION_" + project.javaSource))
|
||||||
|
setTargetCompatibility(JavaVersion.valueOf("VERSION_" + project.javaTarget))
|
||||||
|
}
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
|
||||||
|
// StarOpenSource Engine
|
||||||
|
maven {
|
||||||
|
name = "staropensource-sosengine"
|
||||||
|
url = "https://mvn.staropensource.de/sosengine"
|
||||||
|
}
|
||||||
|
|
||||||
|
// PaperMC
|
||||||
|
maven {
|
||||||
|
name = "papermc"
|
||||||
|
url = "https://repo.papermc.io/repository/maven-public/"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
154
common/build.gradle
Normal file
154
common/build.gradle
Normal file
|
|
@ -0,0 +1,154 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import java.nio.file.Files
|
||||||
|
// Plugins
|
||||||
|
plugins {
|
||||||
|
id("java")
|
||||||
|
id("io.freefair.lombok") version("${pluginLombok}")
|
||||||
|
id("com.gorylenko.gradle-git-properties") version("${pluginGitProperties}")
|
||||||
|
id("maven-publish")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Project dependencies
|
||||||
|
dependencies {
|
||||||
|
// Lombok
|
||||||
|
compileOnly("org.projectlombok:lombok:${dependencyLombok}")
|
||||||
|
annotationProcessor("org.projectlombok:lombok:${dependencyLombok}")
|
||||||
|
|
||||||
|
// JetBrains Annotations
|
||||||
|
compileOnly("org.jetbrains:annotations:${dependencyJetbrainsAnnotations}")
|
||||||
|
|
||||||
|
// StarOpenSource Engine
|
||||||
|
implementation("de.staropensource.sosengine:base:${dependencyStarOpenSourceEngine}")
|
||||||
|
|
||||||
|
// Adventure
|
||||||
|
implementation("net.kyori:adventure-api:${dependencyAdventure}")
|
||||||
|
implementation("net.kyori:adventure-text-minimessage:${dependencyAdventure}")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fix delombok task
|
||||||
|
delombok.doFirst {
|
||||||
|
File target = file("${project.projectDir}/src/main/module-info.java")
|
||||||
|
File source = file("${project.projectDir}/src/main/java/module-info.java")
|
||||||
|
|
||||||
|
target.delete()
|
||||||
|
source.renameTo(target)
|
||||||
|
}
|
||||||
|
delombok.doLast {
|
||||||
|
File target = file("${project.projectDir}/src/main/java/module-info.java")
|
||||||
|
File source = file("${project.projectDir}/src/main/module-info.java")
|
||||||
|
|
||||||
|
target.delete()
|
||||||
|
source.renameTo(target)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Copy gradle.properties file
|
||||||
|
// for inclusion in final build
|
||||||
|
tasks.register("copyGradleProperties") {
|
||||||
|
doFirst {
|
||||||
|
File target = file("${project.projectDir}/src/main/resources/sosenginemc-gradle.properties")
|
||||||
|
File source = file(project(":").projectDir.getPath() + "/gradle.properties")
|
||||||
|
target.delete()
|
||||||
|
Files.copy(source.toPath(), target.toPath())
|
||||||
|
}
|
||||||
|
|
||||||
|
outputs.upToDateWhen({ false }) // Force task execution
|
||||||
|
}
|
||||||
|
processResources.dependsOn(copyGradleProperties)
|
||||||
|
|
||||||
|
// Git properties configuration
|
||||||
|
// Allows us to embed git commit information in the engine build
|
||||||
|
gitProperties {
|
||||||
|
dotGitDirectory = file("${rootProject.rootDir}/.git")
|
||||||
|
failOnNoGitDirectory = false // Allow continuing if .git directory is missing for the few who use tarballs
|
||||||
|
extProperty = "gitProps"
|
||||||
|
|
||||||
|
dateFormat = "yyyy-MM-dd'T'HH:mmZ"
|
||||||
|
dateFormatTimeZone = "UTC"
|
||||||
|
}
|
||||||
|
|
||||||
|
tasks.register("writeGitProperties") { // This task's only purpose is to copy the git.properties from our git properties plugin to the resources directory so it's included in the final build
|
||||||
|
doLast {
|
||||||
|
File target = file("${project.projectDir}/src/main/resources/sosenginemc-git.properties")
|
||||||
|
File source = file("${project.projectDir}/build/resources/main/git.properties")
|
||||||
|
|
||||||
|
target.delete()
|
||||||
|
source.renameTo(target)
|
||||||
|
}
|
||||||
|
|
||||||
|
outputs.upToDateWhen({ false }) // Force task execution
|
||||||
|
}
|
||||||
|
generateGitProperties.outputs.upToDateWhen({ false }) // Force task execution
|
||||||
|
processResources.dependsOn(writeGitProperties) // Ensure git.properties file is present
|
||||||
|
|
||||||
|
// Javadoc configuration
|
||||||
|
javadoc {
|
||||||
|
outputs.upToDateWhen { false } // Force task execution
|
||||||
|
dependsOn(delombok) // Make sure the source is delomboked first
|
||||||
|
|
||||||
|
javadoc {
|
||||||
|
setClasspath(files(project.sourceSets.main.compileClasspath)) // Include dependencies
|
||||||
|
|
||||||
|
options {
|
||||||
|
if (new File(projectDir, "src/main/javadoc/theme.css").exists())
|
||||||
|
stylesheetFile = new File(projectDir, "src/main/javadoc/theme.css") // Theming is cool :3
|
||||||
|
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
|
||||||
|
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
|
||||||
|
setLocale("en_US") // 你好
|
||||||
|
addStringOption("Xwerror", "-quiet") // Fail build on warning
|
||||||
|
|
||||||
|
setJFlags([
|
||||||
|
"-Duser.language=en_US" // See above
|
||||||
|
])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Include javadoc and source jar during publishing
|
||||||
|
java {
|
||||||
|
withJavadocJar()
|
||||||
|
withSourcesJar()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build publishing configuration
|
||||||
|
// Note: You can safely ignore any errors or warnings thrown by your IDE here
|
||||||
|
publishing {
|
||||||
|
repositories {
|
||||||
|
maven {
|
||||||
|
name = "staropensource"
|
||||||
|
url = uri("https://mvn.staropensource.de/sosengine")
|
||||||
|
credentials(org.gradle.api.credentials.PasswordCredentials)
|
||||||
|
authentication {
|
||||||
|
//noinspection GroovyAssignabilityCheck
|
||||||
|
basic (BasicAuthentication)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
publications {
|
||||||
|
//noinspection GroovyAssignabilityCheck
|
||||||
|
maven (MavenPublication) {
|
||||||
|
groupId = group
|
||||||
|
artifactId = project.getName()
|
||||||
|
version = version
|
||||||
|
//noinspection GroovyAssignabilityCheck
|
||||||
|
from components.java
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
1
common/gradle
Symbolic link
1
common/gradle
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../gradle
|
||||||
1
common/gradlew
vendored
Symbolic link
1
common/gradlew
vendored
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../gradlew
|
||||||
1
common/gradlew.bat
vendored
Symbolic link
1
common/gradlew.bat
vendored
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../gradlew.bat
|
||||||
|
|
@ -0,0 +1,103 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.sosengine.minecraft;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.Engine;
|
||||||
|
import de.staropensource.sosengine.base.EngineInternals;
|
||||||
|
import de.staropensource.sosengine.base.implementable.LoggingAdapter;
|
||||||
|
import de.staropensource.sosengine.base.implementable.ShutdownHandler;
|
||||||
|
import de.staropensource.sosengine.base.logging.Logger;
|
||||||
|
import de.staropensource.sosengine.base.logging.LoggerInstance;
|
||||||
|
import de.staropensource.sosengine.base.type.InternalAccessArea;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Responsible for bootstrapping and initializing the engine.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public final class EngineBootstrapper {
|
||||||
|
/**
|
||||||
|
* Contains the {@link LoggerInstance} for this instance.
|
||||||
|
*
|
||||||
|
* @see LoggerInstance
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private static final LoggerInstance logger = new LoggerInstance.Builder().setClazz(EngineBootstrapper.class).setOrigin("ENGINEMC").build();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes the engine and environment.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public static void initialize(boolean disableMultithreading, @NotNull ShutdownHandler shutdownHandler, @NotNull LoggingAdapter loggingAdapter) {
|
||||||
|
overwriteSystemProperties(disableMultithreading); // Overwrites certain system properties to overwrite the engine configuration
|
||||||
|
Logger.setLoggingAdapter(loggingAdapter); // Install logging adapter
|
||||||
|
new Engine(); // Initialize engine
|
||||||
|
configureEngineShutdown(shutdownHandler); // Configures how the engine shuts itself down
|
||||||
|
EngineInternals.getInstance().restrictAccess(InternalAccessArea.ALL_WRITE); // Restrict internal engine access to read-only
|
||||||
|
initializeSubystems(); // Initialize subsystems
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Overwrites system properties to configure the engine.
|
||||||
|
*
|
||||||
|
* @param disableMultithreading disables multithreading support if {@code true}
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private static void overwriteSystemProperties(boolean disableMultithreading) {
|
||||||
|
System.getProperties().setProperty("sosengine.base.loggerTemplate", "[%log_level% %log_path%%log_metadata%] %log_message_prefix%%log_message%");
|
||||||
|
System.getProperties().setProperty("sosengine.base.optimizeLogging", "true");
|
||||||
|
System.getProperties().setProperty("sosengine.base.loggerImmediateShutdown", "false");
|
||||||
|
System.getProperties().setProperty("sosengine.base.optimizeSubsystemInitialization", "false");
|
||||||
|
if (disableMultithreading)
|
||||||
|
System.getProperties().setProperty("sosengine.base.optimizeEvents", "false");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configures how the engine shuts itself down.
|
||||||
|
*
|
||||||
|
* @param shutdownHandler shutdown handler to run after engine shutdown
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private static void configureEngineShutdown(@NotNull ShutdownHandler shutdownHandler) {
|
||||||
|
EngineInternals.getInstance().setShutdownHandler(exitcode -> {
|
||||||
|
logger.diag("Invoking shutdown handler");
|
||||||
|
try {
|
||||||
|
shutdownHandler.shutdown(exitcode);
|
||||||
|
} catch (Exception exception) {
|
||||||
|
logger.crash("Unable to shutdown server! Shutdown handler threw an exception. Hanging thread", exception, true);
|
||||||
|
//noinspection InfiniteLoopStatement // we want an infinite loop
|
||||||
|
while (true)
|
||||||
|
Thread.onSpinWait();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
EngineInternals.getInstance().installSafetyShutdownHook(true);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes all subsystems bundled with this subsystem.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private static void initializeSubystems() {
|
||||||
|
new MinecraftSubsystem().initializeSubsystem();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,56 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.sosengine.minecraft;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.annotation.EngineSubsystem;
|
||||||
|
import de.staropensource.sosengine.base.implementable.SubsystemClass;
|
||||||
|
import de.staropensource.sosengine.base.implementation.versioning.StarOpenSourceVersioningSystem;
|
||||||
|
import de.staropensource.sosengine.base.type.DependencyVector;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Main class of the Minecraft subsystem.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@EngineSubsystem
|
||||||
|
public final class MinecraftSubsystem extends SubsystemClass {
|
||||||
|
@Override
|
||||||
|
public @NotNull String getName() {
|
||||||
|
return "minecraft";
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void initializeSubsystem() {
|
||||||
|
SubsystemInformation.update();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public @NotNull DependencyVector getDependencyVector() throws IllegalStateException {
|
||||||
|
if (SubsystemInformation.getVersioningString() == null)
|
||||||
|
SubsystemInformation.update();
|
||||||
|
|
||||||
|
return new DependencyVector.Builder()
|
||||||
|
.setIdentifier(getName())
|
||||||
|
.setVersioningSystem(StarOpenSourceVersioningSystem.class)
|
||||||
|
.setVersion(SubsystemInformation.getVersioningString())
|
||||||
|
.build();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,382 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.sosengine.minecraft;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.Engine;
|
||||||
|
import de.staropensource.sosengine.base.logging.LoggerInstance;
|
||||||
|
import de.staropensource.sosengine.base.type.VersionType;
|
||||||
|
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
||||||
|
import de.staropensource.sosengine.base.utility.PropertiesReader;
|
||||||
|
import de.staropensource.sosengine.base.utility.information.EngineInformation;
|
||||||
|
import lombok.Getter;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
|
import java.text.ParseException;
|
||||||
|
import java.text.SimpleDateFormat;
|
||||||
|
import java.time.ZonedDateTime;
|
||||||
|
import java.util.Date;
|
||||||
|
import java.util.GregorianCalendar;
|
||||||
|
import java.util.Locale;
|
||||||
|
import java.util.Properties;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides information about the subsystem.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
|
public final class SubsystemInformation {
|
||||||
|
/**
|
||||||
|
* Contains the {@link LoggerInstance} for this instance.
|
||||||
|
*
|
||||||
|
* @see LoggerInstance
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private static final @NotNull LoggerInstance logger = new LoggerInstance.Builder().setClazz(SubsystemInformation.class).setOrigin("ENGINEMC").build();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the subsystem's version codename.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the subsystem's version codename.
|
||||||
|
*
|
||||||
|
* @return subsystem version codename
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static String versioningCodename;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the subsystem's version.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the subsystem's version.
|
||||||
|
*
|
||||||
|
* @return subsystem version
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static int versioningVersion;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the subsystem's version type.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the subsystem's version type.
|
||||||
|
*
|
||||||
|
* @return subsystem version type
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static VersionType versioningType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the subsystem's typerelease.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the subsystem's typerelease.
|
||||||
|
*
|
||||||
|
* @return subsystem typerelease
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static int versioningTyperelease;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the subsystem's fork identifier.
|
||||||
|
* <p>
|
||||||
|
* Likely empty. If not, prefixed with a dash.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the subsystem's fork identifier.
|
||||||
|
* <p>
|
||||||
|
* Likely empty. If not, prefixed with a dash.
|
||||||
|
*
|
||||||
|
* @return subsystem fork identifier
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static String versioningFork;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the subsystem's full version string.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the subsystem's full version string.
|
||||||
|
*
|
||||||
|
* @return subsystem version string
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static String versioningString;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the Java version of the EngineMC source.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the Java version of the EngineMC source.
|
||||||
|
*
|
||||||
|
* @return Java version of EngineMC source
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static short javaSource;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the Java version EngineMC was compiled against.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the Java version EngineMC was compiled against.
|
||||||
|
*
|
||||||
|
* @return Java version compiled against
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static short javaTarget;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the {@code dirty} value (i.e. if the source tree has been modified).
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the {@code dirty} value (i.e. if the source tree has been modified).
|
||||||
|
*
|
||||||
|
* @return git dirty value
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static boolean gitDirty;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the branch EngineMC was built on.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the branch EngineMC was built on.
|
||||||
|
*
|
||||||
|
* @return git branch
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static String gitBranch;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the commit count.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the commit count.
|
||||||
|
*
|
||||||
|
* @return git commit count
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static int gitCommitCount;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the commit identifier (short form).
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the commit identifier (short form).
|
||||||
|
*
|
||||||
|
* @return git long commit id
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static String gitCommitIdentifierShort;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the commit identifier (long form).
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the commit identifier (long form).
|
||||||
|
*
|
||||||
|
* @return git long commit id
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static String gitCommitIdentifierLong;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the commit header.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the commit header.
|
||||||
|
*
|
||||||
|
* @return git commit header
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static String gitCommitHeader;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the commit time.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the commit time.
|
||||||
|
*
|
||||||
|
* @return git commit time
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static ZonedDateTime gitCommitTime;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the commiter's name.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the commiter's name.
|
||||||
|
*
|
||||||
|
* @return git committer name
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static String gitCommitterName;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the commiter's email.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the commiter's email.
|
||||||
|
*
|
||||||
|
* @return git committer email
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static String gitCommitterEmail;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructs this class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public SubsystemInformation() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates all variables.
|
||||||
|
* <p>
|
||||||
|
* This method does not need to be invoked manually, as the information provided by
|
||||||
|
* this class is static (does not change) and is already populated at subsystem startup.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public static synchronized void update() {
|
||||||
|
logger.diag("Updating subsystem information");
|
||||||
|
|
||||||
|
// Load properties from bundled gradle.properties
|
||||||
|
Properties gradleProperties = new Properties();
|
||||||
|
InputStream gradleStream = EngineInformation.class.getClassLoader().getResourceAsStream("sosenginemc-gradle.properties");
|
||||||
|
|
||||||
|
if (gradleStream == null) {
|
||||||
|
logger.crash("Unable to load build information: The bundled gradle.properties file could not be found.");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
gradleProperties.load(gradleStream);
|
||||||
|
gradleStream.close();
|
||||||
|
} catch (IOException exception) {
|
||||||
|
logger.crash("Unable to load build information: InputStream 'gradleStream' failed", exception);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load properties from bundled git.properties
|
||||||
|
// or fill in blank information if file missing
|
||||||
|
Properties gitProperties = new Properties();
|
||||||
|
InputStream gitStream = EngineInformation.class.getClassLoader().getResourceAsStream("sosenginemc-git.properties");
|
||||||
|
if (gitStream == null) {
|
||||||
|
logger.error("Unable to load build information: The bundled git.properties file could not be found. Did you download a tarball?");
|
||||||
|
|
||||||
|
// Fake information
|
||||||
|
gitProperties.setProperty("git.total.commit.count", "0");
|
||||||
|
gitProperties.setProperty("git.dirty", "true");
|
||||||
|
gitProperties.setProperty("git.branch", "/git.properties is missing/");
|
||||||
|
gitProperties.setProperty("git.commit.id", "########################################");
|
||||||
|
gitProperties.setProperty("git.commit.id.abbrev", "#######");
|
||||||
|
gitProperties.setProperty("git.commit.message.short", "git.properties file is missing :/");
|
||||||
|
gitProperties.setProperty("git.commit.time", "1970-01-01T00:00+0000");
|
||||||
|
gitProperties.setProperty("git.commit.user.name", "git.properties file is missing :/");
|
||||||
|
gitProperties.setProperty("git.commit.user.email", "git.properties-is-missing@example.com");
|
||||||
|
} else {
|
||||||
|
// Load real information from git.properties file
|
||||||
|
try {
|
||||||
|
gitProperties.load(gitStream);
|
||||||
|
gitStream.close();
|
||||||
|
} catch (IOException exception) {
|
||||||
|
logger.crash("Unable to load build information: InputStream 'gitStream' failed", exception);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create new PropertyParsers
|
||||||
|
PropertiesReader gradleParser = new PropertiesReader(gradleProperties);
|
||||||
|
PropertiesReader gitParser = new PropertiesReader(gitProperties);
|
||||||
|
|
||||||
|
// Apply properties to fields
|
||||||
|
versioningCodename = gradleParser.getString("versioningCodename");
|
||||||
|
versioningVersion = gradleParser.getInteger("versioningVersion", true);
|
||||||
|
versioningType = VersionType.valueOf(gradleParser.getString("versioningType").toUpperCase());
|
||||||
|
versioningTyperelease = gradleParser.getInteger("versioningTyperelease", true);
|
||||||
|
versioningFork = gradleParser.getString("versioningFork");
|
||||||
|
versioningString = "v" + versioningVersion + "-" + (versioningType == VersionType.RELEASE_CANDIDATE ? "releasecandidate" : versioningType.name().toLowerCase(Locale.ROOT)) + versioningTyperelease + versioningFork;
|
||||||
|
|
||||||
|
javaSource = gradleParser.getShort("javaSource");
|
||||||
|
javaTarget = gradleParser.getShort("javaTarget");
|
||||||
|
|
||||||
|
gitDirty = gitParser.getBoolean("git.dirty");
|
||||||
|
gitBranch = gitParser.getString("git.branch");
|
||||||
|
gitCommitCount = gitParser.getInteger("git.total.commit.count", true);
|
||||||
|
gitCommitIdentifierShort = gitParser.getString("git.commit.id.abbrev");
|
||||||
|
gitCommitIdentifierLong = gitParser.getString("git.commit.id");
|
||||||
|
gitCommitHeader = gitParser.getString("git.commit.message.short");
|
||||||
|
try {
|
||||||
|
Date date = new SimpleDateFormat("yyyy-MM-dd'T'HH:mmZ").parse(gitParser.getString("git.commit.time"));
|
||||||
|
GregorianCalendar calendar = new GregorianCalendar();
|
||||||
|
calendar.setTime(date);
|
||||||
|
gitCommitTime = calendar.toZonedDateTime();
|
||||||
|
} catch (ParseException exception) {
|
||||||
|
System.out.println("Unable to load build information: Can't parse \"" + gitParser.getString("git.commit.time") + "\" using format \"yyyy-MM-dd'T'HH:mmZ\"");
|
||||||
|
System.out.println(Miscellaneous.getStackTraceHeader(exception) + "\n" + Miscellaneous.getStackTraceAsString(exception, true));
|
||||||
|
Engine.getInstance().shutdown(69);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
gitCommitterName = gitParser.getString("git.commit.user.name");
|
||||||
|
gitCommitterEmail = gitParser.getString("git.commit.user.email");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,286 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.sosengine.minecraft.command;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.EngineConfiguration;
|
||||||
|
import de.staropensource.sosengine.base.utility.Miscellaneous;
|
||||||
|
import de.staropensource.sosengine.base.utility.PlaceholderEngine;
|
||||||
|
import de.staropensource.sosengine.base.utility.information.JvmInformation;
|
||||||
|
import de.staropensource.sosengine.minecraft.SubsystemInformation;
|
||||||
|
import net.kyori.adventure.text.minimessage.MiniMessage;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.concurrent.TimeUnit;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains all the logic required for
|
||||||
|
* making the {@code /enginemc} command work.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public class Command {
|
||||||
|
/**
|
||||||
|
* Executes the command.
|
||||||
|
*
|
||||||
|
* @param player player executing the command
|
||||||
|
* @param arguments command arguments
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public static void execute(@NotNull Player player, @NotNull String[] arguments) {
|
||||||
|
if (arguments.length == 0) {
|
||||||
|
// Display welcome message
|
||||||
|
message(player, Strings.welcome);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
switch (arguments[0]) {
|
||||||
|
case "help" -> message(player, Strings.help); // Display help
|
||||||
|
case "config" -> {
|
||||||
|
if (arguments.length == 1)
|
||||||
|
// Throw "Too few arguments" error
|
||||||
|
message(player, Strings.errorTooFewArguments);
|
||||||
|
else if (arguments.length == 2) {
|
||||||
|
// Return configuration setting
|
||||||
|
String value = switch (arguments[1]) {
|
||||||
|
case "debug" -> String.valueOf(EngineConfiguration.getInstance().isDebug());
|
||||||
|
case "debugEvents" -> String.valueOf(EngineConfiguration.getInstance().isDebugEvents());
|
||||||
|
case "debugShortcodeConverter" -> String.valueOf(EngineConfiguration.getInstance().isDebugShortcodeConverter());
|
||||||
|
|
||||||
|
case "errorShortcodeConverter" -> String.valueOf(EngineConfiguration.getInstance().isErrorShortcodeConverter());
|
||||||
|
|
||||||
|
case "optimizeLogging" -> String.valueOf(EngineConfiguration.getInstance().isOptimizeLogging());
|
||||||
|
case "optimizeEvents" -> String.valueOf(EngineConfiguration.getInstance().isOptimizeEvents());
|
||||||
|
case "optimizeSubsystemInitialization" -> String.valueOf(EngineConfiguration.getInstance().isOptimizeSubsystemInitialization());
|
||||||
|
|
||||||
|
case "loggerLevel" -> "LogLevel." + EngineConfiguration.getInstance().getLoggerLevel().name();
|
||||||
|
case "loggerTemplate" -> "\"" + EngineConfiguration.getInstance().getLoggerTemplate() + "\"";
|
||||||
|
case "loggerPollingSpeed" -> String.valueOf(EngineConfiguration.getInstance().getLoggerPollingSpeed());
|
||||||
|
case "loggerForceStandardOutput" -> String.valueOf(EngineConfiguration.getInstance().isLoggerForceStandardOutput());
|
||||||
|
case "loggerEnableNewlineSupport" -> String.valueOf(EngineConfiguration.getInstance().isLoggerEnableNewlineSupport());
|
||||||
|
case "loggerImmediateShutdown" -> String.valueOf(EngineConfiguration.getInstance().isLoggerImmediateShutdown());
|
||||||
|
|
||||||
|
case "hideFullTypePath" -> String.valueOf(EngineConfiguration.getInstance().isHideFullTypePath());
|
||||||
|
|
||||||
|
default -> null;
|
||||||
|
};
|
||||||
|
|
||||||
|
if (value == null)
|
||||||
|
message(player, Strings.errorInvalidSetting.replace("%key%", arguments[1]));
|
||||||
|
else
|
||||||
|
message(player, Strings.configGet.replace("%key%", arguments[1]).replace("%value%", value));
|
||||||
|
} else {
|
||||||
|
// Update configuration setting
|
||||||
|
StringBuilder newValue = new StringBuilder();
|
||||||
|
|
||||||
|
for (int index = 2; index < arguments.length; index++) {
|
||||||
|
if (!newValue.isEmpty())
|
||||||
|
newValue.append(" ");
|
||||||
|
newValue.append(arguments[index]);
|
||||||
|
}
|
||||||
|
|
||||||
|
switch (arguments[1]) {
|
||||||
|
case "debug" -> System.getProperties().setProperty("sosengine.base.debug", String.valueOf(newValue));
|
||||||
|
case "debugEvents" -> System.getProperties().setProperty("sosengine.base.debugEvents", String.valueOf(newValue));
|
||||||
|
case "debugShortcodeConverter" -> System.getProperties().setProperty("sosengine.base.debugShortcodeConverter", String.valueOf(newValue));
|
||||||
|
|
||||||
|
case "errorShortcodeConverter" -> System.getProperties().setProperty("sosengine.base.errorShortcodeConverter", String.valueOf(newValue));
|
||||||
|
|
||||||
|
case "optimizeLogging" -> System.getProperties().setProperty("sosengine.base.optimizeLogging", String.valueOf(newValue));
|
||||||
|
case "optimizeEvents" -> System.getProperties().setProperty("sosengine.base.optimizeEvents", String.valueOf(newValue));
|
||||||
|
case "optimizeSubsystemInitialization" -> System.getProperties().setProperty("sosengine.base.optimizeSubsystemInitialization", String.valueOf(newValue));
|
||||||
|
|
||||||
|
case "loggerLevel" -> System.getProperties().setProperty("sosengine.base.loggerLevel", String.valueOf(newValue));
|
||||||
|
case "loggerTemplate" -> System.getProperties().setProperty("sosengine.base.loggerTemplate", String.valueOf(newValue));
|
||||||
|
case "loggerPollingSpeed" -> System.getProperties().setProperty("sosengine.base.loggerPollingSpeed", String.valueOf(newValue));
|
||||||
|
case "loggerForceStandardOutput" -> System.getProperties().setProperty("sosengine.base.loggerForceStandardOutput", String.valueOf(newValue));
|
||||||
|
case "loggerEnableNewlineSupport" -> System.getProperties().setProperty("sosengine.base.loggerEnableNewlineSupport", String.valueOf(newValue));
|
||||||
|
case "loggerImmediateShutdown" -> System.getProperties().setProperty("sosengine.base.loggerImmediateShutdown", String.valueOf(newValue));
|
||||||
|
|
||||||
|
case "hideFullTypePath" -> System.getProperties().setProperty("sosengine.base.hideFullTypePath", String.valueOf(newValue));
|
||||||
|
|
||||||
|
default -> {
|
||||||
|
message(player, Strings.errorInvalidSetting.replace("%key%", arguments[1]));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
EngineConfiguration.getInstance().loadDefaultConfiguration();
|
||||||
|
EngineConfiguration.getInstance().loadConfiguration();
|
||||||
|
message(player, Strings.configSet.replace("%key%", arguments[1]).replace("%value%", newValue));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case "placeholder" -> {
|
||||||
|
// Parse and return placeholders using the PlaceholderEngine
|
||||||
|
if (arguments.length == 1) {
|
||||||
|
message(player, Strings.errorTooFewArguments);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
StringBuilder args = new StringBuilder();
|
||||||
|
for (int index = 1; index < arguments.length; index++)
|
||||||
|
args.append(arguments[index]);
|
||||||
|
|
||||||
|
message(player, "<reset>" + PlaceholderEngine.getInstance().process(args.toString()).replace("<", "\u200C\\<"));
|
||||||
|
}
|
||||||
|
case "gc" -> {
|
||||||
|
// Force garbage collection
|
||||||
|
message(player, Strings.gcStart);
|
||||||
|
Miscellaneous.invokeGarbageCollector();
|
||||||
|
message(player, Strings.gcEnd);
|
||||||
|
}
|
||||||
|
case "jvminfo" -> {
|
||||||
|
// Display information about the JVM
|
||||||
|
String message = Strings.jvminfo;
|
||||||
|
long uptime = JvmInformation.getUptime();
|
||||||
|
StringBuilder uptimeString = new StringBuilder();
|
||||||
|
StringBuilder jvmArgs = new StringBuilder();
|
||||||
|
|
||||||
|
// Populate 'uptime'
|
||||||
|
long uptimeDays = TimeUnit.MILLISECONDS.toDays(uptime);
|
||||||
|
long uptimeHours = TimeUnit.MILLISECONDS.toHours(uptime);
|
||||||
|
long uptimeMinutes = TimeUnit.MILLISECONDS.toMinutes(uptime);
|
||||||
|
long uptimeSeconds = TimeUnit.MILLISECONDS.toSeconds(uptime);
|
||||||
|
|
||||||
|
if (uptimeDays > 0)
|
||||||
|
uptimeString
|
||||||
|
.append(uptimeDays)
|
||||||
|
.append("d ");
|
||||||
|
else if (uptimeHours > 0 && uptimeHours <= 24)
|
||||||
|
uptimeString
|
||||||
|
.append(uptimeHours)
|
||||||
|
.append("h ");
|
||||||
|
else if (uptimeMinutes > 0 && uptimeMinutes <= 60)
|
||||||
|
uptimeString
|
||||||
|
.append(uptimeMinutes)
|
||||||
|
.append("m ");
|
||||||
|
else
|
||||||
|
uptimeString
|
||||||
|
.append(uptimeSeconds)
|
||||||
|
.append("s ");
|
||||||
|
|
||||||
|
// Populate 'jvmArgs'
|
||||||
|
for (String arg : JvmInformation.getArguments()) {
|
||||||
|
if (!jvmArgs.isEmpty())
|
||||||
|
jvmArgs.append("\n");
|
||||||
|
jvmArgs
|
||||||
|
.append("<red>-> <bold>")
|
||||||
|
.append(arg);
|
||||||
|
}
|
||||||
|
|
||||||
|
message = message
|
||||||
|
.replace("%arguments%", jvmArgs)
|
||||||
|
.replace("%arguments_count%", String.valueOf(JvmInformation.getArguments().size()))
|
||||||
|
.replace("%processors%", String.valueOf(JvmInformation.getAvailableProcessors()))
|
||||||
|
.replace("%impl_name%", JvmInformation.getImplementationName())
|
||||||
|
.replace("%impl_vendor%", JvmInformation.getImplementationVendor())
|
||||||
|
.replace("%impl_version%", JvmInformation.getImplementationVersion())
|
||||||
|
.replace("%java%", String.valueOf(JvmInformation.getJavaVersion()))
|
||||||
|
.replace("%memory_free_mib%", String.valueOf(JvmInformation.getMemoryFree() / 1048576))
|
||||||
|
.replace("%memory_free_gib%", String.valueOf(JvmInformation.getMemoryFree() / 1073741824))
|
||||||
|
.replace("%memory_used_mib%", String.valueOf(JvmInformation.getMemoryUsed() / 1048576))
|
||||||
|
.replace("%memory_used_gib%", String.valueOf(JvmInformation.getMemoryUsed() / 1073741824))
|
||||||
|
.replace("%memory_limit_mib%", String.valueOf(JvmInformation.getMemoryLimit() / 1048576))
|
||||||
|
.replace("%memory_limit_gib%", String.valueOf(JvmInformation.getMemoryLimit() / 1073741824))
|
||||||
|
.replace("%memory_total_mib%", String.valueOf(JvmInformation.getMemoryTotal() / 1048576))
|
||||||
|
.replace("%memory_total_gib%", String.valueOf(JvmInformation.getMemoryTotal() / 1073741824))
|
||||||
|
.replace("%uptime%", uptimeString.substring(0, uptimeString.length() - 1))
|
||||||
|
;
|
||||||
|
|
||||||
|
message(player, message);
|
||||||
|
}
|
||||||
|
default -> message(player, Strings.errorInvalidArgument);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sends a message to the specified receiver.
|
||||||
|
*
|
||||||
|
* @param receiver receiver of the message
|
||||||
|
* @param message message to send
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private static void message(@NotNull Player receiver, @NotNull String message) {
|
||||||
|
receiver.message(MiniMessage.miniMessage().deserialize(Strings.prefix + message.replace("\n", "\n" + Strings.prefix)));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains all strings used by this command.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private static final class Strings {
|
||||||
|
// Prefix
|
||||||
|
public static final String prefix = "<reset><#d60532>[EngineMC] <reset>";
|
||||||
|
|
||||||
|
// Errors
|
||||||
|
public static final String errorInvalidArgument = "<red>Error: <italic>Invalid argument";
|
||||||
|
public static final String errorTooFewArguments = "<red>Error: <italic>Too few arguments";
|
||||||
|
public static final String errorInvalidSetting = "<red>Error: <italic>Invalid configuration setting \"%key%\"";
|
||||||
|
|
||||||
|
// Welcome
|
||||||
|
public static final String welcome =
|
||||||
|
"<#d60532><bold>EngineMC " + SubsystemInformation.getVersioningString() + " <italic>(on PaperMC Bukkit)</italic>\n" +
|
||||||
|
"""
|
||||||
|
<#d60532>This server is running <italic><click:open_url:https://git.staropensource.de/StarOpenSource/EngineMC>EngineMC</click></italic>, a port of the <italic><click:open_url:https://engine.staropensource.de>StarOpenSource Engine</click></italic> to Minecraft.
|
||||||
|
|
||||||
|
<#d60532>For a list of all available commands, execute <italic>/enginemc help</italic>""";
|
||||||
|
|
||||||
|
// Help
|
||||||
|
public static final String help =
|
||||||
|
"""
|
||||||
|
<red><bold>Help (\\<required> [optional])
|
||||||
|
|
||||||
|
<red><bold>help</bold>: Displays this message
|
||||||
|
<red><bold>config</bold> \\<key> [value]: Displays the value of a setting if <italic>value</italic> is unset, or sets it if it isn't
|
||||||
|
<red><bold>placeholder</bold> \\<message>: Runs the specified message through sos!engine's PlaceholderEngine and returns it's result
|
||||||
|
<red><bold>gc</bold>: Forcefully invokes the garbage collector
|
||||||
|
<red><bold>jvminfo</bold>: Displays information about the Java Virtual Machine""";
|
||||||
|
|
||||||
|
// Configuration
|
||||||
|
public static final String configGet = "<red>The configuration setting \"%key%\" is set to '%value%'";
|
||||||
|
public static final String configSet = "<red>The configuration setting \"%key%\" has been updated to \"%value%\"";
|
||||||
|
|
||||||
|
// Garbage collection
|
||||||
|
public static final String gcStart = "<red>Invoking the garbage collector";
|
||||||
|
public static final String gcEnd = """
|
||||||
|
<red>The garbage collector has been invoked
|
||||||
|
<red>Note: Forcing garbage collection does not work as advertised, see why <underlined><click:open_url:https://stackoverflow.com/a/1481185>here</click></underlined> and <underlined><click:open_url:https://git.staropensource.de/StarOpenSource/Engine/src/commit/dffd24d8bb2cab5e7be77859bd8991442b8a4e11/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java#L192>here</click></underlined>.""";
|
||||||
|
|
||||||
|
// JVM information
|
||||||
|
public static final String jvminfo =
|
||||||
|
"""
|
||||||
|
<red><bold>Java Virtual Machine
|
||||||
|
|
||||||
|
<red>Java version: <bold>%java%
|
||||||
|
<red>Implementation
|
||||||
|
<red> -> Name: <bold>%impl_name%
|
||||||
|
<red> -> Vendor: <bold>%impl_vendor%
|
||||||
|
<red> -> Version: <bold>%impl_version%
|
||||||
|
<red>Uptime: <bold>%uptime%
|
||||||
|
<red>Available processors: <bold>%processors%
|
||||||
|
<red>Memory
|
||||||
|
<red> -> Free: <bold>%memory_free_gib% GiB (%memory_free_mib% MiB)
|
||||||
|
<red> -> Used: <bold>%memory_used_gib% GiB (%memory_used_mib% MiB)
|
||||||
|
<red> -> Limit: <bold>%memory_limit_gib% GiB (%memory_limit_mib% MiB)
|
||||||
|
<red> -> Total: <bold>%memory_total_gib% GiB (%memory_total_mib% MiB)
|
||||||
|
<red>Arguments (<bold>%arguments_count%</bold>):
|
||||||
|
%arguments%""";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,45 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.sosengine.minecraft.command;
|
||||||
|
|
||||||
|
import net.kyori.adventure.text.Component;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Allows the {@link Command} to
|
||||||
|
* interact with the player.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public abstract class Player {
|
||||||
|
/**
|
||||||
|
* Constructs this class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public Player() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sends a message to the player.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public abstract void message(@NotNull Component message);
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains all the code necessary for running the
|
||||||
|
* StarOpenSource Engine in Minecraft.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.sosengine.minecraft;
|
||||||
20
common/src/main/java/module-info.java
Normal file
20
common/src/main/java/module-info.java
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
/**
|
||||||
|
* The core of EngineMC.
|
||||||
|
* Responsible for bootstrapping the engine.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
module sosengine.minecraft {
|
||||||
|
// Dependencies
|
||||||
|
requires sosengine.base;
|
||||||
|
requires net.kyori.adventure;
|
||||||
|
requires net.kyori.adventure.text.minimessage;
|
||||||
|
|
||||||
|
// API access
|
||||||
|
exports de.staropensource.sosengine.minecraft;
|
||||||
|
exports de.staropensource.sosengine.minecraft.command;
|
||||||
|
|
||||||
|
// Reflection access
|
||||||
|
opens de.staropensource.sosengine.minecraft;
|
||||||
|
opens de.staropensource.sosengine.minecraft.command;
|
||||||
|
}
|
||||||
1
common/src/main/resources/.gitignore
vendored
Normal file
1
common/src/main/resources/.gitignore
vendored
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
*.properties
|
||||||
49
gradle.properties
Normal file
49
gradle.properties
Normal file
|
|
@ -0,0 +1,49 @@
|
||||||
|
#
|
||||||
|
# STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
# Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
# Licensed under the GNU Affero General Public License v3
|
||||||
|
#
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero General Public License as
|
||||||
|
# published by the Free Software Foundation, either version 3 of the
|
||||||
|
# License, or (at your option) any later version.
|
||||||
|
#
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU Affero General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
#
|
||||||
|
|
||||||
|
# Versioning
|
||||||
|
versioningCodename=Sugarcane
|
||||||
|
versioningVersion=1
|
||||||
|
versioningType=alpha
|
||||||
|
versioningTyperelease=0
|
||||||
|
versioningFork=
|
||||||
|
|
||||||
|
# Java
|
||||||
|
javaSource=22
|
||||||
|
javaTarget=21
|
||||||
|
|
||||||
|
# Minecraft
|
||||||
|
minecraftMajor=1.21
|
||||||
|
minecraftMinor=.1
|
||||||
|
paperSnapshot=R0.1
|
||||||
|
|
||||||
|
# Plugins
|
||||||
|
pluginShadow=8.1.7
|
||||||
|
pluginLombok=8.6
|
||||||
|
pluginGitProperties=2.4.2
|
||||||
|
pluginRunTask=2.3.1
|
||||||
|
|
||||||
|
# Dependencies
|
||||||
|
dependencyLombok=1.18.32
|
||||||
|
dependencyJetbrainsAnnotations=24.1.0
|
||||||
|
dependencyStarOpenSourceEngine=1-alpha4
|
||||||
|
dependencyAdventure=4.17.0
|
||||||
|
|
||||||
|
# etc
|
||||||
|
group = de.staropensource.sosengine
|
||||||
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Normal file
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Normal file
Binary file not shown.
7
gradle/wrapper/gradle-wrapper.properties
vendored
Normal file
7
gradle/wrapper/gradle-wrapper.properties
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
distributionBase=GRADLE_USER_HOME
|
||||||
|
distributionPath=wrapper/dists
|
||||||
|
distributionUrl=https\://services.gradle.org/distributions/gradle-8.10-bin.zip
|
||||||
|
networkTimeout=10000
|
||||||
|
validateDistributionUrl=true
|
||||||
|
zipStoreBase=GRADLE_USER_HOME
|
||||||
|
zipStorePath=wrapper/dists
|
||||||
252
gradlew
vendored
Executable file
252
gradlew
vendored
Executable file
|
|
@ -0,0 +1,252 @@
|
||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
#
|
||||||
|
# Copyright © 2015-2021 the original authors.
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
#
|
||||||
|
|
||||||
|
##############################################################################
|
||||||
|
#
|
||||||
|
# Gradle start up script for POSIX generated by Gradle.
|
||||||
|
#
|
||||||
|
# Important for running:
|
||||||
|
#
|
||||||
|
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
|
||||||
|
# noncompliant, but you have some other compliant shell such as ksh or
|
||||||
|
# bash, then to run this script, type that shell name before the whole
|
||||||
|
# command line, like:
|
||||||
|
#
|
||||||
|
# ksh Gradle
|
||||||
|
#
|
||||||
|
# Busybox and similar reduced shells will NOT work, because this script
|
||||||
|
# requires all of these POSIX shell features:
|
||||||
|
# * functions;
|
||||||
|
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
|
||||||
|
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
|
||||||
|
# * compound commands having a testable exit status, especially «case»;
|
||||||
|
# * various built-in commands including «command», «set», and «ulimit».
|
||||||
|
#
|
||||||
|
# Important for patching:
|
||||||
|
#
|
||||||
|
# (2) This script targets any POSIX shell, so it avoids extensions provided
|
||||||
|
# by Bash, Ksh, etc; in particular arrays are avoided.
|
||||||
|
#
|
||||||
|
# The "traditional" practice of packing multiple parameters into a
|
||||||
|
# space-separated string is a well documented source of bugs and security
|
||||||
|
# problems, so this is (mostly) avoided, by progressively accumulating
|
||||||
|
# options in "$@", and eventually passing that to Java.
|
||||||
|
#
|
||||||
|
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
|
||||||
|
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
|
||||||
|
# see the in-line comments for details.
|
||||||
|
#
|
||||||
|
# There are tweaks for specific operating systems such as AIX, CygWin,
|
||||||
|
# Darwin, MinGW, and NonStop.
|
||||||
|
#
|
||||||
|
# (3) This script is generated from the Groovy template
|
||||||
|
# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
|
||||||
|
# within the Gradle project.
|
||||||
|
#
|
||||||
|
# You can find Gradle at https://github.com/gradle/gradle/.
|
||||||
|
#
|
||||||
|
##############################################################################
|
||||||
|
|
||||||
|
# Attempt to set APP_HOME
|
||||||
|
|
||||||
|
# Resolve links: $0 may be a link
|
||||||
|
app_path=$0
|
||||||
|
|
||||||
|
# Need this for daisy-chained symlinks.
|
||||||
|
while
|
||||||
|
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
|
||||||
|
[ -h "$app_path" ]
|
||||||
|
do
|
||||||
|
ls=$( ls -ld "$app_path" )
|
||||||
|
link=${ls#*' -> '}
|
||||||
|
case $link in #(
|
||||||
|
/*) app_path=$link ;; #(
|
||||||
|
*) app_path=$APP_HOME$link ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
# This is normally unused
|
||||||
|
# shellcheck disable=SC2034
|
||||||
|
APP_BASE_NAME=${0##*/}
|
||||||
|
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
|
||||||
|
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
|
||||||
|
' "$PWD" ) || exit
|
||||||
|
|
||||||
|
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||||
|
MAX_FD=maximum
|
||||||
|
|
||||||
|
warn () {
|
||||||
|
echo "$*"
|
||||||
|
} >&2
|
||||||
|
|
||||||
|
die () {
|
||||||
|
echo
|
||||||
|
echo "$*"
|
||||||
|
echo
|
||||||
|
exit 1
|
||||||
|
} >&2
|
||||||
|
|
||||||
|
# OS specific support (must be 'true' or 'false').
|
||||||
|
cygwin=false
|
||||||
|
msys=false
|
||||||
|
darwin=false
|
||||||
|
nonstop=false
|
||||||
|
case "$( uname )" in #(
|
||||||
|
CYGWIN* ) cygwin=true ;; #(
|
||||||
|
Darwin* ) darwin=true ;; #(
|
||||||
|
MSYS* | MINGW* ) msys=true ;; #(
|
||||||
|
NONSTOP* ) nonstop=true ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||||
|
|
||||||
|
|
||||||
|
# Determine the Java command to use to start the JVM.
|
||||||
|
if [ -n "$JAVA_HOME" ] ; then
|
||||||
|
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
||||||
|
# IBM's JDK on AIX uses strange locations for the executables
|
||||||
|
JAVACMD=$JAVA_HOME/jre/sh/java
|
||||||
|
else
|
||||||
|
JAVACMD=$JAVA_HOME/bin/java
|
||||||
|
fi
|
||||||
|
if [ ! -x "$JAVACMD" ] ; then
|
||||||
|
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
JAVACMD=java
|
||||||
|
if ! command -v java >/dev/null 2>&1
|
||||||
|
then
|
||||||
|
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Increase the maximum file descriptors if we can.
|
||||||
|
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
|
||||||
|
case $MAX_FD in #(
|
||||||
|
max*)
|
||||||
|
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
|
||||||
|
# shellcheck disable=SC2039,SC3045
|
||||||
|
MAX_FD=$( ulimit -H -n ) ||
|
||||||
|
warn "Could not query maximum file descriptor limit"
|
||||||
|
esac
|
||||||
|
case $MAX_FD in #(
|
||||||
|
'' | soft) :;; #(
|
||||||
|
*)
|
||||||
|
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
|
||||||
|
# shellcheck disable=SC2039,SC3045
|
||||||
|
ulimit -n "$MAX_FD" ||
|
||||||
|
warn "Could not set maximum file descriptor limit to $MAX_FD"
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Collect all arguments for the java command, stacking in reverse order:
|
||||||
|
# * args from the command line
|
||||||
|
# * the main class name
|
||||||
|
# * -classpath
|
||||||
|
# * -D...appname settings
|
||||||
|
# * --module-path (only if needed)
|
||||||
|
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
|
||||||
|
|
||||||
|
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||||
|
if "$cygwin" || "$msys" ; then
|
||||||
|
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
|
||||||
|
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
|
||||||
|
|
||||||
|
JAVACMD=$( cygpath --unix "$JAVACMD" )
|
||||||
|
|
||||||
|
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||||
|
for arg do
|
||||||
|
if
|
||||||
|
case $arg in #(
|
||||||
|
-*) false ;; # don't mess with options #(
|
||||||
|
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
|
||||||
|
[ -e "$t" ] ;; #(
|
||||||
|
*) false ;;
|
||||||
|
esac
|
||||||
|
then
|
||||||
|
arg=$( cygpath --path --ignore --mixed "$arg" )
|
||||||
|
fi
|
||||||
|
# Roll the args list around exactly as many times as the number of
|
||||||
|
# args, so each arg winds up back in the position where it started, but
|
||||||
|
# possibly modified.
|
||||||
|
#
|
||||||
|
# NB: a `for` loop captures its iteration list before it begins, so
|
||||||
|
# changing the positional parameters here affects neither the number of
|
||||||
|
# iterations, nor the values presented in `arg`.
|
||||||
|
shift # remove old arg
|
||||||
|
set -- "$@" "$arg" # push replacement arg
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||||
|
|
||||||
|
# Collect all arguments for the java command:
|
||||||
|
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
|
||||||
|
# and any embedded shellness will be escaped.
|
||||||
|
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
|
||||||
|
# treated as '${Hostname}' itself on the command line.
|
||||||
|
|
||||||
|
set -- \
|
||||||
|
"-Dorg.gradle.appname=$APP_BASE_NAME" \
|
||||||
|
-classpath "$CLASSPATH" \
|
||||||
|
org.gradle.wrapper.GradleWrapperMain \
|
||||||
|
"$@"
|
||||||
|
|
||||||
|
# Stop when "xargs" is not available.
|
||||||
|
if ! command -v xargs >/dev/null 2>&1
|
||||||
|
then
|
||||||
|
die "xargs is not available"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Use "xargs" to parse quoted args.
|
||||||
|
#
|
||||||
|
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
|
||||||
|
#
|
||||||
|
# In Bash we could simply go:
|
||||||
|
#
|
||||||
|
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
|
||||||
|
# set -- "${ARGS[@]}" "$@"
|
||||||
|
#
|
||||||
|
# but POSIX shell has neither arrays nor command substitution, so instead we
|
||||||
|
# post-process each arg (as a line of input to sed) to backslash-escape any
|
||||||
|
# character that might be a shell metacharacter, then use eval to reverse
|
||||||
|
# that process (while maintaining the separation between arguments), and wrap
|
||||||
|
# the whole thing up as a single "set" statement.
|
||||||
|
#
|
||||||
|
# This will of course break if any of these variables contains a newline or
|
||||||
|
# an unmatched quote.
|
||||||
|
#
|
||||||
|
|
||||||
|
eval "set -- $(
|
||||||
|
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
|
||||||
|
xargs -n1 |
|
||||||
|
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
|
||||||
|
tr '\n' ' '
|
||||||
|
)" '"$@"'
|
||||||
|
|
||||||
|
exec "$JAVACMD" "$@"
|
||||||
94
gradlew.bat
vendored
Normal file
94
gradlew.bat
vendored
Normal file
|
|
@ -0,0 +1,94 @@
|
||||||
|
@rem
|
||||||
|
@rem Copyright 2015 the original author or authors.
|
||||||
|
@rem
|
||||||
|
@rem Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
@rem you may not use this file except in compliance with the License.
|
||||||
|
@rem You may obtain a copy of the License at
|
||||||
|
@rem
|
||||||
|
@rem https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
@rem
|
||||||
|
@rem Unless required by applicable law or agreed to in writing, software
|
||||||
|
@rem distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
@rem See the License for the specific language governing permissions and
|
||||||
|
@rem limitations under the License.
|
||||||
|
@rem
|
||||||
|
@rem SPDX-License-Identifier: Apache-2.0
|
||||||
|
@rem
|
||||||
|
|
||||||
|
@if "%DEBUG%"=="" @echo off
|
||||||
|
@rem ##########################################################################
|
||||||
|
@rem
|
||||||
|
@rem Gradle startup script for Windows
|
||||||
|
@rem
|
||||||
|
@rem ##########################################################################
|
||||||
|
|
||||||
|
@rem Set local scope for the variables with windows NT shell
|
||||||
|
if "%OS%"=="Windows_NT" setlocal
|
||||||
|
|
||||||
|
set DIRNAME=%~dp0
|
||||||
|
if "%DIRNAME%"=="" set DIRNAME=.
|
||||||
|
@rem This is normally unused
|
||||||
|
set APP_BASE_NAME=%~n0
|
||||||
|
set APP_HOME=%DIRNAME%
|
||||||
|
|
||||||
|
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
|
||||||
|
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
|
||||||
|
|
||||||
|
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
|
||||||
|
|
||||||
|
@rem Find java.exe
|
||||||
|
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||||
|
|
||||||
|
set JAVA_EXE=java.exe
|
||||||
|
%JAVA_EXE% -version >NUL 2>&1
|
||||||
|
if %ERRORLEVEL% equ 0 goto execute
|
||||||
|
|
||||||
|
echo. 1>&2
|
||||||
|
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
|
||||||
|
echo. 1>&2
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
|
||||||
|
echo location of your Java installation. 1>&2
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:findJavaFromJavaHome
|
||||||
|
set JAVA_HOME=%JAVA_HOME:"=%
|
||||||
|
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
||||||
|
|
||||||
|
if exist "%JAVA_EXE%" goto execute
|
||||||
|
|
||||||
|
echo. 1>&2
|
||||||
|
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
|
||||||
|
echo. 1>&2
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
|
||||||
|
echo location of your Java installation. 1>&2
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:execute
|
||||||
|
@rem Setup the command line
|
||||||
|
|
||||||
|
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||||
|
|
||||||
|
|
||||||
|
@rem Execute Gradle
|
||||||
|
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
|
||||||
|
|
||||||
|
:end
|
||||||
|
@rem End local scope for the variables with windows NT shell
|
||||||
|
if %ERRORLEVEL% equ 0 goto mainEnd
|
||||||
|
|
||||||
|
:fail
|
||||||
|
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
||||||
|
rem the _cmd.exe /c_ return code!
|
||||||
|
set EXIT_CODE=%ERRORLEVEL%
|
||||||
|
if %EXIT_CODE% equ 0 set EXIT_CODE=1
|
||||||
|
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
|
||||||
|
exit /b %EXIT_CODE%
|
||||||
|
|
||||||
|
:mainEnd
|
||||||
|
if "%OS%"=="Windows_NT" endlocal
|
||||||
|
|
||||||
|
:omega
|
||||||
146
platform-bukkit/build.gradle
Normal file
146
platform-bukkit/build.gradle
Normal file
|
|
@ -0,0 +1,146 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Plugins
|
||||||
|
plugins {
|
||||||
|
id("java")
|
||||||
|
id("io.freefair.lombok") version("${pluginLombok}")
|
||||||
|
id("io.github.goooler.shadow") version("${pluginShadow}")
|
||||||
|
id("xyz.jpenilla.run-paper") version("${pluginRunTask}")
|
||||||
|
id("maven-publish")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Project dependencies
|
||||||
|
dependencies {
|
||||||
|
// Lombok
|
||||||
|
compileOnly("org.projectlombok:lombok:${dependencyLombok}")
|
||||||
|
annotationProcessor("org.projectlombok:lombok:${dependencyLombok}")
|
||||||
|
|
||||||
|
// JetBrains Annotations
|
||||||
|
compileOnly("org.jetbrains:annotations:${dependencyJetbrainsAnnotations}")
|
||||||
|
|
||||||
|
// StarOpenSource Engine
|
||||||
|
implementation("de.staropensource.sosengine:base:${dependencyStarOpenSourceEngine}")
|
||||||
|
|
||||||
|
// PaperMC
|
||||||
|
compileOnly("io.papermc.paper:paper-api:${minecraftMajor}${minecraftMinor}-${paperSnapshot}-SNAPSHOT")
|
||||||
|
|
||||||
|
// Project
|
||||||
|
implementation(project(":common"))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update plugin.yml
|
||||||
|
processResources {
|
||||||
|
filesMatching("plugin.yml") {
|
||||||
|
expand project.properties
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fix delombok task
|
||||||
|
delombok.doFirst {
|
||||||
|
File target = file("${project.projectDir}/src/main/module-info.java")
|
||||||
|
File source = file("${project.projectDir}/src/main/java/module-info.java")
|
||||||
|
|
||||||
|
target.delete()
|
||||||
|
source.renameTo(target)
|
||||||
|
}
|
||||||
|
delombok.doLast {
|
||||||
|
File target = file("${project.projectDir}/src/main/java/module-info.java")
|
||||||
|
File source = file("${project.projectDir}/src/main/module-info.java")
|
||||||
|
|
||||||
|
target.delete()
|
||||||
|
source.renameTo(target)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Javadoc configuration
|
||||||
|
javadoc {
|
||||||
|
outputs.upToDateWhen { false } // Force task execution
|
||||||
|
dependsOn(delombok) // Make sure the source is delomboked first
|
||||||
|
|
||||||
|
javadoc {
|
||||||
|
setClasspath(files(project.sourceSets.main.compileClasspath)) // Include dependencies
|
||||||
|
|
||||||
|
options {
|
||||||
|
if (new File(projectDir, "src/main/javadoc/theme.css").exists())
|
||||||
|
stylesheetFile = new File(projectDir, "src/main/javadoc/theme.css") // Theming is cool :3
|
||||||
|
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
|
||||||
|
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
|
||||||
|
setLocale("en_US") // 你好
|
||||||
|
addStringOption("Xwerror", "-quiet") // Fail build on warning
|
||||||
|
|
||||||
|
setJFlags([
|
||||||
|
"-Duser.language=en_US" // See above
|
||||||
|
])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Configure run-task plugin
|
||||||
|
runServer {
|
||||||
|
// Set minecraft version
|
||||||
|
minecraftVersion("${minecraftMajor}${minecraftMinor}")
|
||||||
|
|
||||||
|
// Enforce UTF-8 encoding
|
||||||
|
systemProperty("file.encoding", "UTF-8")
|
||||||
|
|
||||||
|
// Agree to EULA
|
||||||
|
systemProperty("com.mojang.eula.agree", "true")
|
||||||
|
|
||||||
|
doFirst {
|
||||||
|
// Disable bStats
|
||||||
|
File config = new File(runDirectory.get().getAsFile().getPath() + "/plugins/bStats/config.yml")
|
||||||
|
if (!config.exists()) {
|
||||||
|
config.getParentFile().mkdirs()
|
||||||
|
config.createNewFile()
|
||||||
|
config.write("enabled: false\n")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Include javadoc and source jar during publishing
|
||||||
|
java {
|
||||||
|
withJavadocJar()
|
||||||
|
withSourcesJar()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build publishing configuration
|
||||||
|
// Note: You can safely ignore any errors or warnings thrown by your IDE here
|
||||||
|
publishing {
|
||||||
|
repositories {
|
||||||
|
maven {
|
||||||
|
name = "staropensource"
|
||||||
|
url = uri("https://mvn.staropensource.de/sosengine")
|
||||||
|
credentials(org.gradle.api.credentials.PasswordCredentials)
|
||||||
|
authentication {
|
||||||
|
//noinspection GroovyAssignabilityCheck
|
||||||
|
basic (BasicAuthentication)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
publications {
|
||||||
|
//noinspection GroovyAssignabilityCheck
|
||||||
|
maven (MavenPublication) {
|
||||||
|
groupId = group
|
||||||
|
artifactId = project.getName()
|
||||||
|
version = version
|
||||||
|
//noinspection GroovyAssignabilityCheck
|
||||||
|
from components.java
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
1
platform-bukkit/gradle
Symbolic link
1
platform-bukkit/gradle
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../gradle
|
||||||
1
platform-bukkit/gradlew
vendored
Symbolic link
1
platform-bukkit/gradlew
vendored
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../gradlew
|
||||||
1
platform-bukkit/gradlew.bat
vendored
Symbolic link
1
platform-bukkit/gradlew.bat
vendored
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../gradlew.bat
|
||||||
|
|
@ -0,0 +1,65 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.sosengine.minecraft.bukkit;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.EngineConfiguration;
|
||||||
|
import de.staropensource.sosengine.base.implementable.LoggingAdapter;
|
||||||
|
import de.staropensource.sosengine.base.implementation.shortcode.EmptyShortcodeConverter;
|
||||||
|
import de.staropensource.sosengine.base.type.logging.LogLevel;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
import org.jetbrains.annotations.Nullable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A {@link LoggingAdapter} for the Bukkit API.
|
||||||
|
*/
|
||||||
|
public class BukkitLoggingAdapter implements LoggingAdapter {
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @Nullable String prePlaceholder(@NotNull LogLevel level, @NotNull Class<?> issuerClass, @NotNull String issuerOrigin, @Nullable String issuerMetadata, @NotNull String message, @NotNull String format) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public @NotNull String postPlaceholder(@NotNull LogLevel level, @NotNull Class<?> issuerClass, @NotNull String issuerOrigin, @Nullable String issuerMetadata, @NotNull String message, @NotNull String format) {
|
||||||
|
return format;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public void print(@NotNull LogLevel level, @NotNull Class<?> issuerClass, @NotNull String issuerOrigin, @Nullable String issuerMetadata, @NotNull String message, @NotNull String format) {
|
||||||
|
// Remove any tags
|
||||||
|
format = new EmptyShortcodeConverter(format, true).getClean();
|
||||||
|
|
||||||
|
// Fix newlines
|
||||||
|
if (EngineConfiguration.getInstance().isLoggerEnableNewlineSupport()) {
|
||||||
|
String spaces = " ";
|
||||||
|
if (level == LogLevel.ERROR || level == LogLevel.CRASH)
|
||||||
|
spaces += " ";
|
||||||
|
|
||||||
|
format = format.replace("\n", "\n" + spaces);
|
||||||
|
}
|
||||||
|
|
||||||
|
switch (level) {
|
||||||
|
case DIAGNOSTIC, VERBOSE, SILENT_WARNING, INFORMATIONAL, WARNING -> PlatformInitializer.getInstance().getLogger().info(format);
|
||||||
|
case ERROR, CRASH -> PlatformInitializer.getInstance().getLogger().severe(format);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,166 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.sosengine.minecraft.bukkit;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.base.Engine;
|
||||||
|
import de.staropensource.sosengine.base.logging.Logger;
|
||||||
|
import de.staropensource.sosengine.base.logging.LoggerInstance;
|
||||||
|
import de.staropensource.sosengine.minecraft.EngineBootstrapper;
|
||||||
|
import de.staropensource.sosengine.minecraft.bukkit.command.BukkitCommand;
|
||||||
|
import lombok.Getter;
|
||||||
|
import net.kyori.adventure.text.minimessage.MiniMessage;
|
||||||
|
import org.bukkit.Bukkit;
|
||||||
|
import org.bukkit.World;
|
||||||
|
import org.bukkit.command.PluginCommand;
|
||||||
|
import org.bukkit.entity.Player;
|
||||||
|
import org.bukkit.plugin.java.JavaPlugin;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
import java.util.Objects;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes the Bukkit API engine port.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@SuppressWarnings({ "JavadocDeclaration" })
|
||||||
|
public final class PlatformInitializer extends JavaPlugin {
|
||||||
|
/**
|
||||||
|
* Contains the class instance.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
* -- GETTER --
|
||||||
|
* Returns the class instance.
|
||||||
|
*
|
||||||
|
* @return class instance
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Getter
|
||||||
|
private static PlatformInitializer instance;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains the {@link LoggerInstance} for this instance.
|
||||||
|
*
|
||||||
|
* @see LoggerInstance
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private static final @NotNull LoggerInstance logger = new LoggerInstance.Builder().setClazz(PlatformInitializer.class).setOrigin("ENGINEMC").build();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructs this class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public PlatformInitializer() {
|
||||||
|
if (instance == null)
|
||||||
|
instance = this;
|
||||||
|
else {
|
||||||
|
instance.getLogger().severe("The EngineMC Bukkit port has been initialized already, shutting down server");
|
||||||
|
Bukkit.shutdown();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes the plugin.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public void onLoad() {
|
||||||
|
EngineBootstrapper.initialize(
|
||||||
|
true,
|
||||||
|
exitcode -> {
|
||||||
|
if (Bukkit.getWorlds().isEmpty()) {
|
||||||
|
logger.info("No worlds are loaded, halting JVM");
|
||||||
|
Runtime.getRuntime().halt(exitcode);
|
||||||
|
} else
|
||||||
|
if (!Bukkit.isStopping())
|
||||||
|
Bukkit.shutdown();
|
||||||
|
},
|
||||||
|
new BukkitLoggingAdapter()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enables the plugin.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public void onEnable() {
|
||||||
|
// Register /enginemc command
|
||||||
|
try {
|
||||||
|
PluginCommand command = Objects.requireNonNull(Bukkit.getPluginCommand("enginemc"));
|
||||||
|
command.setExecutor(new BukkitCommand());
|
||||||
|
} catch (NullPointerException exception) {
|
||||||
|
logger.crash("Failed to register the /enginemc command", exception);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disables the plugin.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public void onDisable() {
|
||||||
|
if (!Bukkit.isStopping()) {
|
||||||
|
// Server is reloading, print warning and shutdown server
|
||||||
|
logger.error("""
|
||||||
|
__ ___ _ _ _____ _ ____ _____ __ _____ _ _ ____ ___ ___ _ _ ____ ___ ___
|
||||||
|
\\ \\ / / | | | / \\|_ _| / \\ | _ \\| ____| \\ \\ / / _ \\| | | | | _ \\ / _ \\_ _| \\ | |/ ___|__ \\__ \\
|
||||||
|
\\ \\ /\\ / /| |_| | / _ \\ | | / _ \\ | |_) | _| \\ V / | | | | | | | | | | | | | || \\| | | _ / / / /
|
||||||
|
\\ V V / | _ |/ ___ \\| | / ___ \\| _ <| |___ | || |_| | |_| | | |_| | |_| | || |\\ | |_| ||_| |_|
|
||||||
|
\\_/\\_/ |_| |_/_/ \\_\\_| /_/ \\_\\_| \\_\\_____| |_| \\___/ \\___/ |____/ \\___/___|_| \\_|\\____|(_) (_)
|
||||||
|
|
||||||
|
It is veeeeeery likely that you are reloading your server right now. If so, why do
|
||||||
|
you hate yourself? Reloading is known to be unsafe and should be avoided at all costs.
|
||||||
|
Restart your server or use the reload command of your favourite plugin instead.
|
||||||
|
Please take a look at this article for more information: https://madelinemiller.dev/blog/problem-with-reload/
|
||||||
|
|
||||||
|
For safety, EngineMC will now save player and world data and forcefully shutdown your server.
|
||||||
|
""");
|
||||||
|
|
||||||
|
// Save and kick players
|
||||||
|
for (Player player : Bukkit.getOnlinePlayers()) {
|
||||||
|
logger.info("Saving data for player \"" + player.getName() + "\" [" + player.getUniqueId() + "]");
|
||||||
|
player.saveData();
|
||||||
|
if (player.isOp())
|
||||||
|
player.kick(MiniMessage.miniMessage().deserialize("The server has been forcefully shut down as the server has been reloaded,\nwhich is known to be unsafe. Check your server console for more information."));
|
||||||
|
else
|
||||||
|
player.kick(MiniMessage.miniMessage().deserialize("The server encountered an error and has been shut down. Don't worry, your data has been saved."));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Save worlds
|
||||||
|
for (World world : Bukkit.getWorlds()) {
|
||||||
|
logger.info("Saving data for world \"" + world.getName() + "\"");
|
||||||
|
world.save();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Halt JVM
|
||||||
|
logger.info("Halting JVM");
|
||||||
|
Logger.flushLogMessages(); // flush remaining log messages
|
||||||
|
Runtime.getRuntime().halt(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Shutdown engine
|
||||||
|
Engine.getInstance().shutdown();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,39 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.sosengine.minecraft.bukkit.command;
|
||||||
|
|
||||||
|
import de.staropensource.sosengine.minecraft.command.Command;
|
||||||
|
import org.bukkit.command.CommandExecutor;
|
||||||
|
import org.bukkit.command.CommandSender;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A command for interacting with the engine.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public class BukkitCommand implements CommandExecutor {
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public boolean onCommand(@NotNull CommandSender sender, @NotNull org.bukkit.command.Command command, @NotNull String alias, @NotNull String[] arguments) {
|
||||||
|
Command.execute(new BukkitPlayer(sender), arguments);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,56 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package de.staropensource.sosengine.minecraft.bukkit.command;
|
||||||
|
|
||||||
|
import net.kyori.adventure.text.Component;
|
||||||
|
import org.bukkit.command.CommandSender;
|
||||||
|
import org.bukkit.entity.Player;
|
||||||
|
import org.jetbrains.annotations.NotNull;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Bukkit implementation of
|
||||||
|
* EngineMC's {@link Player} class.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public class BukkitPlayer extends de.staropensource.sosengine.minecraft.command.Player {
|
||||||
|
/**
|
||||||
|
* Contains the Bukkit player this instance refers to.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
private final @NotNull CommandSender player;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructs this class.
|
||||||
|
*
|
||||||
|
* @param player player to use
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
public BukkitPlayer(@NotNull CommandSender player) {
|
||||||
|
this.player = player;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public void message(@NotNull Component message) {
|
||||||
|
player.sendMessage(message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The Bukkit API (PaperMC implementation) port
|
||||||
|
* of the StarOpenSource Engine and EngineMC
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
package de.staropensource.sosengine.minecraft.bukkit;
|
||||||
23
platform-bukkit/src/main/java/module-info.java
Normal file
23
platform-bukkit/src/main/java/module-info.java
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
/**
|
||||||
|
* Bukkit (PaperMC implementation) port of the
|
||||||
|
* StarOpenSource Engine and EngineMC.
|
||||||
|
*
|
||||||
|
* @since v1-alpha0
|
||||||
|
*/
|
||||||
|
module sosengine.minecraft.bukkit {
|
||||||
|
// Dependencies
|
||||||
|
requires java.logging;
|
||||||
|
requires sosengine.base;
|
||||||
|
requires sosengine.minecraft;
|
||||||
|
requires org.bukkit;
|
||||||
|
requires net.kyori.adventure;
|
||||||
|
requires net.kyori.examination.api;
|
||||||
|
|
||||||
|
// API access
|
||||||
|
exports de.staropensource.sosengine.minecraft.bukkit;
|
||||||
|
exports de.staropensource.sosengine.minecraft.bukkit.command;
|
||||||
|
|
||||||
|
// Reflection access
|
||||||
|
opens de.staropensource.sosengine.minecraft.bukkit;
|
||||||
|
opens de.staropensource.sosengine.minecraft.bukkit.command;
|
||||||
|
}
|
||||||
22
platform-bukkit/src/main/resources/plugin.yml
Normal file
22
platform-bukkit/src/main/resources/plugin.yml
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
name: "sosenginemc"
|
||||||
|
version: "${version}"
|
||||||
|
main: "de.staropensource.sosengine.minecraft.bukkit.PlatformInitializer"
|
||||||
|
description: "A port of the StarOpenSource Engine to the Bukkit API."
|
||||||
|
authors: [ "The StarOpenSource EngineMC Authors" ]
|
||||||
|
website: "https://git.staropensource.de/StarOpenSource/EngineMC"
|
||||||
|
api-version: "${minecraftMajor}"
|
||||||
|
load: "STARTUP"
|
||||||
|
prefix: "EngineMC"
|
||||||
|
softdepend:
|
||||||
|
- FreedomChat
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
sosenginemc.command:
|
||||||
|
description: "Provides access to the /enginemc command."
|
||||||
|
default: "op"
|
||||||
|
|
||||||
|
commands:
|
||||||
|
enginemc:
|
||||||
|
description: "Allows monitoring and controlling the StarOpenSource Engine."
|
||||||
|
usage: "/enginemc help"
|
||||||
|
permission: "sosenginemc.command"
|
||||||
23
settings.gradle
Normal file
23
settings.gradle
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
/*
|
||||||
|
* STAROPENSOURCE ENGINEMC SOURCE FILE
|
||||||
|
* Copyright (c) 2024 The StarOpenSource EngineMC Authors
|
||||||
|
* Licensed under the GNU Affero General Public License v3
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of the
|
||||||
|
* License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Affero General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
rootProject.setName("sosengine-minecraft")
|
||||||
|
|
||||||
|
include("common")
|
||||||
|
include("platform-bukkit")
|
||||||
Loading…
Reference in a new issue