diff --git a/docs/FRAMEWORK_ARCHITECTURE.md b/docs/FRAMEWORK_ARCHITECTURE.md index 08f4529..84bf9fe 100644 --- a/docs/FRAMEWORK_ARCHITECTURE.md +++ b/docs/FRAMEWORK_ARCHITECTURE.md @@ -6,7 +6,7 @@ handlers, and optional browser UI. ## Runtime Flow -![Architectural Flow Diagram](architecture-flow.svg) +![Architectural Flow Diagram](images/architecture-flow.svg) ```text Arma client UI or SQF action diff --git a/docs/MISSION_DESIGNER_GUIDE.md b/docs/MISSION_DESIGNER_GUIDE.md index 6be9a86..18f4bfe 100644 --- a/docs/MISSION_DESIGNER_GUIDE.md +++ b/docs/MISSION_DESIGNER_GUIDE.md @@ -153,9 +153,13 @@ airports, bus stops, teleport terminals, or any other mission transport system. The framework owns the menu, billing, cargo scan, and movement logic. The mission only needs placed objects and optional arrival markers. -![Placeholder: Eden transport node object placement](images/eden/transport_node_obj.svg) +![Eden transport location one](images/eden/transport_loc_1.jpg) -![Placeholder: Eden transport node variable name](images/eden/transport_node_var.svg) +![Eden transport location two](images/eden/transport_loc_2.jpg) + +![Eden transport node object placement](images/eden/transport_obj_1.jpg) + +![Eden transport node variable name](images/eden/transport_obj_1_var.jpg) Place transport node objects with these variable names: @@ -177,7 +181,9 @@ transport_arrival_2 transport_arrival_10 ``` -![Placeholder: Eden transport arrival marker placement](images/eden/transport_arrival_marker.svg) +![Eden transport arrival marker placement](images/eden/transport_arrival_mrkr.jpg) + +![Eden transport arrival marker variable name](images/eden/transport_arrival_mrkr_var.jpg) Objects that should be excluded from the nearby cargo scan, such as the actual boat or transport vehicle used as set dressing, should use: @@ -190,7 +196,9 @@ transport_vehicle_2 transport_vehicle_10 ``` -![Placeholder: Eden transport vehicle exclusion object variable name](images/eden/transport_vehicle_var.svg) +![Eden transport vehicle exclusion object placement](images/eden/transport_veh_obj.jpg) + +![Eden transport vehicle exclusion object variable name](images/eden/transport_veh_obj_var.jpg) Minimum Eden setup: diff --git a/docs/PLAYER_GUIDE.md b/docs/PLAYER_GUIDE.md index 277888d..6239185 100644 --- a/docs/PLAYER_GUIDE.md +++ b/docs/PLAYER_GUIDE.md @@ -220,7 +220,7 @@ Transport points let players pay to travel between configured mission locations. They may represent ferries, terminals, air shuttles, or other mission-specific travel points. -![Placeholder: Actor menu Transport action](images/player/transport_menu_action.svg) +![Actor menu Transport action](images/player/transport_menu_action.jpg) Player workflow: @@ -230,7 +230,7 @@ Player workflow: 4. Select a destination from the transport submenu, or select Close to return to the default interaction menu. -![Placeholder: Transport destination submenu](images/player/transport_destination_menu.svg) +![Transport destination submenu](images/player/transport_destination_menu.jpg) The destination price is based on distance. The server charges player bank first, player cash second, then organization credit line fallback when @@ -238,7 +238,7 @@ available. If payment succeeds, the player is moved to the selected arrival point. Nearby eligible vehicles or passengers may be moved with the player when the mission has configured the transport point for cargo movement. -![Placeholder: Transport completion notification](images/player/transport_complete.svg) +![Transport completion notification](images/player/transport_complete.jpg) ## Locker and Virtual Arsenal diff --git a/docs/TRANSPORT_SERVICE_GUIDE.md b/docs/TRANSPORT_SERVICE_GUIDE.md index 67884c3..188dbec 100644 --- a/docs/TRANSPORT_SERVICE_GUIDE.md +++ b/docs/TRANSPORT_SERVICE_GUIDE.md @@ -110,23 +110,31 @@ this setVariable ["transportIncludeCargo", true, true]; Only use overrides when the default `transport*` convention is not appropriate. -## Image Checklist +## Reference Images -Replace these placeholder image references after screenshots are captured: +These screenshots show the default transport setup and player workflow: -![Placeholder: Eden transport node object placement](images/eden/transport_node_obj.svg) +![Eden transport location one](images/eden/transport_loc_1.jpg) -![Placeholder: Eden transport node variable name field](images/eden/transport_node_var.svg) +![Eden transport location two](images/eden/transport_loc_2.jpg) -![Placeholder: Eden transport arrival marker placement](images/eden/transport_arrival_marker.svg) +![Eden transport node object placement](images/eden/transport_obj_1.jpg) -![Placeholder: Eden transport vehicle exclusion object variable name](images/eden/transport_vehicle_var.svg) +![Eden transport node variable name field](images/eden/transport_obj_1_var.jpg) -![Placeholder: Player actor menu transport action](images/player/transport_menu_action.svg) +![Eden transport arrival marker placement](images/eden/transport_arrival_mrkr.jpg) -![Placeholder: Player transport destination submenu](images/player/transport_destination_menu.svg) +![Eden transport arrival marker variable name](images/eden/transport_arrival_mrkr_var.jpg) -![Placeholder: Player transport completion notification](images/player/transport_complete.svg) +![Eden transport vehicle exclusion object placement](images/eden/transport_veh_obj.jpg) + +![Eden transport vehicle exclusion object variable name](images/eden/transport_veh_obj_var.jpg) + +![Player actor menu transport action](images/player/transport_menu_action.jpg) + +![Player transport destination submenu](images/player/transport_destination_menu.jpg) + +![Player transport completion notification](images/player/transport_complete.jpg) ## Mission-Side Code Requirement diff --git a/docs/images/architecture-flow.svg b/docs/images/architecture-flow.svg new file mode 100644 index 0000000..90a5eb1 --- /dev/null +++ b/docs/images/architecture-flow.svg @@ -0,0 +1 @@ +

Arma Client Addon

Server SQF Addon

forge_server callExtension

Rust Extension

forge-services

forge-repositories traits

SurrealDB adapters

SurrealDB

\ No newline at end of file diff --git a/docs/images/eden/.gitkeep b/docs/images/eden/.gitkeep new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/docs/images/eden/.gitkeep @@ -0,0 +1 @@ + diff --git a/docs/images/eden/atm_obj.jpg b/docs/images/eden/atm_obj.jpg new file mode 100644 index 0000000..88afde9 Binary files /dev/null and b/docs/images/eden/atm_obj.jpg differ diff --git a/docs/images/eden/atm_obj_var.jpg b/docs/images/eden/atm_obj_var.jpg new file mode 100644 index 0000000..154dbd8 Binary files /dev/null and b/docs/images/eden/atm_obj_var.jpg differ diff --git a/docs/images/eden/attack_task_mod.jpg b/docs/images/eden/attack_task_mod.jpg new file mode 100644 index 0000000..d1c9f5c Binary files /dev/null and b/docs/images/eden/attack_task_mod.jpg differ diff --git a/docs/images/eden/attack_task_mod_params.jpg b/docs/images/eden/attack_task_mod_params.jpg new file mode 100644 index 0000000..609aacd Binary files /dev/null and b/docs/images/eden/attack_task_mod_params.jpg differ diff --git a/docs/images/eden/attack_task_tgts.jpg b/docs/images/eden/attack_task_tgts.jpg new file mode 100644 index 0000000..5773ff9 Binary files /dev/null and b/docs/images/eden/attack_task_tgts.jpg differ diff --git a/docs/images/eden/bank_obj.jpg b/docs/images/eden/bank_obj.jpg new file mode 100644 index 0000000..0cde286 Binary files /dev/null and b/docs/images/eden/bank_obj.jpg differ diff --git a/docs/images/eden/bank_obj_var.jpg b/docs/images/eden/bank_obj_var.jpg new file mode 100644 index 0000000..b36f2b0 Binary files /dev/null and b/docs/images/eden/bank_obj_var.jpg differ diff --git a/docs/images/eden/blacklist_mrkr.jpg b/docs/images/eden/blacklist_mrkr.jpg new file mode 100644 index 0000000..962582e Binary files /dev/null and b/docs/images/eden/blacklist_mrkr.jpg differ diff --git a/docs/images/eden/blacklist_mrkr_var.jpg b/docs/images/eden/blacklist_mrkr_var.jpg new file mode 100644 index 0000000..477ceb4 Binary files /dev/null and b/docs/images/eden/blacklist_mrkr_var.jpg differ diff --git a/docs/images/eden/cad-visible-task.jpg b/docs/images/eden/cad-visible-task.jpg new file mode 100644 index 0000000..6427894 Binary files /dev/null and b/docs/images/eden/cad-visible-task.jpg differ diff --git a/docs/images/eden/ceo_unit.jpg b/docs/images/eden/ceo_unit.jpg new file mode 100644 index 0000000..699eb98 Binary files /dev/null and b/docs/images/eden/ceo_unit.jpg differ diff --git a/docs/images/eden/ceo_unit_var.jpg b/docs/images/eden/ceo_unit_var.jpg new file mode 100644 index 0000000..a2beee6 Binary files /dev/null and b/docs/images/eden/ceo_unit_var.jpg differ diff --git a/docs/images/eden/create_task_mod.jpg b/docs/images/eden/create_task_mod.jpg new file mode 100644 index 0000000..17681c5 Binary files /dev/null and b/docs/images/eden/create_task_mod.jpg differ diff --git a/docs/images/eden/create_task_mod_params.jpg b/docs/images/eden/create_task_mod_params.jpg new file mode 100644 index 0000000..1f901b7 Binary files /dev/null and b/docs/images/eden/create_task_mod_params.jpg differ diff --git a/docs/images/eden/defend_task_mod.jpg b/docs/images/eden/defend_task_mod.jpg new file mode 100644 index 0000000..86732a9 Binary files /dev/null and b/docs/images/eden/defend_task_mod.jpg differ diff --git a/docs/images/eden/defend_task_mod_params.jpg b/docs/images/eden/defend_task_mod_params.jpg new file mode 100644 index 0000000..5844a8c Binary files /dev/null and b/docs/images/eden/defend_task_mod_params.jpg differ diff --git a/docs/images/eden/defend_zone_mrkr.jpg b/docs/images/eden/defend_zone_mrkr.jpg new file mode 100644 index 0000000..143a14d Binary files /dev/null and b/docs/images/eden/defend_zone_mrkr.jpg differ diff --git a/docs/images/eden/defend_zone_mrkr_var.jpg b/docs/images/eden/defend_zone_mrkr_var.jpg new file mode 100644 index 0000000..51400ac Binary files /dev/null and b/docs/images/eden/defend_zone_mrkr_var.jpg differ diff --git a/docs/images/eden/defuse_explosives_mod.jpg b/docs/images/eden/defuse_explosives_mod.jpg new file mode 100644 index 0000000..301f699 Binary files /dev/null and b/docs/images/eden/defuse_explosives_mod.jpg differ diff --git a/docs/images/eden/defuse_protected_mod.jpg b/docs/images/eden/defuse_protected_mod.jpg new file mode 100644 index 0000000..4ef8c6a Binary files /dev/null and b/docs/images/eden/defuse_protected_mod.jpg differ diff --git a/docs/images/eden/defuse_task_mod.jpg b/docs/images/eden/defuse_task_mod.jpg new file mode 100644 index 0000000..c463663 Binary files /dev/null and b/docs/images/eden/defuse_task_mod.jpg differ diff --git a/docs/images/eden/defuse_task_mod_params.jpg b/docs/images/eden/defuse_task_mod_params.jpg new file mode 100644 index 0000000..39f5e86 Binary files /dev/null and b/docs/images/eden/defuse_task_mod_params.jpg differ diff --git a/docs/images/eden/delivery_cargo_mod.jpg b/docs/images/eden/delivery_cargo_mod.jpg new file mode 100644 index 0000000..d2c39a8 Binary files /dev/null and b/docs/images/eden/delivery_cargo_mod.jpg differ diff --git a/docs/images/eden/delivery_task_mod.jpg b/docs/images/eden/delivery_task_mod.jpg new file mode 100644 index 0000000..d080ed2 Binary files /dev/null and b/docs/images/eden/delivery_task_mod.jpg differ diff --git a/docs/images/eden/delivery_task_mod_params.jpg b/docs/images/eden/delivery_task_mod_params.jpg new file mode 100644 index 0000000..462c3f7 Binary files /dev/null and b/docs/images/eden/delivery_task_mod_params.jpg differ diff --git a/docs/images/eden/delivery_zone_mrkr.jpg b/docs/images/eden/delivery_zone_mrkr.jpg new file mode 100644 index 0000000..86b7fe3 Binary files /dev/null and b/docs/images/eden/delivery_zone_mrkr.jpg differ diff --git a/docs/images/eden/delivery_zone_mrkr_var.jpg b/docs/images/eden/delivery_zone_mrkr_var.jpg new file mode 100644 index 0000000..1610cac Binary files /dev/null and b/docs/images/eden/delivery_zone_mrkr_var.jpg differ diff --git a/docs/images/eden/destroy_task_mod.jpg b/docs/images/eden/destroy_task_mod.jpg new file mode 100644 index 0000000..5228cec Binary files /dev/null and b/docs/images/eden/destroy_task_mod.jpg differ diff --git a/docs/images/eden/destroy_task_mod_params.jpg b/docs/images/eden/destroy_task_mod_params.jpg new file mode 100644 index 0000000..214f986 Binary files /dev/null and b/docs/images/eden/destroy_task_mod_params.jpg differ diff --git a/docs/images/eden/destroy_task_tgts.jpg b/docs/images/eden/destroy_task_tgts.jpg new file mode 100644 index 0000000..b03eb61 Binary files /dev/null and b/docs/images/eden/destroy_task_tgts.jpg differ diff --git a/docs/images/eden/dispatch_unit.jpg b/docs/images/eden/dispatch_unit.jpg new file mode 100644 index 0000000..f06242f Binary files /dev/null and b/docs/images/eden/dispatch_unit.jpg differ diff --git a/docs/images/eden/dispatch_unit_var.jpg b/docs/images/eden/dispatch_unit_var.jpg new file mode 100644 index 0000000..7bbb6c1 Binary files /dev/null and b/docs/images/eden/dispatch_unit_var.jpg differ diff --git a/docs/images/eden/garage_obj.jpg b/docs/images/eden/garage_obj.jpg new file mode 100644 index 0000000..007f78d Binary files /dev/null and b/docs/images/eden/garage_obj.jpg differ diff --git a/docs/images/eden/garage_obj_1.jpg b/docs/images/eden/garage_obj_1.jpg new file mode 100644 index 0000000..43f5c02 Binary files /dev/null and b/docs/images/eden/garage_obj_1.jpg differ diff --git a/docs/images/eden/garage_obj_1_var.jpg b/docs/images/eden/garage_obj_1_var.jpg new file mode 100644 index 0000000..e18015f Binary files /dev/null and b/docs/images/eden/garage_obj_1_var.jpg differ diff --git a/docs/images/eden/garage_obj_2.jpg b/docs/images/eden/garage_obj_2.jpg new file mode 100644 index 0000000..c037992 Binary files /dev/null and b/docs/images/eden/garage_obj_2.jpg differ diff --git a/docs/images/eden/garage_obj_2_var.jpg b/docs/images/eden/garage_obj_2_var.jpg new file mode 100644 index 0000000..bec80db Binary files /dev/null and b/docs/images/eden/garage_obj_2_var.jpg differ diff --git a/docs/images/eden/garage_obj_var.jpg b/docs/images/eden/garage_obj_var.jpg new file mode 100644 index 0000000..8ddf8a0 Binary files /dev/null and b/docs/images/eden/garage_obj_var.jpg differ diff --git a/docs/images/eden/garage_spawn_1_mrkr.jpg b/docs/images/eden/garage_spawn_1_mrkr.jpg new file mode 100644 index 0000000..e9ed1a5 Binary files /dev/null and b/docs/images/eden/garage_spawn_1_mrkr.jpg differ diff --git a/docs/images/eden/garage_spawn_1_mrkr_var.jpg b/docs/images/eden/garage_spawn_1_mrkr_var.jpg new file mode 100644 index 0000000..fad27f3 Binary files /dev/null and b/docs/images/eden/garage_spawn_1_mrkr_var.jpg differ diff --git a/docs/images/eden/garage_spawn_2_mrkrs.jpg b/docs/images/eden/garage_spawn_2_mrkrs.jpg new file mode 100644 index 0000000..31b1ec1 Binary files /dev/null and b/docs/images/eden/garage_spawn_2_mrkrs.jpg differ diff --git a/docs/images/eden/garage_spawn_mrkrs.jpg b/docs/images/eden/garage_spawn_mrkrs.jpg new file mode 100644 index 0000000..a42ea77 Binary files /dev/null and b/docs/images/eden/garage_spawn_mrkrs.jpg differ diff --git a/docs/images/eden/hostage_entities_mod.jpg b/docs/images/eden/hostage_entities_mod.jpg new file mode 100644 index 0000000..93b01fd Binary files /dev/null and b/docs/images/eden/hostage_entities_mod.jpg differ diff --git a/docs/images/eden/hostage_ext_zone_mrkr.jpg b/docs/images/eden/hostage_ext_zone_mrkr.jpg new file mode 100644 index 0000000..8743ff7 Binary files /dev/null and b/docs/images/eden/hostage_ext_zone_mrkr.jpg differ diff --git a/docs/images/eden/hostage_ext_zone_mrkr_var.jpg b/docs/images/eden/hostage_ext_zone_mrkr_var.jpg new file mode 100644 index 0000000..8f10257 Binary files /dev/null and b/docs/images/eden/hostage_ext_zone_mrkr_var.jpg differ diff --git a/docs/images/eden/hostage_shooters_mod.jpg b/docs/images/eden/hostage_shooters_mod.jpg new file mode 100644 index 0000000..875b620 Binary files /dev/null and b/docs/images/eden/hostage_shooters_mod.jpg differ diff --git a/docs/images/eden/hostage_task_mod.jpg b/docs/images/eden/hostage_task_mod.jpg new file mode 100644 index 0000000..90b1c15 Binary files /dev/null and b/docs/images/eden/hostage_task_mod.jpg differ diff --git a/docs/images/eden/hostage_task_mod_params.jpg b/docs/images/eden/hostage_task_mod_params.jpg new file mode 100644 index 0000000..b12efdb Binary files /dev/null and b/docs/images/eden/hostage_task_mod_params.jpg differ diff --git a/docs/images/eden/hvt_capture_task_mod.jpg b/docs/images/eden/hvt_capture_task_mod.jpg new file mode 100644 index 0000000..6125489 Binary files /dev/null and b/docs/images/eden/hvt_capture_task_mod.jpg differ diff --git a/docs/images/eden/hvt_capture_task_mod_params.jpg b/docs/images/eden/hvt_capture_task_mod_params.jpg new file mode 100644 index 0000000..b78e839 Binary files /dev/null and b/docs/images/eden/hvt_capture_task_mod_params.jpg differ diff --git a/docs/images/eden/hvt_ext_zone_mrkr.jpg b/docs/images/eden/hvt_ext_zone_mrkr.jpg new file mode 100644 index 0000000..8743ff7 Binary files /dev/null and b/docs/images/eden/hvt_ext_zone_mrkr.jpg differ diff --git a/docs/images/eden/hvt_ext_zone_mrkr_var.jpg b/docs/images/eden/hvt_ext_zone_mrkr_var.jpg new file mode 100644 index 0000000..8f10257 Binary files /dev/null and b/docs/images/eden/hvt_ext_zone_mrkr_var.jpg differ diff --git a/docs/images/eden/hvt_task_mod.jpg b/docs/images/eden/hvt_task_mod.jpg new file mode 100644 index 0000000..c60fc88 Binary files /dev/null and b/docs/images/eden/hvt_task_mod.jpg differ diff --git a/docs/images/eden/hvt_task_mod_params.jpg b/docs/images/eden/hvt_task_mod_params.jpg new file mode 100644 index 0000000..9c01bba Binary files /dev/null and b/docs/images/eden/hvt_task_mod_params.jpg differ diff --git a/docs/images/eden/locker_obj.jpg b/docs/images/eden/locker_obj.jpg new file mode 100644 index 0000000..78b0f12 Binary files /dev/null and b/docs/images/eden/locker_obj.jpg differ diff --git a/docs/images/eden/locker_obj_var.jpg b/docs/images/eden/locker_obj_var.jpg new file mode 100644 index 0000000..2e583f9 Binary files /dev/null and b/docs/images/eden/locker_obj_var.jpg differ diff --git a/docs/images/eden/med_spawn_obj.jpg b/docs/images/eden/med_spawn_obj.jpg new file mode 100644 index 0000000..c8942bf Binary files /dev/null and b/docs/images/eden/med_spawn_obj.jpg differ diff --git a/docs/images/eden/med_spawn_obj_var.jpg b/docs/images/eden/med_spawn_obj_var.jpg new file mode 100644 index 0000000..44342f2 Binary files /dev/null and b/docs/images/eden/med_spawn_obj_var.jpg differ diff --git a/docs/images/eden/store_obj.jpg b/docs/images/eden/store_obj.jpg new file mode 100644 index 0000000..f32d1bf Binary files /dev/null and b/docs/images/eden/store_obj.jpg differ diff --git a/docs/images/eden/store_obj_var.jpg b/docs/images/eden/store_obj_var.jpg new file mode 100644 index 0000000..3746315 Binary files /dev/null and b/docs/images/eden/store_obj_var.jpg differ diff --git a/docs/images/eden/transport_arrival_marker.svg b/docs/images/eden/transport_arrival_marker.svg deleted file mode 100644 index 57d8bf6..0000000 --- a/docs/images/eden/transport_arrival_marker.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Eden transport arrival marker placement - Capture an Eden Editor screenshot showing the arrival marker location. - - - PLACEHOLDER IMAGE - Eden: transport arrival marker - Show where players and cargo should spawn. - diff --git a/docs/images/eden/transport_arrival_mrkr.jpg b/docs/images/eden/transport_arrival_mrkr.jpg new file mode 100644 index 0000000..df26a81 Binary files /dev/null and b/docs/images/eden/transport_arrival_mrkr.jpg differ diff --git a/docs/images/eden/transport_arrival_mrkr_var.jpg b/docs/images/eden/transport_arrival_mrkr_var.jpg new file mode 100644 index 0000000..720bbe7 Binary files /dev/null and b/docs/images/eden/transport_arrival_mrkr_var.jpg differ diff --git a/docs/images/eden/transport_loc_1.jpg b/docs/images/eden/transport_loc_1.jpg new file mode 100644 index 0000000..dc64019 Binary files /dev/null and b/docs/images/eden/transport_loc_1.jpg differ diff --git a/docs/images/eden/transport_loc_2.jpg b/docs/images/eden/transport_loc_2.jpg new file mode 100644 index 0000000..be6161f Binary files /dev/null and b/docs/images/eden/transport_loc_2.jpg differ diff --git a/docs/images/eden/transport_node_obj.svg b/docs/images/eden/transport_node_obj.svg deleted file mode 100644 index 2cc6d13..0000000 --- a/docs/images/eden/transport_node_obj.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Eden transport node object placement - Capture an Eden Editor screenshot showing the placed transport access object. - - - PLACEHOLDER IMAGE - Eden: transport node object placement - Show the object players interact with for transport. - diff --git a/docs/images/eden/transport_node_var.svg b/docs/images/eden/transport_node_var.svg deleted file mode 100644 index e6ce554..0000000 --- a/docs/images/eden/transport_node_var.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Eden transport node variable name - Capture the Eden object attributes panel with the transport variable name. - - - PLACEHOLDER IMAGE - Eden: transport variable name - Show transport, transport_1, through transport_10. - diff --git a/docs/images/eden/transport_obj_1.jpg b/docs/images/eden/transport_obj_1.jpg new file mode 100644 index 0000000..cf07c37 Binary files /dev/null and b/docs/images/eden/transport_obj_1.jpg differ diff --git a/docs/images/eden/transport_obj_1_var.jpg b/docs/images/eden/transport_obj_1_var.jpg new file mode 100644 index 0000000..e44056b Binary files /dev/null and b/docs/images/eden/transport_obj_1_var.jpg differ diff --git a/docs/images/eden/transport_veh_obj.jpg b/docs/images/eden/transport_veh_obj.jpg new file mode 100644 index 0000000..04964aa Binary files /dev/null and b/docs/images/eden/transport_veh_obj.jpg differ diff --git a/docs/images/eden/transport_veh_obj_var.jpg b/docs/images/eden/transport_veh_obj_var.jpg new file mode 100644 index 0000000..c026756 Binary files /dev/null and b/docs/images/eden/transport_veh_obj_var.jpg differ diff --git a/docs/images/eden/transport_vehicle_var.svg b/docs/images/eden/transport_vehicle_var.svg deleted file mode 100644 index 71866a0..0000000 --- a/docs/images/eden/transport_vehicle_var.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Eden transport vehicle variable name - Capture the variable name for the transport vehicle that should be excluded from cargo scans. - - - PLACEHOLDER IMAGE - Eden: transport_vehicle variable - Show transport_vehicle, transport_vehicle_1, etc. - diff --git a/docs/images/player/atm_app_home.jpg b/docs/images/player/atm_app_home.jpg new file mode 100644 index 0000000..074d6d4 Binary files /dev/null and b/docs/images/player/atm_app_home.jpg differ diff --git a/docs/images/player/atm_app_pin.jpg b/docs/images/player/atm_app_pin.jpg new file mode 100644 index 0000000..518740f Binary files /dev/null and b/docs/images/player/atm_app_pin.jpg differ diff --git a/docs/images/player/bank_app.jpg b/docs/images/player/bank_app.jpg new file mode 100644 index 0000000..a0a1e15 Binary files /dev/null and b/docs/images/player/bank_app.jpg differ diff --git a/docs/images/player/cad_dispatch_board.jpg b/docs/images/player/cad_dispatch_board.jpg new file mode 100644 index 0000000..f8dd719 Binary files /dev/null and b/docs/images/player/cad_dispatch_board.jpg differ diff --git a/docs/images/player/cad_ops_board.jpg b/docs/images/player/cad_ops_board.jpg new file mode 100644 index 0000000..9ea0970 Binary files /dev/null and b/docs/images/player/cad_ops_board.jpg differ diff --git a/docs/images/player/garage.jpg b/docs/images/player/garage.jpg new file mode 100644 index 0000000..d570a18 Binary files /dev/null and b/docs/images/player/garage.jpg differ diff --git a/docs/images/player/interaction_menu.jpg b/docs/images/player/interaction_menu.jpg new file mode 100644 index 0000000..7ff3dba Binary files /dev/null and b/docs/images/player/interaction_menu.jpg differ diff --git a/docs/images/player/locker.jpg b/docs/images/player/locker.jpg new file mode 100644 index 0000000..59cd0f6 Binary files /dev/null and b/docs/images/player/locker.jpg differ diff --git a/docs/images/player/medical_respawn.jpg b/docs/images/player/medical_respawn.jpg new file mode 100644 index 0000000..c211af5 Binary files /dev/null and b/docs/images/player/medical_respawn.jpg differ diff --git a/docs/images/player/org_dashboard.jpg b/docs/images/player/org_dashboard.jpg new file mode 100644 index 0000000..be15976 Binary files /dev/null and b/docs/images/player/org_dashboard.jpg differ diff --git a/docs/images/player/org_home.jpg b/docs/images/player/org_home.jpg new file mode 100644 index 0000000..a176145 Binary files /dev/null and b/docs/images/player/org_home.jpg differ diff --git a/docs/images/player/org_registration.jpg b/docs/images/player/org_registration.jpg new file mode 100644 index 0000000..9475fc9 Binary files /dev/null and b/docs/images/player/org_registration.jpg differ diff --git a/docs/images/player/org_treasury.jpg b/docs/images/player/org_treasury.jpg new file mode 100644 index 0000000..a338bae Binary files /dev/null and b/docs/images/player/org_treasury.jpg differ diff --git a/docs/images/player/phone_contacts.jpg b/docs/images/player/phone_contacts.jpg new file mode 100644 index 0000000..5a16cdd Binary files /dev/null and b/docs/images/player/phone_contacts.jpg differ diff --git a/docs/images/player/phone_email.jpg b/docs/images/player/phone_email.jpg new file mode 100644 index 0000000..15d90f9 Binary files /dev/null and b/docs/images/player/phone_email.jpg differ diff --git a/docs/images/player/phone_email_example.jpg b/docs/images/player/phone_email_example.jpg new file mode 100644 index 0000000..2b85a58 Binary files /dev/null and b/docs/images/player/phone_email_example.jpg differ diff --git a/docs/images/player/phone_home.jpg b/docs/images/player/phone_home.jpg new file mode 100644 index 0000000..0017134 Binary files /dev/null and b/docs/images/player/phone_home.jpg differ diff --git a/docs/images/player/phone_message_example.jpg b/docs/images/player/phone_message_example.jpg new file mode 100644 index 0000000..a700db0 Binary files /dev/null and b/docs/images/player/phone_message_example.jpg differ diff --git a/docs/images/player/phone_messages.jpg b/docs/images/player/phone_messages.jpg new file mode 100644 index 0000000..e79ad37 Binary files /dev/null and b/docs/images/player/phone_messages.jpg differ diff --git a/docs/images/player/phone_wallet.jpg b/docs/images/player/phone_wallet.jpg new file mode 100644 index 0000000..a9290bb Binary files /dev/null and b/docs/images/player/phone_wallet.jpg differ diff --git a/docs/images/player/store_catalog.jpg b/docs/images/player/store_catalog.jpg new file mode 100644 index 0000000..82e3d08 Binary files /dev/null and b/docs/images/player/store_catalog.jpg differ diff --git a/docs/images/player/store_checkout.jpg b/docs/images/player/store_checkout.jpg new file mode 100644 index 0000000..f01d7ac Binary files /dev/null and b/docs/images/player/store_checkout.jpg differ diff --git a/docs/images/player/transport_complete.jpg b/docs/images/player/transport_complete.jpg new file mode 100644 index 0000000..ad77d05 Binary files /dev/null and b/docs/images/player/transport_complete.jpg differ diff --git a/docs/images/player/transport_complete.svg b/docs/images/player/transport_complete.svg deleted file mode 100644 index be12ffd..0000000 --- a/docs/images/player/transport_complete.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Player transport completion - Capture the player and cargo after a successful transport request. - - - PLACEHOLDER IMAGE - Player: transport complete - Show arrival at the destination with moved vehicles nearby. - diff --git a/docs/images/player/transport_destination_menu.jpg b/docs/images/player/transport_destination_menu.jpg new file mode 100644 index 0000000..85f6e78 Binary files /dev/null and b/docs/images/player/transport_destination_menu.jpg differ diff --git a/docs/images/player/transport_destination_menu.svg b/docs/images/player/transport_destination_menu.svg deleted file mode 100644 index 8bbe5d9..0000000 --- a/docs/images/player/transport_destination_menu.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Player transport destination menu - Capture the destination submenu after selecting Transport. - - - PLACEHOLDER IMAGE - Player: destination submenu - Show destination choices and the Back action. - diff --git a/docs/images/player/transport_menu_action.jpg b/docs/images/player/transport_menu_action.jpg new file mode 100644 index 0000000..d6952e5 Binary files /dev/null and b/docs/images/player/transport_menu_action.jpg differ diff --git a/docs/images/player/transport_menu_action.svg b/docs/images/player/transport_menu_action.svg deleted file mode 100644 index 8b193e5..0000000 --- a/docs/images/player/transport_menu_action.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Player transport menu action - Capture the actor interaction menu showing the Transport action. - - - PLACEHOLDER IMAGE - Player: Transport action - Show the first interaction menu near a transport node. - diff --git a/docs/images/player/virtual_arsenal.jpg b/docs/images/player/virtual_arsenal.jpg new file mode 100644 index 0000000..42c2fc5 Binary files /dev/null and b/docs/images/player/virtual_arsenal.jpg differ diff --git a/docs/images/player/virtual_garage.jpg b/docs/images/player/virtual_garage.jpg new file mode 100644 index 0000000..cc42860 Binary files /dev/null and b/docs/images/player/virtual_garage.jpg differ diff --git a/docus/content/1.getting-started/1.architecture.md b/docus/content/1.getting-started/1.architecture.md index f0c9c4a..e811a38 100644 --- a/docus/content/1.getting-started/1.architecture.md +++ b/docus/content/1.getting-started/1.architecture.md @@ -5,7 +5,7 @@ description: "Forge is organized around domain modules. A domain usually has SQF ## Runtime Flow -![Architectural Flow Diagram](architecture-flow.svg) +![Architectural Flow Diagram](images/architecture-flow.svg) ```text Arma client UI or SQF action diff --git a/docus/content/1.getting-started/5.mission-designer.md b/docus/content/1.getting-started/5.mission-designer.md index 6293ad5..ebd84c4 100644 --- a/docus/content/1.getting-started/5.mission-designer.md +++ b/docus/content/1.getting-started/5.mission-designer.md @@ -153,9 +153,13 @@ airports, bus stops, teleport terminals, or any other mission transport system. The framework owns the menu, billing, cargo scan, and movement logic. The mission only needs placed objects and optional arrival markers. -![Placeholder: Eden transport node object placement](images/eden/transport_node_obj.svg) +![Eden transport location one](images/eden/transport_loc_1.jpg) -![Placeholder: Eden transport node variable name](images/eden/transport_node_var.svg) +![Eden transport location two](images/eden/transport_loc_2.jpg) + +![Eden transport node object placement](images/eden/transport_obj_1.jpg) + +![Eden transport node variable name](images/eden/transport_obj_1_var.jpg) Place transport node objects with these variable names: @@ -177,7 +181,9 @@ transport_arrival_2 transport_arrival_10 ``` -![Placeholder: Eden transport arrival marker placement](images/eden/transport_arrival_marker.svg) +![Eden transport arrival marker placement](images/eden/transport_arrival_mrkr.jpg) + +![Eden transport arrival marker variable name](images/eden/transport_arrival_mrkr_var.jpg) Objects that should be excluded from the nearby cargo scan, such as the actual boat or transport vehicle used as set dressing, should use: @@ -190,7 +196,9 @@ transport_vehicle_2 transport_vehicle_10 ``` -![Placeholder: Eden transport vehicle exclusion object variable name](images/eden/transport_vehicle_var.svg) +![Eden transport vehicle exclusion object placement](images/eden/transport_veh_obj.jpg) + +![Eden transport vehicle exclusion object variable name](images/eden/transport_veh_obj_var.jpg) Minimum Eden setup: diff --git a/docus/content/1.getting-started/6.player-guide.md b/docus/content/1.getting-started/6.player-guide.md index 0984bd6..47ab36d 100644 --- a/docus/content/1.getting-started/6.player-guide.md +++ b/docus/content/1.getting-started/6.player-guide.md @@ -219,7 +219,7 @@ Transport points let players pay to travel between configured mission locations. They may represent ferries, terminals, air shuttles, or other mission-specific travel points. -![Placeholder: Actor menu Transport action](images/player/transport_menu_action.svg) +![Actor menu Transport action](images/player/transport_menu_action.jpg) Player workflow: @@ -229,7 +229,7 @@ Player workflow: 4. Select a destination from the transport submenu, or select Close to return to the default interaction menu. -![Placeholder: Transport destination submenu](images/player/transport_destination_menu.svg) +![Transport destination submenu](images/player/transport_destination_menu.jpg) The destination price is based on distance. The server charges player bank first, player cash second, then organization credit line fallback when @@ -237,7 +237,7 @@ available. If payment succeeds, the player is moved to the selected arrival point. Nearby eligible vehicles or passengers may be moved with the player when the mission has configured the transport point for cargo movement. -![Placeholder: Transport completion notification](images/player/transport_complete.svg) +![Transport completion notification](images/player/transport_complete.jpg) ## Locker and Virtual Arsenal diff --git a/docus/content/3.server-modules/12.transport-service.md b/docus/content/3.server-modules/12.transport-service.md index f6b8cb7..0904497 100644 --- a/docus/content/3.server-modules/12.transport-service.md +++ b/docus/content/3.server-modules/12.transport-service.md @@ -109,23 +109,31 @@ this setVariable ["transportIncludeCargo", true, true]; Only use overrides when the default `transport*` convention is not appropriate. -## Image Checklist +## Reference Images -Replace these placeholder image references after screenshots are captured: +These screenshots show the default transport setup and player workflow: -![Placeholder: Eden transport node object placement](images/eden/transport_node_obj.svg) +![Eden transport location one](images/eden/transport_loc_1.jpg) -![Placeholder: Eden transport node variable name field](images/eden/transport_node_var.svg) +![Eden transport location two](images/eden/transport_loc_2.jpg) -![Placeholder: Eden transport arrival marker placement](images/eden/transport_arrival_marker.svg) +![Eden transport node object placement](images/eden/transport_obj_1.jpg) -![Placeholder: Eden transport vehicle exclusion object variable name](images/eden/transport_vehicle_var.svg) +![Eden transport node variable name field](images/eden/transport_obj_1_var.jpg) -![Placeholder: Player actor menu transport action](images/player/transport_menu_action.svg) +![Eden transport arrival marker placement](images/eden/transport_arrival_mrkr.jpg) -![Placeholder: Player transport destination submenu](images/player/transport_destination_menu.svg) +![Eden transport arrival marker variable name](images/eden/transport_arrival_mrkr_var.jpg) -![Placeholder: Player transport completion notification](images/player/transport_complete.svg) +![Eden transport vehicle exclusion object placement](images/eden/transport_veh_obj.jpg) + +![Eden transport vehicle exclusion object variable name](images/eden/transport_veh_obj_var.jpg) + +![Player actor menu transport action](images/player/transport_menu_action.jpg) + +![Player transport destination submenu](images/player/transport_destination_menu.jpg) + +![Player transport completion notification](images/player/transport_complete.jpg) ## Mission-Side Code Requirement diff --git a/docus/public/architecture-flow.png b/docus/public/architecture-flow.png deleted file mode 100644 index 6e7927a..0000000 Binary files a/docus/public/architecture-flow.png and /dev/null differ diff --git a/docus/public/images/architecture-flow.svg b/docus/public/images/architecture-flow.svg new file mode 100644 index 0000000..90a5eb1 --- /dev/null +++ b/docus/public/images/architecture-flow.svg @@ -0,0 +1 @@ +

Arma Client Addon

Server SQF Addon

forge_server callExtension

Rust Extension

forge-services

forge-repositories traits

SurrealDB adapters

SurrealDB

\ No newline at end of file diff --git a/docus/public/images/eden/transport_arrival_marker.svg b/docus/public/images/eden/transport_arrival_marker.svg deleted file mode 100644 index 57d8bf6..0000000 --- a/docus/public/images/eden/transport_arrival_marker.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Eden transport arrival marker placement - Capture an Eden Editor screenshot showing the arrival marker location. - - - PLACEHOLDER IMAGE - Eden: transport arrival marker - Show where players and cargo should spawn. - diff --git a/docus/public/images/eden/transport_arrival_mrkr.jpg b/docus/public/images/eden/transport_arrival_mrkr.jpg new file mode 100644 index 0000000..df26a81 Binary files /dev/null and b/docus/public/images/eden/transport_arrival_mrkr.jpg differ diff --git a/docus/public/images/eden/transport_arrival_mrkr_var.jpg b/docus/public/images/eden/transport_arrival_mrkr_var.jpg new file mode 100644 index 0000000..720bbe7 Binary files /dev/null and b/docus/public/images/eden/transport_arrival_mrkr_var.jpg differ diff --git a/docus/public/images/eden/transport_loc_1.jpg b/docus/public/images/eden/transport_loc_1.jpg new file mode 100644 index 0000000..dc64019 Binary files /dev/null and b/docus/public/images/eden/transport_loc_1.jpg differ diff --git a/docus/public/images/eden/transport_loc_2.jpg b/docus/public/images/eden/transport_loc_2.jpg new file mode 100644 index 0000000..be6161f Binary files /dev/null and b/docus/public/images/eden/transport_loc_2.jpg differ diff --git a/docus/public/images/eden/transport_node_obj.svg b/docus/public/images/eden/transport_node_obj.svg deleted file mode 100644 index 2cc6d13..0000000 --- a/docus/public/images/eden/transport_node_obj.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Eden transport node object placement - Capture an Eden Editor screenshot showing the placed transport access object. - - - PLACEHOLDER IMAGE - Eden: transport node object placement - Show the object players interact with for transport. - diff --git a/docus/public/images/eden/transport_node_var.svg b/docus/public/images/eden/transport_node_var.svg deleted file mode 100644 index e6ce554..0000000 --- a/docus/public/images/eden/transport_node_var.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Eden transport node variable name - Capture the Eden object attributes panel with the transport variable name. - - - PLACEHOLDER IMAGE - Eden: transport variable name - Show transport, transport_1, through transport_10. - diff --git a/docus/public/images/eden/transport_obj_1.jpg b/docus/public/images/eden/transport_obj_1.jpg new file mode 100644 index 0000000..cf07c37 Binary files /dev/null and b/docus/public/images/eden/transport_obj_1.jpg differ diff --git a/docus/public/images/eden/transport_obj_1_var.jpg b/docus/public/images/eden/transport_obj_1_var.jpg new file mode 100644 index 0000000..e44056b Binary files /dev/null and b/docus/public/images/eden/transport_obj_1_var.jpg differ diff --git a/docus/public/images/eden/transport_veh_obj.jpg b/docus/public/images/eden/transport_veh_obj.jpg new file mode 100644 index 0000000..04964aa Binary files /dev/null and b/docus/public/images/eden/transport_veh_obj.jpg differ diff --git a/docus/public/images/eden/transport_veh_obj_var.jpg b/docus/public/images/eden/transport_veh_obj_var.jpg new file mode 100644 index 0000000..c026756 Binary files /dev/null and b/docus/public/images/eden/transport_veh_obj_var.jpg differ diff --git a/docus/public/images/eden/transport_vehicle_var.svg b/docus/public/images/eden/transport_vehicle_var.svg deleted file mode 100644 index 71866a0..0000000 --- a/docus/public/images/eden/transport_vehicle_var.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Eden transport vehicle variable name - Capture the variable name for the transport vehicle that should be excluded from cargo scans. - - - PLACEHOLDER IMAGE - Eden: transport_vehicle variable - Show transport_vehicle, transport_vehicle_1, etc. - diff --git a/docus/public/images/player/transport_complete.jpg b/docus/public/images/player/transport_complete.jpg new file mode 100644 index 0000000..ad77d05 Binary files /dev/null and b/docus/public/images/player/transport_complete.jpg differ diff --git a/docus/public/images/player/transport_complete.svg b/docus/public/images/player/transport_complete.svg deleted file mode 100644 index be12ffd..0000000 --- a/docus/public/images/player/transport_complete.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Player transport completion - Capture the player and cargo after a successful transport request. - - - PLACEHOLDER IMAGE - Player: transport complete - Show arrival at the destination with moved vehicles nearby. - diff --git a/docus/public/images/player/transport_destination_menu.jpg b/docus/public/images/player/transport_destination_menu.jpg new file mode 100644 index 0000000..85f6e78 Binary files /dev/null and b/docus/public/images/player/transport_destination_menu.jpg differ diff --git a/docus/public/images/player/transport_destination_menu.svg b/docus/public/images/player/transport_destination_menu.svg deleted file mode 100644 index 8bbe5d9..0000000 --- a/docus/public/images/player/transport_destination_menu.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Player transport destination menu - Capture the destination submenu after selecting Transport. - - - PLACEHOLDER IMAGE - Player: destination submenu - Show destination choices and the Back action. - diff --git a/docus/public/images/player/transport_menu_action.jpg b/docus/public/images/player/transport_menu_action.jpg new file mode 100644 index 0000000..d6952e5 Binary files /dev/null and b/docus/public/images/player/transport_menu_action.jpg differ diff --git a/docus/public/images/player/transport_menu_action.svg b/docus/public/images/player/transport_menu_action.svg deleted file mode 100644 index 8b193e5..0000000 --- a/docus/public/images/player/transport_menu_action.svg +++ /dev/null @@ -1,9 +0,0 @@ - - Placeholder: Player transport menu action - Capture the actor interaction menu showing the Transport action. - - - PLACEHOLDER IMAGE - Player: Transport action - Show the first interaction menu near a transport node. -