Merge pull request #1385 from NillerMedDild/develop

Develop

.github/README.md

@@ -5,8 +5,16 @@ This is the official repository and issue-tracker for the modpack Enigmatica 6,
 ### Table of Contents
 
 -   [Testing](#testing)
+-   [Setup](#setup)
+    -   [MultiMC (Windows/Mac/Linux)](#multimc-linux--windows--mac)
+    -   [CurseForge App (Windows/Mac)](#curseforge-app-windows--mac)
+    -   [Alternatives](#alternatives)
+-   [Server Automation](#server-automation)
+-   [Docker](#docker)
 -   [Links](#links)
 
+<hr></hr>
+
 ## Testing
 
 If you would like to help test Enigmatica 6, you're very welcome to do so.
@@ -51,7 +59,7 @@ git fetch
 git pull origin develop
 ```
 
-8. Now double click the script `setup.sh` to setup InstanceSync. It is found in the `development` folder.
+8. Now double click the script `InstanceSyncSetup.sh` to setup InstanceSync. It is found in the root folder.
 
 You're done!
 
@@ -64,32 +72,39 @@ Tip: If you run into issues, verifying you are using the right Minecraft and For
 
     _Note: If you've previously used the Twitch App the path will most likely be `C:\Users\User\Documents\Twitch\Minecraft\Instances`._
 
-3. Double click the script `setup.bat` to setup InstanceSync. It is found in the `development` folder.
+3. Double click the script `InstanceSyncSetup.bat` to setup InstanceSync. It is found in the root folder.
 4. Pull.
 5. Open the CurseForge App and you should see Enigmatica 6. If you already had CurseForge App open, restart it.
 
 You're done!
 
-## Server Automation
+### Alternatives
+
+It is possible to setup a development instance for Enigmatica 6 in other ways, for example running it through the .Minecraft folder.
+
+# Server Automation
+
+## Automatic updates with Git
 
 _Note: You only have to do this setup once, afterwards you simply need to do step 8._
 
 1. Clone the Enigmatica 6 repository to an empty folder.
-2. Double click the script `setup.bat` to setup InstanceSync. It is found in the `development` folder.
+2. Double click the script `InstanceSyncSetup.bat` to setup InstanceSync. It is found in the root folder.
 3. Open a command line, and navigate to the folder.
 4. Use the command `git pull`
-5. Navigate to the folder `development/include-in-server-files`
+5. Navigate to the folder `server`
 6. Open the file `settings.cfg` and change `MAX_RAM=4G` to the amount you wish to allocate.
-7. Copy all files from the folder `development/include-in-server-files` into the root.
+7. Copy all files from the folder `server` into the root.
 8. Run `remove-client-mods` to ensure that no client-side mods are on the server.
 9. Double clicking `update-server.bat` will now update the modpack.
 
 Using the `update-server` script will reset changes you've made to all files tracked by the repository.
 Anything put in the `overrides` folder will be copied into the root folder when the `update-server` script is finished - I recommend you put any changed configs and added mods there.
 
-### Alternatives
+## Docker
 
-It is possible to setup a development instance for Enigmatica 6 in other ways, for example running it through the .Minecraft folder.
+There's an example `docker-compose.yml` in the `docker` folder, for those who want to run an Enigmatica 6 server through Docker.
+It's based on [Docker Minecraft Server](https://github.com/itzg/docker-minecraft-server), please see the link for configuration and advanced usage.
 
 ## Links
 

.gitignore

@@ -13,6 +13,7 @@ config/forgeendertech/Biomes/
 screenshots/
 /mods/
 /world/
+/world_backup/
 /defaultconfig/
 /data/
 /ct_dumps/
@@ -25,21 +26,13 @@ github_changelog_generator.gemspec
 twitch_export-win.exe
 ChangelogGenerator.bat
 .build.json
-
-# Client Configs
-config/InvTweaks.cfg
-config/MouseTweaks.cfg
-config/jei/worldSettings.cfg
-config/jei/lookupHistory.zip
-config/jei/bookmarks.ini
 .curseclient
 .ReAuth.cfg
 usernamecache.json
 usercache.json
 knownkeys.txt
 servers.dat
 realms_persistence.json
-WailaErrorOutput.txt
 ItemDump.txt
 BotaniaVars.dat
 crafttweaker.log
@@ -68,17 +61,12 @@ post-file-to-discord.bat
 .curseclient
 config/XaeroWorldMap/
 eula.txt
-scb_resources/
 XaeroWaypoints/
 XaeroWorldMap/
 options.txt
 secrets.ps1
 **/*.zip
 CHANGELOG-GENERATED.md
-stdlib_Result$Error.class
-stdlib_Result$Ok.class
-ttt.class
-.persistent/multibeds/embroidery.dat
 ds_private_storage.json
 TwitchExportBuilder.exe
 reauth.toml
@@ -87,15 +75,9 @@ new.json
 old.json
 config/cherishedworlds/favorites.dat
 soundsMuffled.dat
-MakeModpackFiles.bat
-MakeModpackFilesPostToDiscord.bat
-PostToDiscord.bat
 
-!thirdpartymods/*.jar
-!openloader/*/*.zip
 !packmenu/*.zip
 TrashSlotSaveState.json
-scripts/experiments/*
 mode.json
 emojiful/cache/*
 config/betteradvancements-client.toml
@@ -121,6 +103,7 @@ config/xnet-client.toml
 config/buildinggadgets-client.toml
 config/mining_helmet-client.toml
 1.16.4.json
+stop-java-detection.txt
 remove-client-mods.bat
 remove-client-mods.ps1
 server-guide.txt
@@ -131,11 +114,31 @@ server-start.bat
 server-start.sh
 server.properties
 settings.cfg
-stop-java-detection.txt
 update-and-start-server.bat
 update-and-start-server.ps1
 update-server.bat
 update-server.ps1
+!server/remove-client-mods.bat
+!server/remove-client-mods.ps1
+!server/server-guide.txt
+!server/server-install.sh
+!server/server-start-license.md
+!server/server-start-readme.md
+!server/server-start.bat
+!server/server-start.sh
+!server/server.properties
+!server/settings.cfg
+!server/update-and-start-server.bat
+!server/update-and-start-server.ps1
+!server/update-server.bat
+!server/update-server.ps1
+
+# Client Configs
+config/InvTweaks.cfg
+config/MouseTweaks.cfg
+config/jei/worldSettings.cfg
+config/jei/lookupHistory.zip
+config/jei/bookmarks.ini
 config/rftoolsutility-client.toml
 config/rftoolsstorage-client.toml
 config/rftoolscontrol-client.toml
@@ -155,6 +158,8 @@ config/computercraft-client.toml
 config/supplementaries-client.toml
 config/artifacts-client.toml
 config/occultism-client.toml
+config/betterendforge/client-config.toml
+config/upgrade_aquatic-client.toml
 
 # GDLauncher
 config.json

development/setup.bat → InstanceSyncSetup.bat

@@ -1,14 +1,12 @@
-@echo off
-
-cd ..
-
-type NUL > .git/hooks/post-merge
-echo #!/bin/sh > .git/hooks/post-merge
-echo java -jar InstanceSync.jar >> .git/hooks/post-merge
-
-echo Done setting up hooks
-echo Running InstanceSync
-
-java -jar InstanceSync.jar
-
+@echo off
+
+type NUL > .git/hooks/post-merge
+echo #!/bin/sh > .git/hooks/post-merge
+echo java -jar InstanceSync.jar >> .git/hooks/post-merge
+
+echo Done setting up hooks
+echo Running InstanceSync
+
+java -jar InstanceSync.jar
+
 pause

development/setup.sh → InstanceSyncSetup.sh

@@ -1,7 +1,5 @@
 #!/bin/sh
 
-cd ..
-
 echo "#!/bin/sh" > .git/hooks/post-merge
 echo "java -jar InstanceSync.jar" >> .git/hooks/post-merge
 

ModpackUploader.ps1

@@ -30,12 +30,6 @@ function Get-GitHubRelease {
     Remove-Item $name -Recurse -Force -ErrorAction SilentlyContinue
 }
 
-
-# Write-Host Removing non-default configs...
-# Get-ChildItem -Path config -Exclude $CONFIGS_TO_KEEP | ForEach-Object {
-#     Remove-Item -Path $_.FullName -Force -ErrorAction SilentlyContinue
-# }
-
 if (-not (test-path "$env:ProgramFiles\7-Zip\7z.exe")) { throw "$env:ProgramFiles\7-Zip\7z.exe needed to use the ModpackUploader." } 
 Set-Alias sz "$env:ProgramFiles\7-Zip\7z.exe"
 
@@ -51,9 +45,9 @@ if ($ENABLE_MANIFEST_BUILDER_MODULE -or $ENABLE_SERVER_FILE_MODULE) {
 if ($ENABLE_MANIFEST_BUILDER_MODULE) {
     # $TwitchExportBuilder = "TwitchExportBuilder.exe"
     # if (!(Test-Path $TwitchExportBuilder) -or $ENABLE_ALWAYS_UPDATE_JARS) {
-        # Remove-Item $TwitchExportBuilder -Recurse -Force -ErrorAction SilentlyContinue
-        # Get-GitHubRelease -repo "Gaz492/twitch-export-builder" -file "twitch-export-builder_windows_amd64.exe"
-        # Rename-Item -Path "twitch-export-builder_windows_amd64.exe" -NewName $TwitchExportBuilder -ErrorAction SilentlyContinue
+    # Remove-Item $TwitchExportBuilder -Recurse -Force -ErrorAction SilentlyContinue
+    # Get-GitHubRelease -repo "Gaz492/twitch-export-builder" -file "twitch-export-builder_windows_amd64.exe"
+    # Rename-Item -Path "twitch-export-builder_windows_amd64.exe" -NewName $TwitchExportBuilder -ErrorAction SilentlyContinue
     # }
     # .\TwitchExportBuilder.exe -n "$CLIENT_FILENAME" -p "$MODPACK_VERSION"
 }
@@ -68,7 +62,7 @@ if ($ENABLE_SERVER_FILE_MODULE) {
     Write-Host ""
 
     $CONTENTS_TO_MOVE | ForEach-Object {
-        $FilePath = "$PSScriptRoot/development/include-in-server-files/$_"
+        $FilePath = "$PSScriptRoot/server/$_"
         Copy-Item -Path $FilePath -Destination $PSScriptRoot
     }
 
@@ -88,7 +82,7 @@ if ($ENABLE_SERVER_FILE_MODULE) {
 }
 
 if ($ENABLE_CHANGELOG_GENERATOR_MODULE) {
-    Remove-Item old.json, new.json, changelog.txt -ErrorAction SilentlyContinue
+    Remove-Item old.json, new.json, changelog.md -ErrorAction SilentlyContinue
     sz e "$CLIENT_FILENAME`-$LAST_MODPACK_VERSION.zip" manifest.json
     Rename-Item -Path manifest.json -NewName old.json
     sz e "$CLIENT_FILENAME`-$MODPACK_VERSION.zip" manifest.json
@@ -99,8 +93,8 @@ if ($ENABLE_CHANGELOG_GENERATOR_MODULE) {
     Write-Host "Generating changelog..." -ForegroundColor Green
     Write-Host ""
 
-    java -jar ChangelogGenerator-2.0.0-pre3.jar
-    Move-Item -Path changelog.txt -Destination "changelogs/CHANGELOG_MODS_$MODPACK_VERSION.txt"
+    java -jar ChangelogGenerator-2.0.0-pre9.jar --markdown --lines=50 --entries=1
+    Move-Item -Path changelog.md -Destination "changelogs/CHANGELOG_MODS_$MODPACK_VERSION.md"
     Remove-Item old.json, new.json -ErrorAction SilentlyContinue
 }