Skip to content
Snippets Groups Projects
Verified Commit 4068705d authored by Griefed's avatar Griefed :joystick:
Browse files

no message

parent dbd0f5fc
No related branches found
No related tags found
No related merge requests found
......@@ -5,7 +5,7 @@ plugins {
id 'idea'
}
group 'de.griefed.serverpackcreatorexampleaddon'
group 'de.griefed'
//noinspection GroovyUnusedAssignment
sourceCompatibility = targetCompatibility = '1.8'
......@@ -35,10 +35,6 @@ sourceSets {
repositories {
mavenCentral()
maven { url "https://jitpack.io" }
maven { url 'https://repo.spring.io/release' }
/* If using GitLab.com fails, use git.griefed.de for package retrieval */ //maven { url 'https://git.griefed.de/api/v4/projects/63/packages/maven' }
maven { url 'https://gitlab.com/api/v4/projects/32677538/packages/maven' }
}
configurations {
......@@ -47,19 +43,17 @@ configurations {
}
dependencies {
// Dependencies required for any plugin and/or extension to work
implementation 'org.pf4j:pf4j:3.6.0'
annotationProcessor 'org.pf4j:pf4j:3.6.0'
implementation 'de.griefed:serverpackcreator:3.0.0-alpha.19'
embed 'commons-io:commons-io:2.11.0'
embed 'org.apache.commons:commons-lang3:3.12.0'
// Required if you want to log to any of ServerPackCreators logs
implementation 'org.apache.logging.log4j:log4j-api:2.17.1'
/*
* You may need to refresh this dependency every now and then
* Check https://gitlab.com/Griefed/ServerPackCreator/-/packages/4830254 occasionally
*/
implementation 'de.griefed.serverpackcreator:serverpackcreator:3.0.0-alpha.19'
// Dependencies your plugin or extension requires and need to be shipped within the plugin#s JAR-file
embed 'commons-io:commons-io:2.11.0'
embed 'org.apache.commons:commons-lang3:3.12.0'
// Testing
testImplementation 'org.mockito:mockito-core:4.3.1'
......
rootProject.name = 'serverpackcreatorexampleaddon'
//rootProject.name = 'serverpackcreatorexampleaddon'
......@@ -72,6 +72,14 @@ Additionally, the following files/directories would be created in the server pac
- `serverpackcreator.conf` as it was used to generate the server pack
- `./some/folder/with/a/name`
| Example at boot time | Example after generation finished |
|----------------------------|-----------------------------------|
| ![boot](img/boot.png) | ![preGen](img/afterGen.png) |
**Example tab**
![tab](img/exampleTab.png)
# 1. The reason for allowing ServerPackCreator to run addons:
Some people need additional functionality for their server packs, or have some additional wishes for them. Some of those
......@@ -89,21 +97,25 @@ Some examples for addons can be found [in this discussion thread](https://github
Some excerpts:
1. Changelog generator, by @TheButterbrotMan at [Feature request]: Changelog generator #198
- A changelog generator that checks the differences to the previous version and generates a changelog.
- A changelog generator that checks the differences to the previous version and generates a changelog.
2. Bundle Adoptium Java with server packs, by @kreezxil at [Feature request]: Bundle Adoptium Java #199
- Because modpacks need one of the either Java 8, 16, or 17, it would be nice to have the corresponding https://adoptium.net java prebundled with the server pack.
- Because modpacks need one of the either Java 8, 16, or 17, it would be nice to have the corresponding https://adoptium.net java prebundled with the server pack.
3. Automatic setup of a server pack for [BlueMap](https://www.curseforge.com/minecraft/mc-mods/bluemap)
- Check all mods in the specified modpacks mods-directory for textures, and if any are found, add the mod to
BlueMap's resourcepack folder `config/bluemap/resourcepacks`, install BlueMap for the specified Minecraft and Forge/Fabric
version and voilà!
- Check all mods in the specified modpacks mods-directory for textures, and if any are found, add the mod to
BlueMap's resourcepack folder `config/bluemap/resourcepacks`, install BlueMap for the specified Minecraft and Forge/Fabric
version and voilà!
# 2. How
During the start of ServerPackCreator, all plugins are loaded and started. If you have anything you need to run then and there,
use `public void start() {...}` and do your thing.
For documentation about Pf4j, visit https://pf4j.org/
If you have ideas and/or suggestions for improvements to the addon-system in ServerPackCreator, open an improvement-issue over at the ServerPackCreator [issues page](https://github.com/Griefed/ServerPackCreator/issues/new?assignees=Griefed&labels=enhancement&template=improvement.yml&title=%5BImprovement+request%5D%3A+)
## 2.1 Extensions
One plugin can have multiple extensions.
......@@ -136,6 +148,8 @@ along with a small description, if you provided one.
Example:
| Addon | Creator | Description |
|:-------------------------------------------------------------------------|:--------|:-------------------------------------------------------------------|
| [ExampleAddon](https://github.com/Griefed/ServerPackCreatorExampleAddon) | Griefed | An example addon providing a starting point for addon development. |
\ No newline at end of file
| Addon | Creator | Description |
|:------------------------------------------------------------------------------------------------------------------------------------------------|:--------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [ExampleAddon](https://github.com/Griefed/ServerPackCreatorExampleAddon) | Griefed | An example addon providing a starting point for addon development. |
| [ExampleAddon Alternative Extension Declaration](https://github.com/Griefed/ServerPackCreatorExampleAddon/tree/alternativeExtensionDeclaration) | Griefed | An example addon providing a starting point for addon development. This addon provides an example for a different way of declaring extensions as well as reading entries from the plugins manifest. |
| [Example MiniGame](https://github.com/Griefed/ServerPackCreatorExampleAddon/tree/tetris) | Griefed | Play Tetris in a new window whilst your server packs generate! |
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment