Forums Gallery LOGIN |REGISTER

[Plugin] Custom Splash Screen (Free Example Plugin)

Please use this forum for questions on C++, Lua, XML, and any other languages used in CryENGINE development.


 

User avatar uniflare__deletedNO6809
Just getting started
Just getting started
 
Posts: 84
Member since: 08.10.2016, 22:48
Likes: 9

[Plugin] Custom Splash Screen (Free Example Plugin)

Postby uniflare__deletedNO6809 » 05.01.2017, 05:37

Splash screen example plugin
GitHub® Project: https://github.com/uniflare/SplashExample
Updated 07/01/2017

Splash Example Plugin is a simple, light-weight splash screen rendering plugin with several features.
  • - Drop and play, once added to the csv, just add your textures to see it in action!
  • - Renders an intial (pre-)Splash texture to the initial window that spawns on game launch
  • - Compatible with engine templates and GameSDK Sample project for 5.3
  • - Several CVars to control the plugin without building from source
  • - CVar splash_show (def 1) Enable/Disable splash plugin
  • - CVar splash_show_initial (def 1) Controls showing the initial splash image
  • - CVar splash_minimumPlaybackTimeA (def 5.0) Initial splash display time in seconds
  • - CVar splash_minimumPlaybackTime (def 10.0) Splash display time in seconds
  • - CVar splash_startTimeOffset (def 0.0) Allows for more accurate splash length
  • - CVar splash_texture_a (def 'SplashExample/textures/splash_a.dds') Initial (pre-) splash texture
  • - CVar splash_texture (def 'SplashExample/textures/splash.dds') Main splash texture
  • - Fully documented code available on github for re-use/educational purposes
  • - Automatically overrides original splash screens (if any)
Requirements:
  • - Cryengine® 5.3
  • - Existing game project
  • - *Prebuilt binary requires 64bit

Video demonstration of installation and usage:
https://www.youtube.com/watch?v=ETcrZusdTMU


Installing/Using the pre built binary
Installing the plugin to an existing project using the pre-built win 64 binaries is easy.
    1. Copy the SplashExample.dll file next to your own Game.dll file (in bin/win_x64 folder)
    2. Merge the Assets directory from the plugin with your games own Assets folder
    3. Add this line to the cryplugins.csv (next to your cryproject file):
Code: Select all
C++;SplashExample;Plugin_SplashExample;SplashExample.dll;Assets

Take note: For the best effect with the initial splash screen you should set r_width and r_height to the same dimensions as the splash_a.dds texture you supply. Also, make sure r_fullscreen is not set to 1 in any cfg and also make sure r_fullscreenwindow is set to 1 to remove window border.. (This is not required for the plugin to work, but not enforcing this will cause the initial splash to flicker between settings)

Building from source
Building is not necessary to use the plugin however it is very easy to do so. Take note the supplied CMakeLists.txt and vcxproj.user.in files have been customized, The debugger launch param is automatically set to the specified game project on generating the solution, whilst upon building, CMake will copy the built SplashExample.dll to the correct location automatically.

To make use of this customization simply modify the variables TestPlatformRoot, TestPlatformPath and TestPlatformProject in the CMakeLists.txt. This is highly advised before generating a solution as a copied dll may just end up cluttering your root drive.

Hope someone finds this useful to learn, or maybe even use in their own projects.
Any feedback appreciated.

GitHub® Project:
https://github.com/uniflare/SplashExample

Cryengine® Marketplace:
https://www.cryengine.com/marketplace/p ... ple-plugin
Last edited by uniflare__deletedNO6809 on 17.01.2017, 13:29, edited 4 times in total.
User avatar Lavizh
Lead Moderator
Lead Moderator
 
Posts: 15317
Member since: 04.12.2007, 03:23
Location: Hamar, Norway
Likes: 1141

Re: [Plugin] Custom Splash Screen (Free Example Plugin)

Postby Lavizh » 05.01.2017, 09:52

Yes please add the plugin to the Marketplace :)
Thanks for doing it.
 
 
Image  Image
User avatar chernecoff
Junior Dev
Junior Dev
 
Posts: 236
Member since: 24.04.2012, 14:04
Location: Russia, Tambov
Likes: 109

Re: [Plugin] Custom Splash Screen (Free Example Plugin)

Postby chernecoff » 05.01.2017, 11:11

Nice job =)
I came back from the army. Ready for work. On all questions write - chernecoff@gmail.com
User avatar uniflare__deletedNO6809
Just getting started
Just getting started
 
Posts: 84
Member since: 08.10.2016, 22:48
Likes: 9

Re: [Plugin] Custom Splash Screen (Free Example Plugin)

Postby uniflare__deletedNO6809 » 05.01.2017, 13:11

No problem, and thanks.
Last edited by uniflare__deletedNO6809 on 07.01.2017, 03:20, edited 1 time in total.
User avatar uniflare__deletedNO6809
Just getting started
Just getting started
 
Posts: 84
Member since: 08.10.2016, 22:48
Likes: 9

Re: [Plugin] Custom Splash Screen (Free Example Plugin)

Postby uniflare__deletedNO6809 » 06.01.2017, 06:00

Updated plugin, added some features to the initial splash display and restructured the instructions and plugin distribution to make usage clearer.
User avatar tothespace
Regular Dev
Regular Dev
 
Posts: 497
Member since: 18.01.2014, 12:36
Location: Gangnam, Seoul, Korea
Likes: 112

Re: [Plugin] Custom Splash Screen (Free Example Plugin)

Postby tothespace » 06.01.2017, 08:15

Thank you for sharing the source. You should put it on the marketplace :)
User avatar asfor_farah
Intern Dev
Intern Dev
 
Posts: 194
Member since: 22.06.2014, 16:17
Location: Iraq
Likes: 38

Re: [Plugin] Custom Splash Screen (Free Example Plugin)

Postby asfor_farah » 06.01.2017, 10:39

Thank you! :)
Check my YouTube channel ^-^ :cheesy: :easter: :
http://www.youtube.com/c/farahsamir

#Asfor
User avatar uniflare__deletedNO6809
Just getting started
Just getting started
 
Posts: 84
Member since: 08.10.2016, 22:48
Likes: 9

Re: [Plugin] Custom Splash Screen (Free Example Plugin)

Postby uniflare__deletedNO6809 » 07.01.2017, 00:17

Lavizh wrote:Yes please add the plugin to the Marketplace :)
Thanks for doing it.
tothespace wrote:Thank you for sharing the source. You should put it on the marketplace :)

I would.. if I could :).
Seems plugins can't be submitted to the marketplace yet, some bugs with the submission forms.
User avatar uniflare__deletedNO6809
Just getting started
Just getting started
 
Posts: 84
Member since: 08.10.2016, 22:48
Likes: 9

Re: [Plugin] Custom Splash Screen (Free Example Plugin)

Postby uniflare__deletedNO6809 » 07.01.2017, 04:45

Updated plugin

Now forces r_fullscreenwindow on startup to remove the window border.
Make sure to set this to 1 in your game/user cfg files to make the startup look seamless.

Also hopefully will get on market place early next week.
User avatar Cry-Nic
Administrator
Administrator
 
Posts: 64
Member since: 11.07.2016, 10:35
Location: Frankfurt Main
Likes: 17

Re: [Plugin] Custom Splash Screen (Free Example Plugin)

Postby Cry-Nic » 12.01.2017, 11:49

unibliss wrote:Seems plugins can't be submitted to the marketplace yet, some bugs with the submission forms.


It's actually being reviewed right now and our guys are looking into it. When during quality control we find any bugs or issues, we will contact you. Please be patient. ;) If you are having any issues at any point with the marketplace, please email marketplace[at]cryengine.com with details.

Cheers,
Nic
Yamina 'Nic' K, Community Manager @CRYENGINE

Follow us on Facebook: /CRYENGINEOfficial
Follow us on Twitter: @CRYENGINE

Get to know me
User avatar uniflare__deletedNO6809
Just getting started
Just getting started
 
Posts: 84
Member since: 08.10.2016, 22:48
Likes: 9

Re: [Plugin] Custom Splash Screen (Free Example Plugin)

Postby uniflare__deletedNO6809 » 12.01.2017, 17:53

Hey Cry-Nic,

Sopo fixed the launcher for me on monday :). And was able to submit my asset. Hopefully it meets the requirements :).

Thanks again
User avatar uniflare__deletedNO6809
Just getting started
Just getting started
 
Posts: 84
Member since: 08.10.2016, 22:48
Likes: 9

Re: [Plugin] Custom Splash Screen (Free Example Plugin)

Postby uniflare__deletedNO6809 » 17.01.2017, 13:29

The plugin has made it to the marketplace!

Go grab it here:
https://www.cryengine.com/marketplace/p ... ple-plugin

Enjoy :)

- Any issues don't hesitate to contact me, thanks.
User avatar thearshadnadeem1
Just getting started
Just getting started
 
Posts: 1
Member since: 08.05.2016, 14:22
Likes: 0

Re: [Plugin] Custom Splash Screen (Free Example Plugin)

Postby thearshadnadeem1 » 28.04.2017, 17:46

hello where is cryplugin.scv file i cant find it and this splash screen is not working for me without this cryplugin .scv file pls hlp