!XI sep/Branch_1.3.1 -> sep/master

    !T (Documentation) Added GameSDK dll dist diff note for 5.4
    DLL not included in engine distro anymore

    !T (Readme) Added GameSDK dist diff note for 5.4

    !T (Documentation) Removed redundant instruction

    !B (cryproject) Fixed Fullscreen cvar definitions
    !T (Documentation) Added binary output limitation

    !B (cryproject) Fixed incorrect binary path in cryproject

    !R (Documentation) Updated INSTALL.txt to reflect migration to CE5.4

    !T (Documentation) Clarified version

    !T (Documentation) Updated migration notes

    !F (Cmake) Added missing 'TestPlatform' feature to cmakelists.txt

    !R (Plugin) Updated for 5.4
    Moved Platform Impl to plugin unit
    Changed to new plugin macro using guid Removed deleted event enums

    !R (Cmake) Update cmakelists from auto gen

    !D (Config) Removed redundant SplashExample.cfg file

    !D (Config) Removed redundant cryplugin.csv

    !R (Cryproject) Updated cryproject files for CE5.4 Moved all CVARS into cryproject files

Author: uniflare

Assets/SplashExample.cfg

@@ -1,99 +1,85 @@
-# Copyright (c) 2017, uniflare, see LICENSE.txt for details
-# Make sure you set these variables appropriately! (If using a host project)
-#
-set (USE_TEST_PLATFORM_PROJECT "FALSE")
+cmake_minimum_required (VERSION 3.6.2)
+set(CRYENGINE_DIR "C:/Program Files (x86)/Crytek/CRYENGINE Launcher/Crytek/CRYENGINE_5.4")
+set(TOOLS_CMAKE_DIR "${CRYENGINE_DIR}/Tools/CMake")
+
+set(PROJECT_BUILD 1)
+set(PROJECT_DIR "C:/dev/git/sf/SplashExample")
+
+include("${TOOLS_CMAKE_DIR}/CommonOptions.cmake")
+
+add_subdirectory("${CRYENGINE_DIR}" "${CMAKE_CURRENT_BINARY_DIR}/CRYENGINE")
+
+include("${TOOLS_CMAKE_DIR}/Configure.cmake")
+start_sources()
+
+sources_platform(ALL)
+add_sources("Code_uber.cpp"
+    PROJECTS SplashExamplePlugin
+    SOURCE_GROUP "Root"
+		"Plugin.cpp"
+		"SplashExample.cpp"
+		"StdAfx.cpp"
+		"cvars.h"
+		"Plugin.h"
+		"SplashExample.h"
+		"StdAfx.h"
+)
 
-set (TestPlatformRoot "C:/dev/git/sf/BLANKGAME")
-set (TestPlatformPath "${TestPlatformRoot}/bin/win_x64")
-set (TestPlatformProject "${TestPlatformRoot}/Game.cryproject")
+end_sources()
 
-# Default to this project, if no test platform project is used
-if (NOT USE_TEST_PLATFORM_PROJECT)
-	set (TestPlatformProject "${PROJECT_FILE}")
-endif()
+CryEngineModule(SplashExamplePlugin PCH "StdAfx.cpp" SOLUTION_FOLDER "Project")
 
-set (ProjectName "SplashExample")
+target_include_directories(${THIS_PROJECT}
+PRIVATE 
+    "${CRYENGINE_DIR}/Code/CryEngine/CryCommon"
+    "${CRYENGINE_DIR}/Code/CryEngine/CryAction"
+	"${CRYENGINE_DIR}/Code/CryEngine/CrySchematyc/Core/Interface"
+	"${CRYENGINE_DIR}/Code/CryPlugins/CryDefaultEntities/Module"
+)
 
-cmake_minimum_required (VERSION 3.6.0)
-project (${ProjectName} VERSION 1.3.0 LANGUAGES CXX)
+# Set StartUp project in Visual Studio
 
-if (${CMAKE_GENERATOR} MATCHES "^Visual Studio")
-	# Set startup project properties
-	configure_file ("${PROJECT_NAME}.vcxproj.user.in" "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.vcxproj.user")
-	set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT ${PROJECT_NAME})
+add_library(GameLauncher STATIC "${CRYENGINE_DIR}/Code/CryEngine/CryCommon/CryCore/Platform/platform.h")
+set_target_properties(GameLauncher PROPERTIES LINKER_LANGUAGE CXX)
+if (WIN32)
+    set_visual_studio_debugger_command(GameLauncher "${CRYENGINE_DIR}/bin/win_x64/GameLauncher.exe" "-project \"C:/dev/git/sf/SplashExample/SplashExamplePlugin.cryproject\"")
 endif()
 
-# Set output directory for executable files
-if(CMAKE_CL_64)
-	set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}\\..\\..\\bin\\win_x64")
-	set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}\\..\\..\\bin\\win_x64_release")
-else(CMAKE_CL_64)
-	set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}\\..\\..\\bin\\win_x86")
-	set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}\\..\\..\\bin\\win_x86_release")
-endif(CMAKE_CL_64)
-
-# Set output directory for DLL files
-if(CMAKE_CL_64)
-	set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}\\..\\..\\bin\\win_x64")
-	set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}\\..\\..\\bin\\win_x64_release")
-else(CMAKE_CL_64)
-	set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}\\..\\..\\bin\\win_x86")
-	set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}\\..\\..\\bin\\win_x86_release")
-endif(CMAKE_CL_64)
-
-# Set output directory for LIB files
-if(CMAKE_CL_64)
-	set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}\\..\\..\\bin\\win_x64\\lib")
-	set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}\\..\\..\\bin\\win_x64_release\\lib")
-else(CMAKE_CL_64)
-	set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}\\..\\..\\bin\\win_x86\\lib")
-	set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}\\..\\..\\bin\\win_x86_release\\lib")
-endif(CMAKE_CL_64)
-
-option(OPTION_PCH "Enable Precompiled headers" ON)
-
-find_package (CryCommon REQUIRED)
-find_package (CryAction REQUIRED)
-
-set (SourceGroup_Main
-	"SplashExample.cpp"
-	"SplashExample.h"
-	"Plugin.cpp"
-	"Plugin.h"
-	"CVars.h"
-	"StdAfx.cpp"
-	"StdAfx.h"
-)
-source_group("Main" FILES ${SourceGroup_Main})
+add_library(Sandbox STATIC "${CRYENGINE_DIR}/Code/CryEngine/CryCommon/CryCore/Platform/platform.h")
+set_target_properties(Sandbox PROPERTIES LINKER_LANGUAGE CXX)
+if (WIN32)
+    set_visual_studio_debugger_command(Sandbox "${CRYENGINE_DIR}/bin/win_x64/Sandbox.exe" "-project \"C:/dev/git/sf/SplashExample/SplashExamplePlugin.cryproject\"")
+endif()
 
-set (SOURCE
-	${SourceGroup_Main}
-)
-if(OPTION_PCH AND MSVC)
-	set (PRECOMPILED_SOURCE ${SOURCE})
-	list(REMOVE_ITEM PRECOMPILED_SOURCE "StdAfx.cpp")
+add_library(GameServer STATIC "${CRYENGINE_DIR}/Code/CryEngine/CryCommon/CryCore/Platform/platform.h")
+set_target_properties(GameServer PROPERTIES LINKER_LANGUAGE CXX)
+if (WIN32)
+    set_visual_studio_debugger_command(GameServer "${CRYENGINE_DIR}/bin/win_x64/Game_Server.exe" "-project \"C:/dev/git/sf/SplashExample/SplashExamplePlugin.cryproject\"")
+endif()
 
-	set (PRECOMPILED_BINARY ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pch)
-	set_source_files_properties (${PRECOMPILED_SOURCE} PROPERTIES COMPILE_FLAGS "/Yu\"StdAfx.h\" /Fp\"${PRECOMPILED_BINARY}\"" OBJECT_DEPENDS "${PRECOMPILED_BINARY}")
-	set_source_files_properties (StdAfx.cpp PROPERTIES COMPILE_FLAGS "/Yc\"StdAfx.h\" /Fp\"${PRECOMPILED_BINARY}\"" OBJECT_OUTPUTS "${PRECOMPILED_BINARY}")
-endif (OPTION_PCH AND MSVC)
+set_solution_startup_target(GameLauncher)
 
-add_library(${PROJECT_NAME} MODULE ${SOURCE})
-target_include_directories(${PROJECT_NAME} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
-target_link_libraries(${PROJECT_NAME} PRIVATE CryCommon CryAction)
+if (WIN32)
+    set_visual_studio_debugger_command( ${THIS_PROJECT} "${CRYENGINE_DIR}/bin/win_x64/GameLauncher.exe" "-project \"C:/dev/git/sf/SplashExample/SplashExamplePlugin.cryproject\"" )
+endif()
+
+#BEGIN-CUSTOM
+set (USE_TEST_PLATFORM_PROJECT "FALSE")
 
-# Add _RELEASE define to release config
-target_compile_definitions(${PROJECT_NAME}
-  PUBLIC $<$<CONFIG:Release>:_RELEASE>)
+set (TestPlatformRoot "C:/dev/git/sf/BLANKGAME/")
+set (TestPlatformPath "${TestPlatformRoot}bin/win_x64/")
+set (TestPlatformProject "${TestPlatformRoot}Game.cryproject")
 
-if(WIN32)
-	target_link_libraries(${PROJECT_NAME} PRIVATE Ntdll)
-endif(WIN32)
+# Default to this project, if no test platform project is used
+if (NOT USE_TEST_PLATFORM_PROJECT)
+	set (TestPlatformProject "${PROJECT_FILE}")
+endif()
 
 if(USE_TEST_PLATFORM_PROJECT)
-	add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD 
+	add_custom_command(TARGET ${THIS_PROJECT} POST_BUILD 
 	  COMMAND "${CMAKE_COMMAND}" -E copy 
-		 "$<TARGET_FILE:${PROJECT_NAME}>"
-		 "${TestPlatformPath}/$<TARGET_FILE_NAME:${PROJECT_NAME}>" 
+		 "$<TARGET_FILE:${THIS_PROJECT}>"
+		 "${TestPlatformPath}/$<TARGET_FILE_NAME:${THIS_PROJECT}>" 
 	  COMMENT "Copying to test platform directory")
-endif(USE_TEST_PLATFORM_PROJECT)
+endif(USE_TEST_PLATFORM_PROJECT)
+#END-CUSTOM

Code/CMakeLists.txt

@@ -1,6 +1,10 @@
 // Copyright (c) 2017, uniflare, see LICENSE.txt for details
 
 #include "StdAfx.h"
+
+// Included only once per DLL module.
+#include <CryCore/Platform/platform_impl.inl>
+
 #include "Plugin.h"
 
 ///////////////////////////////////////////////////////////////////////////

Code/Plugin.cpp

@@ -18,7 +18,7 @@ class CPlugin_SplashExample
 	CSplashExample * m_pSplashExample;
 public:
 	CRYINTERFACE_SIMPLE(ICryPlugin)
-		CRYGENERATE_SINGLETONCLASS(CPlugin_SplashExample, "Plugin_SplashExample", 0x53706C6173682045, 0x78616D706C650000)
+		CRYGENERATE_SINGLETONCLASS_GUID(CPlugin_SplashExample, "Plugin_SplashExample", "{ 53706C61 - 7368 - 2045 - 7861 - 6D706C650000 }"_cry_guid)
 
 	// ICryPlugin
 	virtual const char* GetName() const override { return "Splash Example Plugin"; }

Code/Plugin.h

@@ -1,6 +1,7 @@
 // Copyright (c) 2017, uniflare, see LICENSE.txt for details
 
 #include "StdAfx.h"
+
 #include "SplashExample.h"
 
 #include <CryRenderer/IRenderer.h>

Code/SplashExample.cpp

@@ -75,8 +75,6 @@ EEvent == ESYSTEM_EVENT_BEAM_PLAYER_TO_CAMERA_POS? "ESYSTEM_EVENT_BEAM_PLAYER_TO
 EEvent == ESYSTEM_EVENT_CRYSYSTEM_INIT_DONE? "ESYSTEM_EVENT_CRYSYSTEM_INIT_DONE" : \
 EEvent == ESYSTEM_EVENT_PRE_RENDERER_INIT? "ESYSTEM_EVENT_PRE_RENDERER_INIT" : \
 EEvent == ESYSTEM_EVENT_GAMEWINDOW_ACTIVATE? "ESYSTEM_EVENT_GAMEWINDOW_ACTIVATE" : \
-EEvent == ESYSTEM_EVENT_CVAR_REGISTERED? "ESYSTEM_EVENT_CVAR_REGISTERED" : \
-EEvent == ESYSTEM_EVENT_CVAR_UNREGISTERED? "ESYSTEM_EVENT_CVAR_UNREGISTERED" : \
 EEvent == ESYSTEM_EVENT_REGISTER_FLOWNODES? "ESYSTEM_EVENT_REGISTER_FLOWNODES" : \
 EEvent == ESYSTEM_EVENT_CRYSYSTEM_INIT_DONE? "ESYSTEM_EVENT_CRYSYSTEM_INIT_DONE" : \
 EEvent == ESYSTEM_EVENT_GAME_FRAMEWORK_INIT_DONE? "ESYSTEM_EVENT_GAME_FRAMEWORK_INIT_DONE" : "UNKNOWN"

Code/SplashExample.h

@@ -1,6 +1,3 @@
 // Copyright (c) 2017, uniflare, see LICENSE.txt for details
 
-#include "StdAfx.h"
-
-// Included only once per DLL module.
-#include <CryCore/Platform/platform_impl.inl>
+#include "StdAfx.h"

Code/StdAfx.cpp

@@ -30,6 +30,7 @@ as well as an overview of the internal implementation details.
         - Uses the player profile attributes system to store data for GameSDK compatibility**
 		- Untested with multi-display single-desktop span configurations. Probably will not work in these cases.
 		- Initial splash is limited to a minimum size of 512x300, the minimum resolution used by the engine.
+		- Cannot specify custom dll binary output path for release builds - building from source.
 
 	# Initialization
 		Uses system events to try to determine the earliest point in engine init to init required data 

Docs/CONCEPT.txt

@@ -7,7 +7,7 @@ Splash Example Plugin
 	Project templates
 
 # Pre-requisites
-	CRYENGINE version 5.3.x
+	CRYENGINE version 5.4.x
 
     1. Compatible and working CRYENGINE installation either,
         by the official CRYENGINE Launcher, or 
@@ -35,9 +35,14 @@ Splash Example Plugin
 		           |----game.cfg
 		           |----gamedata.cryasset.pak
 		           |----...
-	4. For best results, copy the contents of the supplied 'Assets/SplashExample.cfg' into your GameZero/GameSDK game.cfg file.
+	
+	3b. (GameSDK Only)
+	    For 5.4, you will need to copy the GameSDK dll from the sample project to the matcvhing engine folder, eg
+		C:\Program Files (x86)\Crytek\CRYENGINE Launcher\Crytek\gamesdk_5.4\GameSDK\bin\win_x64\CryGameSDK.dll
+		    to
+		C:\Program Files (x86)\Crytek\CRYENGINE Launcher\Crytek\CRYENGINE_5.4\bin\win_x64\CryGameSDK.dll
 
-	5. (Right-Click) Launch Game using one of the provided cryproject files 
+	4. (Right-Click) Launch Game using one of the provided cryproject files 
 		'SplashExamplePlugin_GameZero', or 'SplashExamplePlugin_GameSDK'
 
 	Note: By default these projects are set to use the official engine 
@@ -46,19 +51,14 @@ Splash Example Plugin
 # Installation/Integration into your project
 
 	# Using pre-built binary for windows (x64 only)
-		1. CE 5.3 makes use of cryplugin.csv file to load required plugins for the project,
-		    you must make sure the line from the supplied file is added to the cryplugin.csv 
-			responsible for your desired project.
+		1. CE 5.4 removes the cryplugin.csv file and takes CVARS in the respective cryproject file, 
+		    be sure to copy necessary cvar entries (look to the supplied cryproject files for reference).
 
 		2. This package contains custom texture assets that must be bundled with your desired 
-		    project assets, a simple 'drag & drop' from `Assets/SplashExample` to 
-			to your `Project/Assets/SplashExample` will suffice.
-		
-		3. Due to compatiblity reasons with the player profiles manager certain CVARS should 
-		    be set in either your system.cfg or game.cfg files in use by your project. To begin, 
-			some example CVARS are provided in the `Assets/SplashExample.cfg` file.
+		    project assets, a simple 'drag & drop' from `Assets/SplashExamplePlugin` to 
+			to your `Project/Assets/SplashExamplePlugin` will suffice.
 
-		4. Make sure the binary (SplashExample.dll) is bundled with your own project binary, 
+		3. Make sure the binary (SplashExamplePlugin.dll) is bundled with your own project binary, 
 		    this should reside in `Project/bin/win_x64` directory next to any 'Game' dll.
 
 	# Building Splash Example from source
@@ -81,4 +81,4 @@ Splash Example Plugin
 # WARNING
 	It is not reccommended to use the "Switch engine version" feature of the cryproject context menu 
 	for moving from or to different engine versions. Rather, only use this feature to swtich between 
-	locally registered engines of the same version, ie, 'Official 5.3.x' and 'Custom Built-From-Source 5.3.x'.
+	locally registered engines of the same version, ie, 'Official 5.4.x' and 'Custom Built-From-Source 5.4.x'.

Docs/INSTALL.txt

@@ -1,17 +1,16 @@
 Copyright (c) 2017, uniflare, see LICENSE.txt for details
 Splash Example Plugin
 
-Some changes were made during a technical difficulty that resulted in the account associated with this plugin 
-on the marketplace to remove the submitted project. These changes are more on the technical side although 
-some further compatibility was ensured for 5.3 GameSDK project and end-user usage of the plugin was 
-generally made easier.
+Since 1.3.0 for 5.3, migration to 5.4 resulted in a new limitation for building from source - 
+you cannot specify a custom output directory for release builds in the projects cmakelists file.
+Yet, inherited the more robust and compatible cmake system from 5.4. Minor tweaks to code base.
 
 # Usage differences
-	1. The project now comes with two test projects that use GameZero/GameSDK as "Host" projects.
-	2. Further documentation was added in 'Docs' folder.
+	1. CVARS are now put into the respective cryproject files. (No more .cfg editing).
+	2. Necessary data from cryplugin.csv moved into respective cryproject files., csv deleted.
+	3. Renamed DLL name.
 
 # Technical changes
 	*Some things may be missed, check github commits for more detailed information.
 
-	1. The TestPlatform feature from the cmakelists file was defaulted to disabled to 
-	    prevent unwanted folders being created when building from source.
+	No significant technical differences.

Docs/MIGRATION_NOTES.txt

@@ -1,16 +1,27 @@
 {
+    "version": 1,
+    "type": "CRYENGINE Project",
+    "info": { "name": "Splash Example Plugin" },
     "content": {
-        "assets": [
-            "Assets"
-        ],
-        "code": [
-            "Code"
-        ]
-    },
-    "info": {
-        "name": "Splash Example Plugin"
+        "assets": [ "Assets" ],
+        "code": [ "Code" ]
     },
     "require": {
-        "engine": "engine-5.3"
-    }
+        "engine": "engine-5.4",
+        "plugins": [
+            { "type": "EPluginType::Native", "path": "bin/win_x64/SplashExamplePlugin" }
+        ]
+    },
+    "console_variables": [
+        { "name": "splash_show", "value": "1" },
+        { "name": "splash_minimumPlaybackTime", "value": "3.0" },
+        { "name": "splash_show_initial", "value": "1" },
+        { "name": "splash_minimumPlaybackTime_initial", "value": "3.0" },
+        { "name": "splash_texture", "value": "SplashExample/textures/Splash.dds" },
+        { "name": "splash_texture_initial", "value": "SplashExample/textures/InitialSplash.dds" },
+        { "name": "r_width", "value": "512" },
+        { "name": "r_height", "value": "300" },
+        { "name": "r_fullscreenwindow", "value": "1" },
+        { "name": "r_fullscreen", "value": "0" }
+    ]
 }