Roadmap

CURRENTLY WORKING ON:

• Creating master trigger script which removes the need for 6 different similar scripts for appropriate systems

January 2025 - V1.7.0 (IN DEVELOPMENT) - Last Updated 14-Jan-25

• Added brand new persistence bool to all managers so you can specify if you want to keep managers / singletons between scenes

• Added null checks for Examine, Flashlight, Keypad, Phone, Fuse box, Safe System, Valve System

• Added isPlaying & FadeOut to audio manager for easier usage for system

NEW FPS Controller & New Functionality

• Added new camera zoom script to aid looking at smaller objects called AKCameraZoom

  • Camera zoom is disabled in disable manager and within it's own script based on GameState script

• Added newer FPS Controller called AKFPSController

  • Added basic movement, camera rotation and old input system

  • Added canMove & canRotate as a way to disable camera and/or player movement

    • Added SetPlayerDisableMode method so this could be used in other scripts for better understanding

  • Added jumping functionality for more realism

    • Added jumping sound logic and only jumps when in the air

  • Added sprinting functionality

  • Added SetMovementSpeed method so we can change movement speeds more easily and disable crouching if movement speed is too slow

  • Added footstep functionality when both sprinting and walking

  • Added crouching functionality

    • Limited player movement speed when crouching

    • Added Ctrl key to make crouch happen

Main System Re-write:

• Basic item collectable interactions use an Interface so an event driven approach for all inputs, making systems work more fluidly, when not looking

• AKInteractor now handles all basic input logic for looking, button pressing, holding and item name highlighting

• AKItem is now re-written to use an Interface so it can all be event driven

• Added brand new GameState global script to manage when you're inside invenntory, examining or otherwise. So you can easily negate certain systems and stop unwanted interactions

• Created new AKMasterTrigger to be used across all systems rather than seperate scripts which share similar logic

AudioManager

• Created brand new custom inspector so all sound Scriptables can be categorised

• Created brand new category in Sound ScriptableObject so all systems could be organised

• Added new options in the inspector for adding a sound to the array or creating some with a button press for easier creation

• Added a button to the top of the inspector to show default inspector incase the user needs to access the original array fields

Disable Manager

• Removed all references to third person controller

• Added functionality for disabling mouse cursor

• Added new tips with custom inspector, added nullref checks to help with setup issues on start and optimised the main script with less redundancy

AKPromptManager

• Created a brand new prompt manager to control prompts that will appear during each system usage

• You can now set specific lower section prompts for each system

AKUIManager

• Move examine system highlight UI's to new section within custom editor for highlighting settings

• Make this custom editor have dropdowns rather than tickboxes

• Created custom editing variables for examine and pickup prompt buttons

• Added customisation for button prompts on highlighting

AKItem:

• Added warning message in custom editor for telling the user when ticking "Show Examine Prompt" that an ExaminableItem script should be on the object

• Have option for allow examine and/or allow take/ pickup?

• Make sure this highlighting is cleaned up

• Added emission highlight to this script from the examine system

• Emission highlighting now automatically works for child gameobjects with mesh renderers

• Added custom editor note for empty parent and child types

NoteSystem

• Need to add null checks

• Add customising font via TMP in controller script?

• Custom reverse note editor has long name? Remove custom from name?

• Converted all UI elements to TMP and updated all UI managers

Basic Door System

• Added new interactive door option for the object itself

• Added new red button model with PBR textures

Chess System

• Updated all scripts from CP to Chess - So all scripts having better naming conventions

Lever System

• Created a custom editor for LeverItem to remove the sound option for fuse box item

Generator System

• Split this into separate scripts like others?

• Add null checks

• Convert all to TMP

• Jerry can UI name change?

• Added new audio effects to the system

  • Added brand new looped generator filling audio

  • Added brand new jerrycan pickup audio

• Changed UI design for generator inventory to be more professional and en keeping with other assets

• GeneratorItem script Improvements:

  • Fuel barrel can now be set to unlimited usage

  • Made sure collected Jerrycan updates inventory fuel as it didn't work as intended

  • Added brand new functionality for being able to turn the generator on and off on the keypress

  • Added a new audio for looping and sound pouring

  • Added functionality to fill the generator over-time using a long keypress

    • Added new fillrate field for customisation

Gas Mask System:

• Updated GMHealthManager to match v1.4 of the single asset which includes new optimisations, new ways to control health and split into helpeful methods for more consistency

• Renamed Visor UI to "UI - Gas Mask Visor Overlay" for more consistency

• Added null checks for all Gas Mask UI and other UI manager related elements

• Added functionality to reference new FPSController rather than old one

• Renamed all Gas Mask related inventory elements

• Convert all text UI elements to TMP

  • Edited the AKUIManager to reference this change for TMP

Themed Key System:

• Added null checks for all UI elements

Valve / Pipe System:

• Added null checks for all UI elements, including arrays

• Renaming ValveSliderContainerUI to best match other elements of the system

• Removed the CanvasGroup from the progress container and optimised the code to disable the object rather than using the group

Safe System

• What about big interaction collider over SafeModel and when the door is opened, that is turned off and the main body colliders come on?

• Fixed an issue where safe UI numbers didn't update on the next tumbler press (Visual bug rather than anything that stopped the system working effectively)

• Created brand new single colliders around the skeleton of the safe, so interactions for items can be used within the safe (When opened) - Large colliders won't get in the way

• Created new input name to SafeCloseKey and added to input manager script

• Rename Safe Model reference in Safe Controller / Trigger to Safe Interaction

• Remove collider from Safe - Model and added to Safe - Door

• Renamed all UI elements to be consistent with other systems

  • Updated all UI elements to TMP

• Created a new parent for Safe UI for easier disabling

Fuse Box System

• Created a custom editor for fuseItem to remove the sound option for fuse box item

• Added null checks to UIManager script to avoid missing reference issues

• Converted UI elements to TMP

Keypad System

• Updated Keyboard Sci-Fi UI elements to TMP

• Updated Keypad Sci-Fi elements to TMP

• Updated Keypad modern UI elements to TMP

  • Renamed all UI elements and organised for better debugging

• Updated UI manager to reflect TMP additions

  • Added null checks for all fields related to keypad system

Phone System

• Updated Mobile phone UI elements to TMP

• Updated Payphone UI elements to TMP

• Updated Office phone UI elements to TMP

  • Renamed all UI elements and organised those for better usage

• Updated UI manager to reflect TMP additions

  • Added null checks for all fields related to phone system for easier debugging

Flashlight System

• Removed the FlashlightBaseClass script as it wasn't relevant

  • Refined all logic into the FlashlightItem script

• Removed the custom editor and now allows a certain amount of batteries to be collected on flashlight pickup

• Added a new check within the update method to check the GameState to see if the player would be busy, interacting, examining or in the inventory and stop the flashlight battery from decreasing

• Added "Should persist" option to the flashlight controller, so user can choose whether this should be destroyed between scenes

• Converted Flashlight battery parent UI text to TMP

• Removed some raycast targets on the UI to avoid interaction issues

• You may pick up multiple batteries initially if the flashlight controller has more than 0 Battery Count at the start. Fix this by adding 0 to this field

• Fixed an issue where the flashlight wouldn't appear in the inventory even if the HasFlashlight bool was checked

• Added null checks for UI manager

Examine System

• Added global static for isExamining so we can turn off raycast and stop unwanted interactions

• Removed all highlighting logic and emission logic from this script and moved to the AKItem & AKUIManager

  • Clean this up fully

• Added E to collect to AKPromptManager based on examinableItem script

• Fix part of examine script which allows us to pickup item when examining

• Edited Basic & Right Sided Examine UI

  • Expanded parent UI element for better usage

  • Recreated all text elements to TMP

  • Renamed all elements

  • Added TMP to Empty Close Button UI elements

  • Renamed and TMP added to Examine Help Panel UI elements

• Changed the UI Manager now references the TMP type text

  • Fixed all font style issues when converting to TMP

  • Changed Interaction naming to Highlight name for name highlight system

  • Added UI debugs to UI manager for examine system

APK Support Hub Fixes

• Rewritten APK hub description

• Added Write Review button and re-arranged button layout

• Updated header image for V1.7

• Added a new Dont Open Automatically check box so user can choose to stop this opening automatically but still open via Window > Adventure Kit Support Hub

Documentation Updates

• Which UI objects need to be disabled by default at start for all systems

  • AK - Phone Canvases

    • All individual canvases needs to be disabled by default

• Comments for more scripts and in-depth information

• Mention all global states: isExamining (ExaminableItem)

• Mention new FadeOut for audio manager as seen in GeneratorItem

• Add page about key buttons, inputs and presses

• Add more details to where inputs are located in each script

• Mention AKMasterTrigger to replace all other triggers, may need to mention in individual assets

• Mention new FPSController

• Mention new AKCameraZoom

• Gas Mask System

  • Mention about setting player speeds using my new controller

  • Also mention using another character controller

• Safe System

  • Mention that if you rename any objects (Door / Handle) this will cause animations to be lost on the models

  • Mention Safe Model has animations

  • Mention Door has the AKItem & SafeItem

• Inventory Canvas UI - OFF

  • UI_Left_ButtonContainer - ON

    • All items inside - OFF

New Additions:

• New Demo Scene

• Keycard System

Improvements:

• Make sure all UI elements have (Start Disabled) if they're required

• Always make sure all UI elements have a container, rather than disabling the entire canvas

• Check UI Manager and make sure all true/false boolean visible checks are optimised

• Check all systems to make sure they have all UI elements in CheckField

• Check all systems to make sure they have the correct tag and layers

• Clean up UI manager script

• Make sure all systems have good input names

• Make sure all names and descriptions fit into examine system text box (Lower font?)

• Need new folder structure for scripts

• AKStartup should have information about all pipelines?

• Rewrite and check all startup messages

• Add debug log removed in scripts (As per debug settings)

• Add scriptableobject creation in Menu: APK > ScriptableObjects

-------------------------------------------------------------------------

• Check all scripts for useless code or comments that aren't relevant

Final Exporting

• Add separate .unitypackages for each pipelines to make installation easier

• Test each pipeline against documentation

Promotional:

• Create brand new trailer: Example

---------------------------------------------------------------------------

V1.8 Update List:

New Additions:

• Door Interaction Kit

System Updates

• Note System:

  • Update Note System to v2.0

  • Add custom inventory with selector tab

• Update all relevant systems to work with new inventory system

Input System:

• Add functionality for new input system (Create tutorial in documentation and mention in description)

Recreate Third Person Controller functionality:

• Make sure this scene uses the newer Unity TPS controller

Inventory System:

• Brand new inventory system with 2 tiered functionality

  • Add title and description in a space relevant for each object in inventory

  • Make sure all collectable items use ScriptableObjects for collecting

• JSON save system

Fixes / Updates:

• Combine keypad & phone system together