### Configure Java Installation Templates Source: https://help.serverpackcreator.de/scripts.html Properties used to define the paths for Java installation templates in different script formats. ```properties de.griefed.serverpackcreator.serverpack.java.template.bat=... de.griefed.serverpackcreator.serverpack.java.template.ps1=... de.griefed.serverpackcreator.serverpack.java.template.sh=... ``` -------------------------------- ### GET /api/v2/runconfigs/all Source: https://help.serverpackcreator.de/run-configs.html Retrieves a list of all available run configurations. ```APIDOC ## GET /api/v2/runconfigs/all ### Description Retrieves a list of all available run configurations. ### Method GET ### Endpoint /api/v2/runconfigs/all ``` -------------------------------- ### GET /api/v2/serverpacks/all Source: https://help.serverpackcreator.de/server-packs.html Retrieves a list of all available server packs. ```APIDOC ## GET /api/v2/serverpacks/all ### Description Retrieves a list of all available server packs. ### Method GET ### Endpoint /api/v2/serverpacks/all ### Response #### Success Response (200) - **Array of ServerPackView** (array) - A list of server pack objects. ``` -------------------------------- ### List all modpacks Source: https://help.serverpackcreator.de/modpacks.html Example JSON response structure when retrieving all available modpacks. ```json [ { "source": "ZIP", "name": "TNP Limitless 6 - LL6 - Custom.zip", "id": 2, "size": 931.0, "status": "GENERATING", "serverPacks": [], "sha256": "b32c0a93a5965a4ad9da08c2b0f66550abe62b2fc3c25c915df13d8bf0adb267", "versionID": "", "dateCreated": 1707588044832, "projectID": "" }, { "source": "ZIP", "name": "Survive Create Prosper 4.zip", "id": 1, "size": 489.0, "status": "GENERATED", "serverPacks": [ { "id": 1, "size": 353, "downloads": 2, "confirmedWorking": 0, "dateCreated": 1707166386123, "fileID": 1707166382296, "sha256": "7b1883b25771c9c5699cee05036e37dc6418613634283fc1f012ff5109cba42b", "runConfiguration": { "id": 1, "minecraftVersion": "1.16.5", "modloader": "Forge", "modloaderVersion": "36.2.39", "startArgs": [ { "id": 1, "argument": "-Xms4G" }, { ... }, { "id": 22, "argument": "-Daikars.new.flags=true" } ], "clientMods": [ { "id": 1, "mod": "3dskinlayers-" }, { ... }, { "id": 310, "mod": "yisthereautojump-" } ], "whitelistedMods": [ { "id": 1, "mod": "Ping-Wheel-" } ] } } ], "sha256": "54c60e2cc5655eb81e007b12fde1030ed1efd74caa2f965008beff298b787931", "versionID": "", "dateCreated": 1707165869942, "projectID": "" } ] ``` -------------------------------- ### List All Server Packs Response Source: https://help.serverpackcreator.de/server-packs.html Example JSON response containing an array of server pack objects. ```json [ { "id": 1, "size": 353.0, "runConfiguration": { "id": 1, "minecraftVersion": "1.16.5", "modloader": "Forge", "modloaderVersion": "36.2.39", "startArgs": [ { "id": 1, "argument": "-Xms4G" }, { ... }, { "id": 22, "argument": "-Daikars.new.flags=true" } ], "clientMods": [ { "id": 1, "mod": "3dskinlayers-" }, { ... }, { "id": 310, "mod": "yisthereautojump-" } ], "whitelistedMods": [ { "id": 1, "mod": "Ping-Wheel-" } ] }, "confirmedWorking": 0, "sha256": "7b1883b25771c9c5699cee05036e37dc6418613634283fc1f012ff5109cba42b", "downloads": 2, "dateCreated": 1707166386123 } ] ``` -------------------------------- ### Run Configuration Response Schema Source: https://help.serverpackcreator.de/run-configs.html Example JSON response structure for a successful run configuration retrieval. ```json { "id": 1, "minecraftVersion": "1.16.5", "modloader": "Forge", "modloaderVersion": "36.2.39", "startArgs": [ { "id": 1, "argument": "-Xms4G" }, { ... }, { "id": 22, "argument": "-Daikars.new.flags=true" } ], "clientMods": [ { "id": 1, "mod": "3dskinlayers-" }, { ... }, { "id": 310, "mod": "yisthereautojump-" } ], "whitelistedMods": [ { "id": 1, "mod": "Ping-Wheel-" } ] } ``` -------------------------------- ### GET /api/v2/modpacks/all Source: https://help.serverpackcreator.de/modpacks.html Retrieves a list of all available modpacks. ```APIDOC ## GET /api/v2/modpacks/all ### Description Retrieves a list of all modpacks currently available in the system. ### Method GET ### Endpoint /api/v2/modpacks/all ### Response #### Success Response (200) - **ModPackView** (Array) - A list of modpack objects. #### Response Example [ { "source": "ZIP", "name": "TNP Limitless 6 - LL6 - Custom.zip", "id": 2, "size": 931.0, "status": "GENERATING", "serverPacks": [], "sha256": "b32c0a93a5965a4ad9da08c2b0f66550abe62b2fc3c25c915df13d8bf0adb267", "versionID": "", "dateCreated": 1707588044832, "projectID": "" } ] ``` -------------------------------- ### Configure File Inclusions Source: https://help.serverpackcreator.de/settings-and-configs.html Examples for specifying files and directories to include in the server pack, supporting both relative paths within the modpack and absolute paths. ```toml [[inclusions]] destination = "" exclusionFilter = "config/bluemap/.*" source = "config" inclusionFilter = "" [[inclusions]] destination = "" exclusionFilter = "" source = "mods" inclusionFilter = "" [[inclusions]] destination = "SomeFiles" exclusionFilter = "" source = "C:\Some\Path\With\Files" inclusionFilter = "" [[inclusions]] destination = "somefiles" exclusionFilter = "" source = "/home/myuser/some/files" inclusionFilter = "" [[inclusions]] destination = "MyInstructions.md" exclusionFilter = "" source = "C:\MyAwesomeModpack\Stuff\HowTo.md" inclusionFilter = "" [[inclusions]] destination = "MyInstructions.md" exclusionFilter = "" source ="/home/myuser/my_awesome_modpack/HOWTO.md" inclusionFilter = "" ``` -------------------------------- ### Include FancyMenu in Server Pack Source: https://help.serverpackcreator.de/special-mods.html Example entry for the file/directories configuration to include a specific version of the FancyMenu mod. ```text mods/fancymenu_forge_2.12.1_MC_1.19-1.19.1.jar;mods/fancymenu_forge_2.12.1_MC_1.19-1.19.1.jar ``` -------------------------------- ### GET /api/v2/serverpacks/download/{id} Source: https://help.serverpackcreator.de/server-packs.html Downloads a server pack by its ID. ```APIDOC ## GET /api/v2/serverpacks/download/{id} ### Description Downloads a server pack by its ID. ### Method GET ### Endpoint /api/v2/serverpacks/download/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the server pack. ``` -------------------------------- ### Configure disabled.txt Source: https://help.serverpackcreator.de/working-with-plugins.html Example content for the disabled.txt file to exclude specific plugins by their ID. ```text ######################################## # - Load all plugins except these. - # # - Add one plugin-id per line. - # ######################################## example-plugin ``` -------------------------------- ### GET /api/v2/versions/neoforge Source: https://help.serverpackcreator.de/versions.html Retrieves a list of available NeoForge versions. ```APIDOC ## GET /api/v2/versions/neoforge ### Description Returns an array of strings representing all available NeoForge versions. ### Method GET ### Endpoint /api/v2/versions/neoforge ### Response #### Success Response (200) - **body** (Array of string) - List of version strings. #### Response Example [ "47.1.99", "...", "47.1.7" ] ``` -------------------------------- ### English translation properties Source: https://help.serverpackcreator.de/translations.html Example of the default English key-value pairs used for the application GUI. ```properties menubar.gui.menu.file=File menubar.gui.menu.edit=Edit menubar.gui.menu.view=View menubar.gui.menu.about=About menubar.gui.menu.help=Help ``` -------------------------------- ### GET /api/v2/serverpacks/download/{modPackId}&{runConfigurationId} Source: https://help.serverpackcreator.de/server-packs.html Downloads a server pack with a specific run configuration. ```APIDOC ## GET /api/v2/serverpacks/download/{modPackId}&{runConfigurationId} ### Description Downloads a server pack with a specific run configuration. ### Method GET ### Endpoint /api/v2/serverpacks/download/{modPackId}&{runConfigurationId} ### Parameters #### Path Parameters - **modPackId** (integer) - Required - The ID of the mod pack. - **runConfigurationId** (integer) - Required - The ID of the run configuration. ``` -------------------------------- ### Retrieve RunConfiguration Array Source: https://help.serverpackcreator.de/run-configs.html Example JSON response containing a list of RunConfiguration objects with their respective Minecraft versions, modloaders, and mod lists. ```json [ { "id": 1, "minecraftVersion": "1.16.5", "modloader": "Forge", "modloaderVersion": "36.2.39", "startArgs": [ { "id": 1, "argument": "-Xms4G" }, { ... }, { "id": 22, "argument": "-Daikars.new.flags=true" } ], "clientMods": [ { "id": 1, "mod": "3dskinlayers-" }, { ... }, { "id": 310, "mod": "yisthereautojump-" } ], "whitelistedMods": [ { "id": 1, "mod": "Ping-Wheel-" } ] }, { "id": 2, "minecraftVersion": "1.16.5", "modloader": "Forge", "modloaderVersion": "36.2.35", "startArgs": [ { "id": 1, "argument": "-Xms4G" }, { ... }, { "id": 22, "argument": "-Daikars.new.flags=true" } ], "clientMods": [ { "id": 1, "mod": "3dskinlayers-" }, { ... }, { "id": 310, "mod": "yisthereautojump-" } ], "whitelistedMods": [ { "id": 1, "mod": "Ping-Wheel-" } ] }, { "id": 3, "minecraftVersion": "1.16.5", "modloader": "Forge", "modloaderVersion": "36.2.32", "startArgs": [ { "id": 1, "argument": "-Xms4G" }, { ... }, { "id": 22, "argument": "-Daikars.new.flags=true" } ], "clientMods": [ { "id": 1, "mod": "3dskinlayers-" }, { ... }, { "id": 310, "mod": "yisthereautojump-" } ], "whitelistedMods": [ { "id": 1, "mod": "Ping-Wheel-" } ] }, { "id": 52, "minecraftVersion": "1.19.2", "modloader": "Forge", "modloaderVersion": "43.2.21", "startArgs": [ { "id": 1, "argument": "-Xms4G" }, { ... }, { "id": 22, "argument": "-Daikars.new.flags=true" } ], "clientMods": [ { "id": 1, "mod": "3dskinlayers-" }, { ... }, { "id": 310, "mod": "yisthereautojump-" } ], "whitelistedMods": [ { "id": 1, "mod": "Ping-Wheel-" } ] }, { "id": 53, "minecraftVersion": "1.12.2", "modloader": "Forge", "modloaderVersion": "14.23.5.2860", "startArgs": [ { "id": 2, "argument": "-Xmx4G" }, { "id": 1, "argument": "-Xms4G" } ], "clientMods": [ { "id": 352, "mod": "something-" }, { "id": 353, "mod": "and-more-" } ], "whitelistedMods": [ { "id": 1, "mod": "Ping-Wheel-" } ] } ] ``` -------------------------------- ### GET /api/v2/settings/current Source: https://help.serverpackcreator.de/settings.html Retrieves the current settings, including a list of client-side mods. ```APIDOC ## GET /api/v2/settings/current ### Description Retrieves the current configuration settings, which includes a list of identified client-side mods. ### Method GET ### Endpoint /api/v2/settings/current ### Response #### Success Response (200) - **clientsideMods** (array) - A list of strings representing client-side mods. #### Response Example { "clientsideMods": [ "3dskinlayers-", "Absolutely-Not-A-Zoom-Mod-", "AdvancedChat-" ] } ``` -------------------------------- ### Server Pack Response Schema Source: https://help.serverpackcreator.de/server-packs.html Example JSON response structure for a server pack object. ```json { "id": 1, "size": 353.0, "runConfiguration": { "id": 1, "minecraftVersion": "1.16.5", "modloader": "Forge", "modloaderVersion": "36.2.39", "startArgs": [ { "id": 1, "argument": "-Xms4G" }, { ... }, { "id": 22, "argument": "-Daikars.new.flags=true" } ], "clientMods": [ { "id": 1, "mod": "3dskinlayers-" }, { ... }, { "id": 310, "mod": "yisthereautojump-" } ], "whitelistedMods": [ { "id": 1, "mod": "Ping-Wheel-" } ] }, "confirmedWorking": 0, "sha256": "7b1883b25771c9c5699cee05036e37dc6418613634283fc1f012ff5109cba42b", "downloads": 2, "dateCreated": 1707166386123 } ``` -------------------------------- ### Retrieve Current Settings Source: https://help.serverpackcreator.de/settings.html Example JSON response for the /api/v2/settings/current endpoint, containing a list of clientside mods. ```json { "clientsideMods": [ "3dskinlayers-", "Absolutely-Not-A-Zoom-Mod-", "AdvancedChat-", "AdvancedChatCore-", "AdvancedChatHUD-", "AdvancedCompas-", "Ambience", "AmbientEnvironment-", "AmbientSounds_", "AreYouBlind-", "Armor Status HUD-", "ArmorSoundTweak-", "BH-Menu-", "Batty's Coordinates PLUS Mod", "BetterAdvancements-", "BetterAnimationsCollection-", "BetterDarkMode-", "BetterF3-", "BetterFog-", "BetterFoliage-", "BetterModsButton-", "BetterPingDisplay-", "BetterPlacement-", "BetterTaskbar-", "BetterThirdPerson", "BetterTitleScreen-", "Blur-", "BorderlessWindow-", "CTM-", "ChunkAnimator-", "ClientTweaks_", "CompletionistsIndex-", "Controller Support-", "Controlling-", "CraftPresence-", "CullLessLeaves-Reforged-", "CustomCursorMod-", "CustomMainMenu-", "DefaultOptions_", "DefaultSettings-", "DeleteWorldsToTrash-", "DetailArmorBar-", "Ding-", "DistantHorizons-", "DripSounds-", "Durability101-", "DurabilityNotifier-", "DynamicSurroundings-", "DynamicSurroundingsHuds-", "EffectsLeft-", "EiraMoticons_", "EnchantmentDescriptions-", "EnhancedVisuals_", "EquipmentCompare-", "FPS-Monitor-", "FabricCustomCursorMod-", "Fallingleaves-", "FancySpawnEggs", "FancyVideo-API-", "FirstPersonMod", "FogTweaker-", "ForgeCustomCursorMod-", "FpsReducer-", "FpsReducer2-", "FullscreenWindowed-", "GameMenuModOption-", "HealthOverlay-", "HeldItemTooltips-", "HorseStatsMod-", "ImmediatelyFastReforged-", "InventoryEssentials_", "InventoryHud_[1.17.1].forge-", "InventorySpam-", "InventoryTweaks-", "ItemBorders-", "ItemPhysicLite_", "ItemStitchingFix-", "JBRA-Client-", "JustEnoughCalculation-", "JustEnoughEffects-", "JustEnoughProfessions-", "LLOverlayReloaded-", "LOTRDRP-", "LeaveMyBarsAlone-", "LegendaryTooltips", "LegendaryTooltips-", "LightOverlay-", "MinecraftCapes ", "MoBends", "MouseTweaks-", "MyServerIsCompatible-", "Neat ", "Neat-", "NekosEnchantedBooks-", "NoAutoJump-", "NoFog-", "Notes-", "NotifMod-", "OldJavaWarning-", "OptiFine", "OptiFine_", "OptiForge", "OptiForge-", "OverflowingBars-", "PackMenu-", "PackModeMenu-", "PickUpNotifier-", "Ping-", "PingHUD-", "PresenceFootsteps-", "RPG-HUD-", "ReAuth-", "Reforgium-", "ResourceLoader-", "ResourcePackOrganizer", "Ryoamiclights-", "ShoulderSurfing-", "ShulkerTooltip-", "SimpleDiscordRichPresence-", "SimpleWorldTimer-", "SoundFilters-", "SpawnerFix-", "StylishEffects-", "TRansliterationLib-", "TextruesRubidiumOptions-", "TipTheScales-", "Tips-", "Toast Control-", "Toast-Control-", "ToastControl-", "TravelersTitles-", "VR-Combat_", "VoidFog-", "WindowedFullscreen-", "WorldNameRandomizer-", "YeetusExperimentus-", "YungsMenuTweaks-", "[1.12.2]DamageIndicatorsMod-", "[1.12.2]bspkrscore-", "^textrues_embeddium_options-.*$", "antighost-", "anviltooltipmod-", "appleskin-", "armorchroma-", "armorpointspp-", "auditory-", "authme-", "auto-reconnect-", "autojoin-", "autoreconnect-", "axolotl-item-fix-", "backtools-", "bannerunlimited-", "beenfo-1.19-", "better-recipe-book-", "betterbiomeblend-", "bhmenu-", "blur-", "borderless-mining-", "cat_jam-", "catalogue-", "charmonium-", "chat_heads-", "cherishedworlds-", "cirback-1.0-", "classicbar-", "clickadv-", "clienttweaks-", "combat_music-", "connectedness-", "controllable-", "cullleaves-", "cullparticles-", "custom-crosshair-mod-", "customdiscordrpc-", "darkness-", "dashloader-", "defaultoptions-", "desiredservers-" ] } ``` -------------------------------- ### Response for status query Source: https://help.serverpackcreator.de/events.html Example JSON response containing an array of QueueEvent objects. ```json [ { "id": 57, "modPackId": 1, "serverPackId": null, "status": "GENERATED", "message": "Generated ServerPack.", "timestamp": 1707166386134, "errors": [] }, { "id": 58, "modPackId": 1, "serverPackId": 1, "status": "GENERATED", "message": "Submitted task to queue.", "timestamp": 1707166387147, "errors": [] }, { "id": 59, "modPackId": 1, "serverPackId": 1, "status": "GENERATED", "message": "Syncing ModPack to database.", "timestamp": 1707166387156, "errors": [] }, { "id": 60, "modPackId": 1, "serverPackId": 1, "status": "GENERATED", "message": "Syncing ServerPack to database.", "timestamp": 1707166387167, "errors": [] } ] ``` -------------------------------- ### Response for server pack query Source: https://help.serverpackcreator.de/events.html Example JSON response containing an array of QueueEvent objects filtered by server pack ID. ```json [ { "id": 58, "modPackId": 1, "serverPackId": 1, "status": "GENERATED", "message": "Submitted task to queue.", "timestamp": 1707166387147, "errors": [] }, { "id": 59, "modPackId": 1, "serverPackId": 1, "status": "GENERATED", "message": "Syncing ModPack to database.", "timestamp": 1707166387156, "errors": [] }, { "id": 60, "modPackId": 1, "serverPackId": 1, "status": "GENERATED", "message": "Syncing ServerPack to database.", "timestamp": 1707166387167, "errors": [] } ] ``` -------------------------------- ### Version Metadata Response Source: https://help.serverpackcreator.de/versions.html Example JSON response containing lists of supported versions for various Minecraft mod loaders. ```json { "minecraft": [ "1.20.4", "...", "1.0" ], "fabric": [ "0.15.6", "...", "0.1.0.48" ], "legacyFabric": [ "0.15.6", "...", "0.13.0" ], "quilt": [ "0.23.1", "...", "0.16.0-beta.1" ], "forge": { "1.4.7": [ "6.6.2.534", "...", "6.6.0.490" ], "1.8.8": [ "11.15.0.1655", "...", "11.14.4.1575-1.8.8" ], "1.20": [ "46.0.14", "...", "46.0.1" ], "1.8.9": [ "11.15.1.2318-1.8.9", "...", "11.15.0.1656" ], "1.18": [ "38.0.17", "...", "38.0.0" ], "1.19": [ "41.1.0", "...", "41.0.1" ], "1.15": [ "29.0.4", "...", "29.0.0" ], "1.20.4": [ "49.0.27", "...", "49.0.3" ], "1.20.3": [ "49.0.2", "49.0.1" ], "1.20.2": [ "48.1.0", "...", "48.0.0" ], "1.20.1": [ "47.2.20", "...", "47.0.0" ], "1.3.2": [ "4.3.5.318", "...", "4.0.0.172" ], "1.7.2": [ "10.12.2.1161-mc172", "...", "10.12.0.967" ], "1.17.1": [ "37.1.1", "...", "37.0.0" ], "1.13.2": [ "25.0.223", "...", "25.0.9" ], "1.9.4": [ "12.17.0.2317-1.9.4", "...", "12.17.0.1908-1.9.4" ], "1.7.10-pre4": [ "10.12.2.1149-prerelease", "...", "10.12.2.1137-prerelease" ], "1.4.0": [ "5.0.0.326", "...", "5.0.0.320" ], "1.4.1": [ "6.0.0.329", "...", "6.0.0.327" ], "1.4.2": [ "6.0.1.355", "...", "6.0.1.330" ], "1.4.3": [ "6.2.1.358", "...", "6.2.1.356" ], "1.16.4": [ "35.1.37", "...", "35.0.0" ], "1.4.4": [ "6.3.0.378", "...", "6.3.0.360" ], "1.16.5": [ "36.2.41", "...", "36.0.0" ], "1.4.5": [ "6.4.2.448", "...", "6.4.0.379" ], "1.4.6": [ "6.5.0.489", "...", "6.5.0.451" ], "1.16.1": [ "32.0.108", "...", "32.0.1" ], "1.16.2": [ "33.0.61", "...", "33.0.0" ], "1.16.3": [ "34.1.42", "...", "34.0.0" ], "1.12.1": [ "14.22.1.2485", "...", "14.22.0.2444" ], "1.12.2": [ "14.23.5.2860", "...", "14.23.0.2486" ], "1.5.1": [ "7.7.2.682", "...", "7.7.0.600" ], "1.1": [ "1.3.4.29", "...", "1.3.2.1" ], "1.5.2": [ "7.8.1.738", "...", "7.8.0.684" ], "1.19.1": [ "42.0.9", "...", "42.0.0" ], "1.19.2": [ "43.3.7", "...", "43.0.0" ], "1.19.3": [ "44.1.23", "...", "44.0.0" ], "1.19.4": [ "45.2.8", "...", "45.0.0" ], "1.5": [ "7.7.0.598", "...", "7.7.0.559" ], "1.15.1": [ "30.0.51", "...", "30.0.0" ], "1.15.2": [ "31.2.57", "...", "31.0.0" ], "1.8": [ "11.14.4.1577", "...", "11.14.0.1237-1.8" ], "1.9": [ "12.16.1.1938-1.9.0", "...", "12.16.0.1766-1.9" ], "1.11.2": [ "13.20.1.2588", "...", "13.20.0.2200" ], "1.12": [ "14.21.1.2443", "...", "14.21.0.2320" ], "1.10": [ ``` -------------------------------- ### Retrieve Modpack Details Source: https://help.serverpackcreator.de/modpacks.html Example cURL request to fetch details for a specific modpack by ID. ```bash curl --location 'http://localhost:8080/api/v2/modpacks/1' ``` -------------------------------- ### GET /api/v2/versions/all Source: https://help.serverpackcreator.de/versions.html Retrieves a complete list of all supported Minecraft versions and their associated mod loader versions. ```APIDOC ## GET /api/v2/versions/all ### Description Retrieves a list of all supported Minecraft versions and the available versions for mod loaders such as Fabric, Quilt, Legacy Fabric, and Forge. ### Method GET ### Endpoint /api/v2/versions/all ### Response #### Success Response (200) - **minecraft** (array) - List of supported Minecraft versions. - **fabric** (array) - List of supported Fabric versions. - **legacyFabric** (array) - List of supported Legacy Fabric versions. - **quilt** (array) - List of supported Quilt versions. - **forge** (object) - Map of Minecraft versions to their supported Forge versions. #### Response Example { "minecraft": ["1.20.4", "1.0"], "fabric": ["0.15.6", "0.1.0.48"], "legacyFabric": ["0.15.6", "0.13.0"], "quilt": ["0.23.1", "0.16.0-beta.1"], "forge": { "1.20.4": ["49.0.27", "49.0.3"] } } ``` -------------------------------- ### Download Server Pack with Configuration Source: https://help.serverpackcreator.de/server-packs.html Downloads a server pack using a specific mod pack ID and run configuration ID. ```bash curl --location 'http://localhost:8080/api/v2/serverpacks/download/1&2' ``` -------------------------------- ### GET /api/v2/versions Source: https://help.serverpackcreator.de/versions.html Retrieves a list of all available versions. ```APIDOC ## GET /api/v2/versions ### Description Retrieves a list of all available versions. ### Method GET ### Endpoint /api/v2/versions ### Response #### Success Response (200) - **body** (Array of string) - A list of version strings. #### Response Example [ "0.15.6", "...", "0.1.0.48" ] ``` -------------------------------- ### Retrieve All Run Configurations Source: https://help.serverpackcreator.de/run-configs.html Use this endpoint to fetch a list of all available run configurations. ```bash curl --location 'http://localhost:8080/api/v2/runconfigs/all' ``` -------------------------------- ### GET /api/v2/versions/minecraft Source: https://help.serverpackcreator.de/versions.html Retrieves a list of available Minecraft versions. ```APIDOC ## GET /api/v2/versions/minecraft ### Description Returns an array of strings representing all available Minecraft versions. ### Method GET ### Endpoint /api/v2/versions/minecraft ### Response #### Success Response (200) - **body** (Array of string) - List of version strings. #### Response Example [ "1.20.4", "...", "1.0" ] ``` -------------------------------- ### ServerPackHandler.run Source: https://help.serverpackcreator.de/readme.html Executes the generation of a server pack based on the provided configuration. ```APIDOC ## ServerPackHandler.run(PackConfig packConfig) ### Description Runs the server pack generation process using the specified configuration. ### Parameters - **packConfig** (PackConfig) - Required - The configuration to use for generating the server pack. ### Response - **success** (Boolean) - Indicates if the generation was successful. - **serverPack** (File) - The absolute path to the generated server pack. - **serverPackZip** (Optional) - The absolute path to the generated server pack ZIP, if applicable. - **errors** (List) - A list of errors encountered during generation. ``` -------------------------------- ### ServerPackCreator Command-Line Arguments Source: https://help.serverpackcreator.de/run-modes.html A list of available command-line flags and arguments for controlling ServerPackCreator behavior, including configuration generation, updates, and mode selection. ```text -lang: Allows you to use one of the available languages for ServerPackCreator. I can not guarantee that each of the following available languages is 100% translated. You best choice is en_us, or not specifying any as that is the default, because I write ServerPackCreator with english in mind. -cgen: Generates a basic server pack configuration from the specified modpack. Examples: -cgen "/path/to/modpack" -cgen "C:/users//CurseForge/instances/modpack" -update: Check whether a new version of ServerPackCreator is available for download. If an update is available, the version and link to the release of said update are written to the console so you can from work with it from there. Note: When you installed ServerPackCreator using the official installers, this will try and attempt updating your current installation if an update is available. -cli: Run ServerPackCreator in an interactive commandline-mode. -withallinconfigdir: Runs generations for all configurations present in ServerPackCreator's configs-directory. -config: Generate a server pack from a specific server pack configuration from the commandline. Examples: -config "/path/to/serverpack.conf" -config "C:/users//serverpack.conf" -feelinglucky: Feeling lucky, Punk? This will generate a server pack config from a passed modpack-directory and generate a server pack in one go. No warranty. No guarantees. Examples: -feelinglucky "/path/to/modpack" -feelinglucky "C:/users//CurseForge/instances/modpack" --destination: Only effective in combination with -config or -feelinglucky. Sets the destination in which the server pack will be generated in. Examples: -config "/path/to/serverpack.conf" --destination "/path/to/desired/location" -config "C:/users//serverpack.conf" --destination "C:/users//serverpack" -feelinglucky "/path/to/modpack" --destination "/path/to/desired/location" -feelinglucky "C:/users//CurseForge/instances/modpack" --destination "C:/users//serverpack" -web: Run ServerPackCreator as a webservice available at http://localhost:8080. The webservice provides the same functionality as running ServerPackCreator in GUI mode (so no Commandline arguments and a non-headless environment) as well as a REST API which can be used in different ways. For more information about the REST API, please see the Java documentation: - GitHub Pages: https://griefed.github.io/ServerPackCreator/ - GitLab Pages: https://griefed.pages.griefed.de/ServerPackCreator/ -gui: Run ServerPackCreator using the graphical user interface. If your environment supports graphics, i.e. is not headless, then this is the default mode in which ServerPackCreator started as when no arguments are used. --setup: Set up and prepare the environment for subsequent runs of ServerPackCreator. This will create/copy all files needed for ServerPackCreator to function properly from inside its JAR-file and setup everything else, too. You can pass a properties-file, too if you so desire. Examples: --setup "/path/to/custom.properties" --setup "C:\path\to\custom.properties" --home: Override the home-directory setting for your user. Can be used in combination with other arguments. Examples: --home "/path/to/directory" --home "C:\users\\SPC" ``` -------------------------------- ### GET /api/v2/versions/quilt Source: https://help.serverpackcreator.de/versions.html Retrieves a list of available Quilt versions. ```APIDOC ## GET /api/v2/versions/quilt ### Description Returns an array of strings representing all available Quilt versions. ### Method GET ### Endpoint /api/v2/versions/quilt ### Response #### Success Response (200) - **body** (Array of string) - List of version strings. #### Response Example [ "0.23.1", "...", "0.16.0-beta.1" ] ``` -------------------------------- ### GET /api/v2/events/all Source: https://help.serverpackcreator.de/events.html Retrieves a list of all events currently in the queue. ```APIDOC ## GET /api/v2/events/all ### Description Retrieves a list of all events currently in the queue. ### Method GET ### Endpoint http://localhost:8080/api/v2/events/all ### Response #### Success Response (200) - **id** (integer) - The unique identifier of the event. - **modPackId** (integer) - The ID of the mod pack associated with the event. - **serverPackId** (integer|null) - The ID of the server pack, if applicable. - **status** (string) - The current status of the event (e.g., QUEUED, GENERATING, CHECKING). - **message** (string) - A descriptive message regarding the event status. - **timestamp** (long) - The timestamp when the event occurred. - **errors** (array) - A list of errors associated with the event. #### Response Example [ { "id": 107, "modPackId": 1, "serverPackId": null, "status": "QUEUED", "message": "Submitted task to queue.", "timestamp": 1707588514289, "errors": [] } ] ``` -------------------------------- ### List All Server Packs Source: https://help.serverpackcreator.de/server-packs.html Retrieves a list of all available server packs. ```bash curl --location 'http://localhost:8080/api/v2/serverpacks/all' ``` -------------------------------- ### GET /api/v2/modpacks/download/{id} Source: https://help.serverpackcreator.de/modpacks.html Downloads a specific modpack file by its ID. ```APIDOC ## GET /api/v2/modpacks/download/{id} ### Description Downloads a specific modpack file as a ZIP archive based on the provided ID. ### Method GET ### Endpoint /api/v2/modpacks/download/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The unique identifier of the modpack. ### Response #### Success Response (200) - **binary** (application/zip) - The modpack file content. ``` -------------------------------- ### Initialize ServerPackCreator API Source: https://help.serverpackcreator.de/readme.html Initialize the API using a properties file. Ensure the specified directory is dedicated to the API to avoid data loss. ```kotlin val spcAPI = ApiWrapper.api(File("/path/to/file.properties")) ``` -------------------------------- ### GET /api/v2/serverpacks/{id} Source: https://help.serverpackcreator.de/server-packs.html Retrieves the details of a specific server pack by its ID. ```APIDOC ## GET /api/v2/serverpacks/{id} ### Description Retrieves the details of a specific server pack by its ID. ### Method GET ### Endpoint /api/v2/serverpacks/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the server pack. ### Response #### Success Response (200) - **ServerPackView** (object) - The server pack details. #### Response Example { "id": 1, "size": 353.0, "runConfiguration": { "id": 1, "minecraftVersion": "1.16.5", "modloader": "Forge", "modloaderVersion": "36.2.39", "startArgs": [ { "id": 1, "argument": "-Xms4G" }, { "id": 22, "argument": "-Daikars.new.flags=true" } ], "clientMods": [ { "id": 1, "mod": "3dskinlayers-" }, { "id": 310, "mod": "yisthereautojump-" } ], "whitelistedMods": [ { "id": 1, "mod": "Ping-Wheel-" } ] }, "confirmedWorking": 0, "sha256": "7b1883b25771c9c5699cee05036e37dc6418613634283fc1f012ff5109cba42b", "downloads": 2, "dateCreated": 1707166386123 } ```