ServerPackCreator-Help Help

Settings And Configs

Configuration

serverpackcreator.conf

The serverpackcreator.conf file allows you to customize a couple of different things:

Variable

Description

modpackDir

The path to the directory/ZIP-archive where your modpack resides in.

[[inclusions]]

Each inclusion-specification ensures that the file or directory from source gets included in your server pack one way or another.


A basic configuration usually contains the mods and config directories. No need to prefix them with the path to your modpack.


ServerPackCreator will take care of that automatically by itself.


If you want to include files or folders outside of your modpack, then you will need to specify the whole path.


Below are some examples for including files from your modpack (mods and config) as well as files and folders from outside the modpack.


[[inclusions]]


    destination = ""


    exclusionFilter = ""


    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"br>    inclusionFilter = ""


[[inclusions]]


    destination = "MyInstructions.md"


    exclusionFilter = ""


    source ="/home/myuser/my_awesome_modpack/HOWTO.md"


    inclusionFilter = ""

[scripts]


    SPC_JAVA_SPC = "java"

Path to the Java Installation. On Linux systems use which java to find the location of your Java install. On Windows use where java and exclude the .exe-part. Note, that changing this value only affects the unzipped server pack's variables.txt. The one in the zipped server pack is unaffected by this setting and will always point to java to increase compatibility with users who download the zipped server pack.

minecraftVersion

The version of Minecraft for which to install the modloader server. The same version of Minecraft your modpack uses.

modLoader

Which modloader to install. Must be either "Forge", "NeoForge", "Fabric", "Quilt" or "LegacyFabric". The same modloader your modpack uses.

modLoaderVersion

Specific Modloader version to install the server in the serverpack. The same version your modpack uses.

includeServerIcon

Whether to include server-icon.png in your serverpack. Must be true or false.

includeServerProperties

Whether to include server.properties in your serverpack. Must be true or false.

includeZipCreation

Whether to create a zip-file of your serverpack, saved in the directory you specified with modpackDir. Must be true or false.

javaArgs

JVM flags / Java Args to add to the generated start-scripts. Set to "empty" to not use any in your start-scripts.

serverPackSuffix

A suffix to append to the name of the server pack directory and server pack ZIP-archive. Illegal characters are / < > : " \ | ? * # % & { } $ ! ' @ + ´ \` = and must not end with a SPACE or a DOT.

serverIconPath

Path to a custom server-icon.png-file to include in the server pack.

serverPropertiesPath

Path to a custom server.properties-file to include in the server pack.

serverpackcreator.properties

de.griefed.serverpackcreator.configuration.aikar=-Xms4G -Xmx4G -XX\:+UseG1GC -XX\:+ParallelRefProcEnabled -XX\:MaxGCPauseMillis\=200 -XX\:+UnlockExperimentalVMOptions -XX\:+DisableExplicitGC -XX\:+AlwaysPreTouch -XX\:G1NewSizePercent\=30 -XX\:G1MaxNewSizePercent\=40 -XX\:G1HeapRegionSize\=8M -XX\:G1ReservePercent\=20 -XX\:G1HeapWastePercent\=5 -XX\:G1MixedGCCountTarget\=4 -XX\:InitiatingHeapOccupancyPercent\=15 -XX\:G1MixedGCLiveThresholdPercent\=90 -XX\:G1RSetUpdatingPauseTimePercent\=5 -XX\:SurvivorRatio\=32 -XX\:+PerfDisableSharedMem -XX\:MaxTenuringThreshold\=1 -Dusing.aikars.flags\=https\://mcflags.emc.gs -Daikars.new.flags\=true de.griefed.serverpackcreator.configuration.directories.mustinclude=addonpacks,blueprints,config,configs,customnpcs,defaultconfigs,global_data_packs,global_packs,kubejs,maps,mods,openloader,scripts,shrines-saves,structures,structurize,worldshape,Zoestria de.griefed.serverpackcreator.configuration.directories.serverpacks= de.griefed.serverpackcreator.configuration.directories.shouldexclude=animation,asm,cache,changelogs,craftpresence,crash-reports,downloads,icons,libraries,local,logs,overrides,packmenu,profileImage,profileImage,resourcepacks,screenshots,server_pack,shaderpacks,simple-rpc,tv-cache de.griefed.serverpackcreator.configuration.fallback.updateurl=https\://raw.githubusercontent.com/Griefed/ServerPackCreator/main/serverpackcreator-api/src/main/resources/serverpackcreator.properties de.griefed.serverpackcreator.configuration.fallbackmodslist=3dskinlayers-,Absolutely-Not-A-Zoom-Mod-,AdvancedChat-,AdvancedChatCore-,AdvancedChatHUD-,AdvancedCompas-,Ambience,AmbientEnvironment-,AmbientSounds_,AnimaticaReforged-,AreYouBlind-,Armor Status HUD-,ArmorSoundTweak-,BH-Menu-,Batty's Coordinates PLUS Mod,BetterAdvancements-,BetterAnimationsCollection-,BetterModsButton-,BetterDarkMode-,BetterF3-,BetterFog-,BetterFoliage-,BetterPingDisplay-,BetterPlacement-,BetterTaskbar-,BetterThirdPerson,BetterTitleScreen-,Blur-,BorderlessWindow-,CTM-,ChunkAnimator-,Clear-Water-,ClientTweaks_,CompletionistsIndex-,Controller Support-,Controlling-,CraftPresence-,CullLessLeaves-Reforged-,CustomCursorMod-,CustomMainMenu-,DefaultOptions_,DefaultSettings-,DeleteWorldsToTrash-,DetailArmorBar-,Ding-,DistantHorizons-,DripSounds-,Durability101-,DurabilityNotifier-,DynamicSurroundings-,DynamicSurroundingsHuds-,EasyLAN-,EffectsLeft-,EiraMoticons_,EnchantmentDescriptions-,EnhancedVisuals_,EquipmentCompare-,EuphoriaPatcher-,FPS-Monitor-,FabricCustomCursorMod-,FadingNightVision-,Fallingleaves-,FancySpawnEggs,FancyVideo-API-,farsight-,FirstPersonMod,FogTweaker-,ForgeCustomCursorMod-,FpsReducer-,FpsReducer2-,FullscreenWindowed-,GameMenuModOption-,HealthOverlay-,HeldItemTooltips-,HorseStatsMod-,ImmediatelyFastReforged-,InventoryEssentials_,InventoryHud_[1.17.1].forge-,InventorySpam-,InventoryTweaks-,ItemBorders-,ItemLocks-,ItemPhysicLite_,ItemStitchingFix-,JBRA-Client-,JustEnoughCalculation-,JustEnoughEffects-,JustEnoughProfessions-,LeaveMyBarsAlone-,LLOverlayReloaded-,LOTRDRP-,LegendaryTooltips,LegendaryTooltips-,LightOverlay-,MinecraftCapes,MineMenu-,MoBends,ModernUI-,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-,RyoamicLights-,ShoulderSurfing-,ShulkerTooltip-,SimpleDiscordRichPresence-,SimpleWorldTimer-,SoundFilters-,SpawnerFix-,StylishEffects-,TextruesRubidiumOptions-,TRansliterationLib-,TipTheScales-,Tips-,Toast Control-,Toast-Control-,ToastControl-,TravelersTitles-,VoidFog-,VR-Combat_,WindowedFullscreen-,WorldNameRandomizer-,YeetusExperimentus-,YungsMenuTweaks-,[1.12.2]DamageIndicatorsMod-,[1.12.2]bspkrscore-,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-,discordrpc-,drippyloadingscreen-,drippyloadingscreen_,durabilitytooltip-,dynamic-fps-,dynamic-music-,dynamiclights-,dynmus-,effective-,eggtab-,eguilib-,eiramoticons-,embeddium-,enchantment-lore-,entity-texture-features-,entityculling-,essential_,exhaustedstamina-,extremesoundmuffler-,fabricemotes-,fancymenu_,fancymenu_video_extension,fast-ip-ping-,flickerfix-,fm_audio_extension_,forgemod_VoxelMap-,freelook-,galacticraft-rpc-,gamestagesviewer-,gpumemleakfix-,grid-,helium-,hiddenrecipebook_,hiddenrecipebook-,infinitemusic-,inventoryprofiles,invtweaks-,itemzoom,itlt-,jeed-,jehc-,jeiintegration_,jumpoverfences-,just-enough-harvestcraft-,justenoughbeacons-,justenoughdrags-,justzoom_,keymap-,keywizard-,lazurite-,lazydfu-,lib39-,light-overlay-,lightfallclient-,lightspeed-,loadmyresources_,lock_minecart_view-,lootbeams-,lwl-,macos-input-fixes-,magnesium_extras-,maptooltip-,massunbind,mcbindtype-,mcwifipnp-,medievalmusic-,memoryusagescreen-,mightyarchitect-,mindful-eating-,minetogether-,mobplusplus-,modcredits-,modernworldcreation_,modnametooltip-,modnametooltip_,moreoverlays-,mousewheelie-,movement-vision-,multihotbar-,music-duration-reducer-,musicdr-,neiRecipeHandlers-,ngrok-lan-expose-mod-,no_nv_flash-,nopotionshift_,notenoughanimations-,oculus-,ornaments-,overloadedarmorbar-,panorama-,paperdoll-,physics-mod-,phosphor-,preciseblockplacing-,radon-,realm-of-lost-souls-,rebind_narrator-,rebind-narrator-,rebindnarrator-,rebrand-,reforgium-,replanter-,rrls-,rubidium-,rubidium_extras-,screenshot-to-clipboard-,servercountryflags-,shutupexperimentalsettings-,shutupmodelloader-,signtools-,simple-rpc-,simpleautorun-,smartcursor-,smarthud-,smoothboot-,smoothfocus-,sodium-fabric-,sounddeviceoptions-,soundreloader-,spoticraft-,skinlayers3d-forge,textrues_embeddium_options-,tconplanner-,timestamps-,tooltipscroller-,torchoptimizer-,torohealth-,totaldarkness,toughnessbar-,watermedia-,whats-that-slot-forge-,wisla-,xenon-,xlifeheartcolors-,yisthereautojump- de.griefed.serverpackcreator.configuration.hastebinserver=https\://haste.zneix.eu/documents de.griefed.serverpackcreator.configuration.modswhitelist=Ping-Wheel- de.griefed.serverpackcreator.home=/home/griefed/ServerPackCreator de.griefed.serverpackcreator.java= de.griefed.serverpackcreator.language=en_GB de.griefed.serverpackcreator.minecraft.snapshots=false de.griefed.serverpackcreator.script.java.autoupdate=true de.griefed.serverpackcreator.serverpack.autodiscovery.enabled=true de.griefed.serverpackcreator.serverpack.autodiscovery.filter=START de.griefed.serverpackcreator.serverpack.cleanup.enabled=true de.griefed.serverpackcreator.serverpack.overwrite.enabled=true de.griefed.serverpackcreator.serverpack.zip.exclude=minecraft_server.MINECRAFT_VERSION.jar,server.jar,libraries/net/minecraft/server/MINECRAFT_VERSION/server-MINECRAFT_VERSION.jar de.griefed.serverpackcreator.serverpack.zip.exclude.enabled=true de.griefed.serverpackcreator.spring.schedules.database.cleanup=0 0 0 * * * de.griefed.serverpackcreator.spring.schedules.files.cleanup=0 30 0 * * * de.griefed.serverpackcreator.spring.schedules.versions.refresh=0 0 0 * * * de.griefed.serverpackcreator.versioncheck.prerelease=false de.griefed.serverpackcreator.serverpack.script.template.bat= de.griefed.serverpackcreator.serverpack.script.template.ps1= de.griefed.serverpackcreator.serverpack.script.template.sh= de.griefed.serverpackcreator.serverpack.java.template.ps1= de.griefed.serverpackcreator.serverpack.java.template.sh= de.griefed.serverpackcreator.serverpack.update=false # Webservice-specific props server.error.include-message=ALWAYS server.error.include-stacktrace=ALWAYS server.error.whitelabel.enabled=false server.port=8080 server.tomcat.accesslog.directory=logs server.tomcat.accesslog.enabled=true server.tomcat.accesslog.file-date-format=_yyyy-MM-dd server.tomcat.accesslog.pattern=common server.tomcat.accesslog.prefix=tomcat_access server.tomcat.accesslog.suffix=.log server.tomcat.basedir= spring.application.name=ServerPackCreator spring.datasource.driverClassName=org.postgresql.Driver spring.datasource.tomcat.max-active=50 spring.datasource.tomcat.max-idle=15 spring.datasource.tomcat.min-idle=8 spring.datasource.password= spring.datasource.username= spring.datasource.url=jdbc\:postgresql\://localhost\:5432/serverpackcreator spring.jdbc.template.query-timeout=3600 spring.jpa.database-platform=org.hibernate.dialect.PostgreSQLDialect spring.jpa.generate-ddl=true spring.jpa.hibernate.ddl-auto=update spring.jpa.open-in-view=false spring.jpa.properties.hibernate.jdbc.lob.non_contextual_creation=true spring.jpa.properties.hibernate.jdbc.use_streams_for_binary=true spring.output.ansi.enabled=ALWAYS spring.servlet.multipart.max-file-size=5000MB spring.servlet.multipart.max-request-size=5000MB spring.transaction.default-timeout=3600

Property

Description

de.griefed.serverpackcreator.configuration.aikar

Aikars commonly used Minecraft server JVM flags to potentially increase the performance of your Minecraft server.

de.griefed.serverpackcreator.configuration.directories.mustinclude

List of directories which must be included in a server pack.

de.griefed.serverpackcreator.configuration.directories.serverpacks

The directory in which server packs will be generated and stored in.

de.griefed.serverpackcreator.configuration.directories.shouldexclude

List of directories which should not be in a server pack.

de.griefed.serverpackcreator.configuration.fallback.updateurl

URL to a Properties file which contains definitions for the clientside- and whitelist-mods to use as an update source during start-up.

de.griefed.serverpackcreator.configuration.fallbackmodslist

Comma separated fallback-list of clientside-only mods. Do not edit this manually.

de.griefed.serverpackcreator.configuration.hastebinserver

Address of a HasteBin server to use for config and logs uploading.

de.griefed.serverpackcreator.configuration.modswhitelist

Whitelisted mods which will always get included, no matter if they are present in the clienstide-list or detected by ServerPackCreator automatically.

de.griefed.serverpackcreator.home

The home-directory of ServerPackCreator. Only change this manually if you know what you are doing.

de.griefed.serverpackcreator.java

Path to the Java installation used by ServerPackCreator. Currently has no effect on anything.

de.griefed.serverpackcreator.language

The language in which ServerPackCreator should run.

de.griefed.serverpackcreator.minecraft.snapshots

true or false. Whether Minecraft snapshot versions should be available to the user in the GUI.

de.griefed.serverpackcreator.script.java.autoupdate

true or false. Whether the java-placeholder in the script settings of a server pack config should be updated with local Java paths (if they are configured accordingly).

de.griefed.serverpackcreator.serverpack.autodiscovery.enabled

true or false. Whether to try and determine sideness of mods in a modpack automatically and exclude them if they are clientside-only. Set this to false to disable it.

de.griefed.serverpackcreator.serverpack.autodiscovery.filter

Filter method by which to exclude user-specified clientside-only mods. START, END, REGEX, CONTAIN, EITHER

de.griefed.serverpackcreator.serverpack.cleanup.enabled

true or false. Whether to cleanup files after generating a server pack.

de.griefed.serverpackcreator.serverpack.overwrite.enabled

true or false. Whether an already existing server pack should be overwritten.

de.griefed.serverpackcreator.serverpack.zip.exclude

Files to exclude from the server pack ZIP-archive. You may use MINECRAFT_VERSION as a placeholder for the Minecraft version of your modpack/server pack if a files name contains it.

de.griefed.serverpackcreator.serverpack.zip.exclude.enabled

true or false. Whether exclusion of files from a server packs ZIP-archive is enabled.

de.griefed.serverpackcreator.spring.schedules.database.cleanup

Web-only. Cron-schedule at which checks are run and server packs cleaned up.

de.griefed.serverpackcreator.spring.schedules.files.cleanup

Web-only. Cron-schedule at which checks are run and files from server pack generations are cleaned up.

de.griefed.serverpackcreator.spring.schedules.versions.refresh

Web-only. Cron-schedule at which the available Minecraft, Forge and Fabric versions are refreshed.

de.griefed.serverpackcreator.versioncheck.prerelease

true or false. Whether to check for available pre-releases, too, when checking for updates.

de.griefed.serverpackcreator.serverpack.script.template.bat

Path to the default Batch-template used for start-script generation.

de.griefed.serverpackcreator.serverpack.script.template.ps1

Path to the default PowerShell-template used for start-script generation.

de.griefed.serverpackcreator.serverpack.script.template.sh

Path to the default Shell-template used for start-script generation.

de.griefed.serverpackcreator.serverpack.java.template.ps1

Path to the default PowerShell-template used for Java-installation-script generation.

de.griefed.serverpackcreator.serverpack.java.template.sh

Path to the default Shell-template used for Java-installation-script generation.

de.griefed.serverpackcreator.serverpack.update

true or false. Whether ServerPackCreator should attempt to update a server pack which was previously generated through ServerPackCreator. Requires overwrites to be disabled.

If at any point you wish to override one of these properties (apart from the ones which get dynamically updated), you may place an overrides.properties in your ServerPackCreator home-directory. Any property in that file will override any already existing one during start-up. Check the logs when using overrides, as any property loaded from your overrides will be printed to the logs, too.

If any spring.* or server.* property above has no description in the table below, it is not to be touched. Changing any of these can break ServerPackCreator or cause otherwise unwanted behaviour. Changes to properties not described below are not supported. If you changed a property you were not meant to fiddle around with, do not report an issue. Such issues will be closed without further comment.

Property

Description

server.port

The port at which ServerPackCreator as a webservice will be available at.

spring.datasource.url

JDBC URL to your PostgreSQL host, port and database

spring.servlet.multipart.max-file-size

Maximum filesize for uploads.

spring.servlet.multipart.max-request-size

Maximum request size for file uploads.

spring.config.import

Additional properties-file to import properties from.

spring.datasource.password

Password to authenticate against the specified database with.

spring.datasource.username

Username to authenticate against the specified database with.

Last modified: 25 July 2024