Release 3.3.2

[3.3.2] - 2024-08-27

Added

• feature (sessions): Reworking Sample, P2P Communication Part
• feature(network): Implementing taskNetworkTimeoutSeconds
• feat: Make the EOSSettingsWindow aware of which build targets are available, showing platform-specific options for only those that are.
• feat: Implement function to enumerate the platforms that can be built against.
• feat: Add function to generate a RuntimeConfig struct from the values of an EOSConfig class.
• feat: Add RuntimeConfig struct that stores the totality of the configurable properties used by the plugin during runtime. Also add method to EnumUtility that supports decomposing a bitwise-operator combined enum value into it's constituent discrete components.
• feat: Add upm layout as upm to asset project
• feat: Upgrade targetted version of Unity.
• feat: Add ability configure the plugin to not unload the EOS SDK on shutdown.
• feat(sample,session): Major Session sample rework
• tests: Add unit tests for enum extensions.
• tests: Add unit tests of limited scope.
• tests(sessions): Create and search for sessions
• tests(login): Testing scene for auditing logins

Changed

• chore(tool,import) : dispose result of async task to prevent warnings
• chore(lib,android) : remove unused android libs
• chore(sdk) : updated managed source for 1.16.3 hotfix
• chore (documentation, Lobby): Adding clarifying documentation mentioning subscription
• chore: add additional commenting
• refactor(sessions): Capitalizing action that is a property
• refactor(sessions): Some additional comment cleaning
• refactor(sessions): Prefab instance link fix for friendsTabUI
• refactor(session): Remove vestigial invite, fix ui to update properly first call
• refactor(sessions): Juggling joined session better
• refactor(sessions): Join session after search without member variable
• refactor(sessions): All callers to AcknowledgeEventId cleaned up
• refactor(sessions): AcknowledgeEventId takes in UIEventId argument
• refactor(sessions): Rename to OnFriendStateChanged
• refactor(sessions): MarkFriendsUIDirty => SetDirtyFlag
• refactor(sessions): Rename UIOnPresenceAffectingChange to OnPresenceChange
• refactor(sessions): ownInvitationState -> OwnInvitationState
• refactor(friends ui): Standardized parent handling dirty status instead of implementors
• refactor(sessions): Friend UI Refreshes
• refactor(sessions): Basic Session Invitation for Presence Sessions
• refactor(sessions): Added Friends UI to Sessions Scene
• refactor(sessions): Addressing code review feedback
• refactor(sessions): Session State Management
• refactor(eos_sdk): Move eos_sdk to new upm layout directory
• refactor: switch to static bool to test if EOSManager should unload EOS SDK or not.
• refactor: remove LoadDelegatesWithReflection LoadDelegatesByHand

Fixed

• fix(log,config) : Using default log levels if config file doesn't exist
• fix(fileIO) : remove redundant code
• fix(native,windows) : rebuild win32 versions to remain in sync with win64
• fix(native,config) : Correct log config reader to use Pascal case
• fix(android,fileIO) : remove file check that prevent file reading on android
• fix(log,config) : fix renamed/capitalized config entries
• fix(tool,import) : prevent the editor from being stuck forever after finishing the copy
• fix(import) : updated description according to upm folder migration
• fix: resolve empty asmdef file warning via dummy file.
• fix: Add author details to package.json file.
• fix: Correct minor issue within eos package description where the proper meta files were not being copied correctly.
• fix: Add empty .gitignore files to Editor and Images directories, in-order to prevent Unity from trying to delete the associated meta files.
• fix(mac,eac) : modify the execution bit for mac anticheat integrity tool
• fix(eac,mac) : Mac EAC Settings template
• fix: Correct references to version of unity that is supported.
• fix: Change file select extension to asterisk.
• fix(sample,achievement): General fixes on achievement scene
• fix(eac,tool) : Allow anticheat integrity tool file path to recognize executables with no extension
• fix(service,achievement) : prevent error when fetching product user ID prematurely
• fix: Correct implementation of ConfigEditor so that it can be defaulted to open and work correctly within the EOSUnitTestSettingsWindow.
• fix: Do not set the selected item during each Update(), as doing so makes it impossible for anything but the UIFirstSelected object to have focus.
• fix: Change implementation of EOSFileTransfer to have size properly set so determination of size is not dependent on the contents of the Data byte array.
• fix: Made leaderboard menu hidden, change to have SAMPLE_MENU_DEBUG off by default.
• fix(eosmanager): Manage application shutdown only on Application.quitting
• fix: Correct the implementation of the SetSelected function within SampleMenu to properly determine and set the focused control in the menu.
• fix: Correct implementation of the function that gets the icon texture, by making sure that things are appropriately awaited.
• fix: Corrected implementation of the get and cache data function within AchievementsService.
• fix: Change UICustomInvitesMenu OnEnable function to actually be Awake.
• fix: Change get achievement icon texture to return null on failure, and log a warning in all circumstances of failure.
• fix: Ensure that the base implementation of the 'Hide()' function is called first thing.
• fix: Utilize built-in log function instead.
• fix: Change EOSService to have a default parameter value for the constructor.
• fix: Return EOSSessionsManager to implement the IEOSSubManager interface.
• fix: Fix implementations for logging out and logging in for eos services.
• fix: Change implementation to override and call base implementations for Show/Hide.
• fix: Correct icon loading logic for achievements to better support async.
• fix: Change to use events instead of lists of delegate instances.
• fix: Add proxy call from Hide/Show to call InternalHide/InternalShow.
• fix: Moved various field members for UIParent into base class SampleMenu field member 'UIParent.'
• fix: Move functionality within Start to properly be within the InternalAwake function for UIStoreMenu.
• fix: Update UISessionsMatchmakingMenu to properly hide and/or show when needed.
• fix: Move implementation of awake to base implementation.
• fix: Remove Awake implementation from UITitleStorageMenu, depending instead upon the base implementation of Awake().
• fix: Fold InternalUpdate behavior into base class implementation.
• fix: Move UIFirstSelected to base class.
• fix: Transition to using ISampleMenu as an abstract base class.
• fix: Make the RuntimeConfig a readonly struct.
• fix(eos,disable) : missing EOS_DISABLEs for newly added function calls or files
• fix(test,discord) : disable discord within functions on unsupported platforms
• fix: Place const declaration within proper compiler conditional branch so that it does not trigger a warning about an unused variable.
• fix: Remove obsolete flag from flags field member of SteamConfig.
• fix: Remove bootstrappy config parameters from runtimeconfig.
• fix: Remove unused 'using' statements.
• fix: Add check within ConfigEditor to make sure that Button config fields are only applied to field members of type Action.
• fix: Populate steamApiInterfaceVersionsArray regardless of the success or failure of the parsing of the version.
• fix: Remove field member from EOSSettingsWindow for the SteamConfig file, and any places within that class that reference it.
• fix: Make field member that was errantly public private.
• fix: Restore implementation of SteamManager to what it was before.
• fix: Remove unused code paths.
• fix: Further improvements to the user interface for changing EOS Plugin settings.
• fix(android): Remove config data parameter from configuresystemoptions
• fix: remove extra 'gc' from path for the EOS SDK in package description
• fix: Update input rendering for SteamConfig to put it into the proper editor window.
• fix: Move SteamConfig to Assets/Plugins/Source/Editor/Configs/ directory.
• fix: Rename SteamWorks_Utility to SteamWorksUtility in keeping with the naming conventions used within the project.
• fix(authentication): Theoretical OpenId re-authorization
• fix(authentication): Authentication Tests
• fix(discord): Retry auth on failure
• fix(steam): Steam App and Session authentication re-attempts authentication if token is expired
• fix(Discord): Refresh token is utilized when re-authing
• fix(tests): OnShutdown during TearDown
• fix: Consolidate test functionality of client sessions tests.
• fix: Properly organize tests into mirrored namespace, resolve issues that caused tests to fail (yay! tests helped!)
• fix: Add to gitignore to avoid init scene being added.
• fix: Correct the function used to convert byte array to string by providing the start index and the number of bytes to read.
• fix: Change function signature in EnumUtility to 'GetEnumerator'.
• fix: Re-disable the new runtime config via scripting defines.
• fix: Connect IntegratedPlatformManagementFlags field member to the RuntimeConfig data structure.
• fix(network): Explicit double value as 0.0, Settings debug logs warning when string is invalid
• fix (sessions): Non-Owners of Sessions Cannot Manage State
• fix: Change SandboxId to be string instead of Guid.
• fix: Move conversion from EOSConfig to RuntimeConfig from within EOSConfig to being an implicit conversion operator within RuntimeConfig.
• fix: Correct order of parsing operations.
• fix: Correct strings for descriptions of the flag values.
• fix: Remove unreferenced code path and member within PlatformConfig.
• fix: Correct signature used for configuring the override thread affinity values.
• fix: Re-introduce public methods to EOSM...

Release 3.3.1

[3.3.1] - 2024-07-30

Fixed

• fix(native,log) : log config error handling to prevent crashing
• fix(ui,log) : show correct log levels in UILogWindow on native initialized platforms
• chore(log,config) : update log config fields to Pascal case
• chore(native,windows) : rebuild libs after fixing log config crash

Release v3.3.0

Release v3.3.0 - 2024-07-03

Fixed

• Resolved various issues with the eos_package_description.json file:
  • Moved script files to utilize the recursive feature.
  • Removed duplicate gradle file entries.
  • Corrected directory paths and naming conventions.
  • Improved handling of subdirectories within EOS_SDK/Generated.
• Enhanced package creation:
  • Further refinements to the package description file.
  • Added additional entries and log warnings.
  • Corrected function signatures and async implementation.
  • Fixed UI issues with the progress bar update.
• Addressed merge conflicts and discrepancies in CHANGELOG.md.
• Corrected usage of conditional compilation (#if EOS_DISABLE).
• Fixed handling of missing scripts and unreferenced prefabs.

Merged

• Integrated changes from various branches:
  • fix/create-package-fix
  • fix/duplicate-gradle-file
  • fix/unity-project-tools
  • development
  • release-3.2.1
• Updated the EOSManager to handle new functionalities and interfaces.

Chore

• Updated version numbers and dependencies:
  • Upgraded to Android API Level 33.
  • Resolved merge conflicts and improved documentation.
• Restored gitattributes with eol=lf instructions.
• Removed errant files and redundant code.

Documentation

• Updated the NamingConventionReadme.txt and CHANGELOG.md to reflect recent changes.
• Added documentation for new features and fixes.

Performance

• Improved performance of file copy operations by multi-threading.
• Optimized logging and debugging processes.

New Features

• Integratation of EOS SDK 1.16.3
• Introduced support for StatsManager and async operations.
• Implemented deployment overrides with -epicdeploymentid argument.

Full Changelog: v3.2.1...v3.3.0

Release v3.2.1

[3.2.1] - 2024-06-24

• Fixes

• Release Binary Fixes:
  • Corrects an error that was made when generating the binary package for the 3.2.0 release.
  • Corrects an issue where the presence of the scripting define EOS_DISABLE caused compilation errors.

Release v3.2.0

[3.2.0] - 2024-05-27

New Features

• EOS SDK Upgrade:

  • Upgrade included EOS SDK to version 1.16.2

• Log Configuration:

  • Introduced log configuration during application startup.
  • Added example log level config file.
  • Added editor window for log level config.
  • Added helper for converting strings to enums.

• Project Utilities:

  • Added project utility to scan for common Unity project errors.

Fixes

• General Fixes:

  • Updated Unity Asset settings for standalone Linux builds.
  • Corrected various code-style issues.
  • Fixed grammar and corrected method signatures.

• Scripting Defines:

  • Simplified scripting define conditionals for multiple platforms.
  • Corrected compiler conditionals for Android from Windows Editor.
  • Restored the usage of EOS_DYNAMIC_BINDINGS and other scripting defines.

• Build Improvements:

  • Rebuilt native code binaries for Win64 and Win32.
  • Utilized Task.Run for BuildMac to avoid async warnings.
  • Disabled non-functional window used to install eos zip.

• JSON Utility:

  • Updated JsonUtility to remove Newtonsoft dependency.
  • Added compile-time conditionals for JsonUtility validation tasks.
  • Corrected and simplified JSON handling in various scenarios.

• Factory Pattern and Config Classes:

  • Implemented factory pattern to ensure proper instantiation of Config classes.
  • Added runtime helper for type initializers in factory methods.
  • Added missing using statements and comments.

Documentation and Comments

• Added comments to missing members and methods.
• Improved docfx site generation logic and updated theme.
• Defined EOS_DYNAMIC_BINDINGS constant for docfx builds.

Miscellaneous

• Updated package version numbers and changelog entries.
• Removed deprecated and un-referenced AndroidInitOptions.
• Added .gitignore entries for files generated during docfx generation.
• Tracked Linux libDynamicLibraryLoaderHelper.so with Git LFS.

Release 3.1.3

[3.1.3] - 2024-04-29

Fixed

fix(build,upm) : fix check if deployed from upm or repo
fix(mac) : remove incorrect create option type on mac

Release 3.1.2

[3.1.2] - 2024-04-25

Removed

chore: Remove EOSCreateOptions and EOSInitializeOptions files in favor of defining them within individual PlatformSpecifics files.
chore: Remove commented out code.

Fixed

fix(build,upm) : Compile fixes when running in a upm
fix: Re-order platform if-defs.
fix: Add UpdateNetworkStatus to both interface and abstract implementing class.
fix: Instead of explicitly instantiating config editors, use reflection to determine all platform config editors that exist, and create an instance for each of them in EOSSettingsWindow.
fix: Restore if-def block around IOSPlatformSpecifics.
fix: Return AndroidPlatformSpecifics to prior class name, and correct the config file indicated in .
fix: Allow platform-specifics implementing classes to define the type of config and library extension for the platform.
fix: Remove IEOSCreateOptions helper methods and interface, replacing with implementation.
Fix name of AndroidPlatformSpecifics
fix: Update version number string in EOSPackageInfo.
fix: Correct unity version listing in package.json file.
fix: Remove dependency on Newtonsoft.Json.
fix: Add log error to catching exception when creating builder, as well as throw build failed exception.

Release 3.1.1

Changelog

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.

[3.1.1] - 2024-04-15

Fixed

• Fix file access to be compiler-conditional for Android.
• Make compile-time conditional surrounding interface property match the compile-time conditional surrounding the implementation.
• Add compile-time conditional around WriteAsync override implementation.

[3.1.0] - 2024-04-11

Added

• feat: Added extension methods to be used by sample scripts.
• feat: Moved checks for input to InputUtility class for better abstraction.
• feat: Introduced SceneData asset for improved scene dropdown functionality.
• feat: Implemented placeholder function for potentially returning platform-specific strings to pass to MSBuild.
• feat: Added functionality to the EOSEditorWindow from a separate project that introduced some new functionality.
• feat: iOS bluetooth audio support.
• feat: Allowed custom RTC options for more flexible RTC configuration.
• feat: Implemented await/async pattern for editor windows.
• build: Introduced BuildRunner, and PlatformSpecificBuilder classes to streamline the build process.
• feat: Updated to EOS SDK 1.16.1 for Windows, Android, Linux, iOS, macOS.
• build: Compile new versions of the x64 binaries DynamicLibraryLoaderHelper and GfxPluginNativeRender.
• build: Fix prebuild task on Windows that generates native code DLLs.

Fixed

• fix: Fixed issue in EOSLobbyManager where conditional was not completely accurate.
• fix: Corrected some issues with scripting defines that broke when Unity editor is not in use.
• fix: Resolved error caused by some code accidentally not being between EOS_DISABLE blocks.
• doc: Updated documentation to expand list of supported platforms.
• fix: Restored config values being written to disk - but had them written outside of the Assets directory.
• fix: Fixed misleading comment in Config Editor.
• doc: Added note regarding the 32-bit build process for Windows.
• fix: Addressed Press to talk lag in RTC.
• fix: Corrected the configuration and handling of Bootstrapper and EAC setups.
• fix: Fixed package description to resolve issues with package creation and subsequent plugin importing.
• fix: Renamed invalidAuthType to connect to clarify functionality.

##[3.0.3] - 2023-11-14

Inprogress

Unreleased

Added

doc : Added documentation for exporting the plugin via command line.
feat(overlay) : Added functionality to leave a lobby with the overlay.
feat : Added application shutdown callbacks to EOS Manager.
feat : Added Easy Anti Cheat (EAC) violation callback and documentation.

Changed

doc : Updated documentation formatting.
doc : Swapped plugin logo for one that is shorter.

Removed

remove(assembly) : Clean out Text Mesh Pro assembly references.

Fixed

fix(P2P) : Do not receive a packet size of 0.
fix : Fix platform native lib output path.

##[3.0.2] - 2023-10-27

Inprogress

doc : Documentation style overhaul
feat : command line tools

Unreleased

Added

doc : Added images for increasing the size of the system image for a linux vm, moved optional items from one document to the other, and put information about expanding the disk size post ubuntu installation toward end of guide in case it's something people forget to do.
doc : Added section in the contributors notes for setting up Linux and Windows development environments.
doc : Added section for Linux environment setup.
doc : Added step labels to each of the linux environment setup documents.
doc : Added images and markdown files documenting how to set up a linux development environment.
tidy : Added directory to gitignore file that is created when docfx is run.
tidy : Added git ignore to ignore files that docfx generates inside of the api directory.
scripts(env) : Added linux setup script.
scripts(env) : Added commands to install the editor, get a license, and build the project.
scripts(env) : Added no-sandbox switch to unity editor install command.
scripts(env) : Added sudo before unity editor install command.
scripts(env) : Added command to install Unity Editor.
scripts(env) : Added auto confirm to all the apt commands.
scripts(env) : Added accept package agreements switch.
scripts(env) : Added error action preference.
feat : Added functionality to close the readme if it is open.

Changed

doc : Update HyperV_Linux_Guest_VM.md
doc : Moved the note about setup script to the end of the Windows section.
doc : Fixed formatting on environment setup section of README document.
doc : Fixed text to match the image.
doc : Updated the linux setup script.
doc : Update doc_style_guide.md
doc : Updated documentation to reflect the changes to the unity package creation tool.
doc : Refine directory description
doc(steam) : Fixes for PR
doc(steam) : readme_steam.md
doc(android) : link to environment setup
doc(android) : environment_setup_android.md
feat(input) : Use the input module selector in scenes
feat(input) : Instantiate input module on Awake
chore(input) : rename event system prefab
revert(scene) : Use input manager on sample scenes for public repo
revert(input) : use input manager on public repo
scripts(env) : Updated linux setup script.
scripts(env) : Updated add-apt-repository command to auto confirm.
scripts(env) : chmod +x for the linux setup script.
scripts(env) : Updated comment at top of setup-windows.ps1 for clarity.
scripts(env) : Moved visual studio installation winget command to the end of the file.
tidy : Changed directory where EOSPluginEditorConfig places configuration files from the root into the etc directory, and added appropriate directory to a gitignore file.
tidy : Moved scripts to tools directory.
tidy : Moved EAC from bin to tools/bin
tidy : Moved EOSBootstrapper.exe from bin to tools/bin
tidy : Moved EOSBootstrapperTool.exe from bin to tools/bin directory.
tidy : Moved NativeCode into 'lib' directory.
tidy : Moved docfx_project to etc/docfx, updating all references to the directory in both code and documentation.
tidy : Moved PlatformSpecificAssets directory into etc directory, updating all code and documentation references.
tidy : Renamed license and readme files to have their case be more canonical.
tidy : Moved PackageDescriptionConfigs to etc/PackageConfigurations, and updated all references to the directory in both documentation and code.
tidy : Re-introduced .json description for internal use.
tidy : Renamed EOSUnityPlugin_package_template simply 'PackageTemplate', and moved it into the etc directory, updating all references to files in that path.
tidy : Removed unreferenced, or otherwise unused files.
tidy : Moved accessible-urls.txt file to etc directory.
tidy : Moved JSON to advanced section that is collapsed, and simplified the code inside the UnityPackageCreationTool

Removed

doc : Removed references to LaTeX, and removed the requirement to append a link tag to the end of sub subsections, since GitHub handles that automatically.
doc : Removed markdown reference, and templates.
doc : Removed references to readme style guide and templates for the time being. They will be re-introduced once all the documentation has been updated to conform to this style guide, as doing so will likely alter the guide itself as well as the subsequently defined templates.
chore : clean up stray meta file
remove(login) : scheme protocol temp fix
remove(pkg) : remove input system upm
remove : old Invoke-WebRequest line.
tidy : Removed Brewfile (as it exists within the scripts directory).
tidy : Removed previously checked in docfx generated api yml files.
tidy : Removed the license acquisition and build commands for the linux script.
tidy : Remove dnf package manager usages.
tidy : 'Custom Build Directory' in favor of using a single output directory when creating a package. Also added dialog box for when the custom build directory has not been selected.

Fixed

fix : Correct file/directory paths to make sense
fix : Correct bin/bin to bin.
fix : correct asmdef path
fix : rename steam utility asmdef for pkg description to recognize it
fix(tool) : build .unitypackage
fix : installing aar by folder
fix(assembly) : AlwaysLinkAssembly only on standalone. (not on editor)
fix : Made it so readme could be null and the world would not end.
fix : bug with .unitypackage creation that was causing null reference stuff.
scripts(env) : Updated mac os shell script to have proper path to sh
scripts(env) : Fixed editor version path stuff.
scripts(env) : Fixed some of the commands.
scripts(env) : Fixed the line for visual studio community.
script(env) : Added setup scripts to scripts directory.

##[3.0.1] - 2023-09-22

Inprogress

Unreleased

Added

• Facepunch steamworks login support - squashed

Changed

Removed

Fixed

• fix : compile error when EOS_DISABLE
• fix : remove duplicate asmrefs

##[3.0.0] - 2023-09-15

Inprogress

Unreleased

Added

• Introduced warnings for when platforms in preview are being used (this is instead of requiring a flag to enable them in build settings)
• feat: introduce options for different build types from the command line.
• feature : Manual remove persistent auth token
• feat: Add config value to EOSConfig to allow setting the isServer flag.
• initial Oculus connect code

Changed

• feat: modifications and additions to get EOS SDK 1.16 working.
• update(windows, android, linux, iOS, macOS): update to EOS SDK 1.16
• Updated documentation to use new logo and title.
• UI Menu Consolidation
• Moved Version to the end of the menu.
• Moved Install EOS Zip into Tools / EOS Plugin
• Updated readme_macOS.md to reflect the correct position for EOS Plugin preferences, and deleted the remaining meta file for UIUGFitAnchors.cs....

Release 3.1.0

[3.1.0] - 2023-03-25

Added

• feat: Added extension methods to be used by sample scripts.
• feat: Moved checks for input to InputUtility class for better abstraction.
• feat: Introduced SceneData asset for improved scene dropdown functionality.
• feat: Implemented placeholder function for potentially returning platform-specific strings to pass to MSBuild.
• feat: Added functionality to the EOSEditorWindow from a separate project that introduced some new functionality.
• feat: iOS bluetooth audio support.
• feat: Allowed custom RTC options for more flexible RTC configuration.
• feat: Implemented await/async pattern for editor windows.
• build: Introduced BuildRunner, and PlatformSpecificBuilder classes to streamline the build process.
• feat: Updated to EOS SDK 1.16.1 for Windows, Android, Linux, iOS, macOS.
• build: Compile new versions of the x64 binaries DynamicLibraryLoaderHelper and GfxPluginNativeRender.
• build: Fix prebuild task on Windows that generates native code DLLs.

Fixed

• fix: Fixed issue in EOSLobbyManager where conditional was not completely accurate.
• fix: Corrected some issues with scripting defines that broke when Unity editor is not in use.
• fix: Resolved error caused by some code accidentally not being between EOS_DISABLE blocks.
• doc: Updated documentation to expand list of supported platforms.
• fix: Restored config values being written to disk - but had them written outside of the Assets directory.
• fix: Fixed misleading comment in Config Editor.
• doc: Added note regarding the 32-bit build process for Windows.
• fix: Addressed Press to talk lag in RTC.
• fix: Corrected the configuration and handling of Bootstrapper and EAC setups.
• fix: Fixed package description to resolve issues with package creation and subsequent plugin importing.
• fix: Renamed invalidAuthType to connect to clarify functionality.

Release 3.0.3

[3.0.3] - 2023-11-14

Inprogress

Unreleased

Added

doc : Added documentation for exporting the plugin via command line.
feat(overlay) : Added functionality to leave a lobby with the overlay.
feat : Added application shutdown callbacks to EOS Manager.
feat : Added Easy Anti Cheat (EAC) violation callback and documentation.

Changed

doc : Updated documentation formatting.
doc : Swapped plugin logo for one that is shorter.

Removed

remove(assembly) : Clean out Text Mesh Pro assembly references.

Fixed

fix(P2P) : Do not receive a packet size of 0.
fix : Fix platform native lib output path.