From 25e9f825c531bdbad17e7bda756a53c976a630e9 Mon Sep 17 00:00:00 2001 From: Oarcinae Date: Wed, 25 Sep 2024 13:12:01 -0400 Subject: [PATCH] More FAQ and settings subheaders. More info about template scenario. --- lib/config_parser.lua | 17 ++++++++++------- lib/gui_tabs/mod_info_faq.lua | 1 + locale/en/locale.cfg | 11 +++++++++-- scenarios/OARC/control.lua | 3 +++ scenarios/OARC/locale/en/locale-scenario.cfg | 2 +- 5 files changed, 24 insertions(+), 10 deletions(-) diff --git a/lib/config_parser.lua b/lib/config_parser.lua index bef3e8f..01ec7f5 100644 --- a/lib/config_parser.lua +++ b/lib/config_parser.lua @@ -13,6 +13,7 @@ OCFG_KEYS = ["server_info.discord_invite"] = {mod_key = "oarc-mod-discord-invite" , ocfg_keys = {"server_info", "discord_invite"}, type = "string"}, ["gameplay_HEADER"] = {mod_key = "" , ocfg_keys = {""}, type = "header", text = {"oarc-settings-section-header-gameplay"}}, + ["gameplay_spawn_choices_SUBHEADER"] = {mod_key = "" , ocfg_keys = {""}, type = "subheader", text = {"oarc-settings-section-subheader-spawn-choices"}}, ["gameplay.enable_main_team"] = {mod_key = "oarc-mod-enable-main-team" , ocfg_keys = {"gameplay", "enable_main_team"}, type = "boolean"}, ["gameplay.enable_separate_teams"] = {mod_key = "oarc-mod-enable-separate-teams" , ocfg_keys = {"gameplay", "enable_separate_teams"}, type = "boolean"}, -- STARTUP ["gameplay.enable_spawning_on_other_surfaces"] = {mod_key = "oarc-mod-default-allow-spawning-on-other-surfaces" , ocfg_keys = {"gameplay", "enable_spawning_on_other_surfaces"}, type = "boolean"}, @@ -21,26 +22,28 @@ OCFG_KEYS = ["gameplay.minimum_distance_to_existing_chunks"] = {mod_key = "oarc-mod-minimum-distance-to-existing-chunks" , ocfg_keys = {"gameplay", "minimum_distance_to_existing_chunks"}, type = "integer"}, ["gameplay.near_spawn_distance"] = {mod_key = "oarc-mod-near-spawn-distance" , ocfg_keys = {"gameplay", "near_spawn_distance"}, type = "integer"}, ["gameplay.far_spawn_distance"] = {mod_key = "oarc-mod-far-spawn-distance" , ocfg_keys = {"gameplay", "far_spawn_distance"}, type = "integer"}, - ["gameplay.enable_buddy_spawn"] = {mod_key = "oarc-mod-enable-buddy-spawn" , ocfg_keys = {"gameplay", "enable_buddy_spawn"}, type = "boolean"}, - ["gameplay.enable_offline_protection"] = {mod_key = "oarc-mod-enable-offline-protection" , ocfg_keys = {"gameplay", "enable_offline_protection"}, type = "boolean"}, - ["gameplay.enable_shared_team_vision"] = {mod_key = "oarc-mod-enable-shared-team-vision" , ocfg_keys = {"gameplay", "enable_shared_team_vision"}, type = "boolean"}, - ["gameplay.enable_shared_team_chat"] = {mod_key = "oarc-mod-enable-shared-team-chat" , ocfg_keys = {"gameplay", "enable_shared_team_chat"}, type = "boolean"}, ["gameplay.enable_shared_spawns"] = {mod_key = "oarc-mod-enable-shared-spawns" , ocfg_keys = {"gameplay", "enable_shared_spawns"}, type = "boolean"}, ["gameplay.number_of_players_per_shared_spawn"] = {mod_key = "oarc-mod-number-of-players-per-shared-spawn" , ocfg_keys = {"gameplay", "number_of_players_per_shared_spawn"}, type = "integer"}, - ["gameplay.enable_friendly_fire"] = {mod_key = "oarc-mod-enable-friendly-fire" , ocfg_keys = {"gameplay", "enable_friendly_fire"}, type = "boolean"}, - - -- ["gameplay.main_force_name"] = {mod_key = "oarc-mod-main-force-name" , ocfg_keys = {"gameplay", "main_force_name"}, type = "string"}, ["gameplay.default_surface"] = {mod_key = "oarc-mod-default-surface" , ocfg_keys = {"gameplay", "default_surface"}, type = "string"}, ["gameplay.enable_secondary_spawns"] = {mod_key = "oarc-mod-enable-secondary-spawns" , ocfg_keys = {"gameplay", "enable_secondary_spawns"}, type = "boolean"}, + -- STARTUP ["gameplay.main_force_name"] = {mod_key = "oarc-mod-main-force-name" , ocfg_keys = {"gameplay", "main_force_name"}, type = "string"}, + ["gameplay_difficulty_scaling_SUBHEADER"] = {mod_key = "" , ocfg_keys = {""}, type = "subheader", text = {"oarc-settings-section-subheader-difficulty-scaling"}}, + ["gameplay.enable_offline_protection"] = {mod_key = "oarc-mod-enable-offline-protection" , ocfg_keys = {"gameplay", "enable_offline_protection"}, type = "boolean"}, ["gameplay.scale_resources_around_spawns"] = {mod_key = "oarc-mod-scale-resources-around-spawns" , ocfg_keys = {"gameplay", "scale_resources_around_spawns"}, type = "boolean"}, ["gameplay.modified_enemy_spawning"] = {mod_key = "oarc-mod-modified-enemy-spawning" , ocfg_keys = {"gameplay", "modified_enemy_spawning"}, type = "boolean"}, ["gameplay.modified_enemy_easy_evo"] = {mod_key = "oarc-mod-modified-enemy-easy-evo" , ocfg_keys = {"gameplay", "modified_enemy_easy_evo"}, type = "double"}, ["gameplay.modified_enemy_medium_evo"] = {mod_key = "oarc-mod-modified-enemy-medium-evo" , ocfg_keys = {"gameplay", "modified_enemy_medium_evo"}, type = "double"}, + ["gameplay_misc_SUBHEADER"] = {mod_key = "" , ocfg_keys = {""}, type = "subheader", text = {"oarc-settings-section-subheader-gameplay-misc"}}, + ["gameplay.enable_friendly_fire"] = {mod_key = "oarc-mod-enable-friendly-fire" , ocfg_keys = {"gameplay", "enable_friendly_fire"}, type = "boolean"}, ["gameplay.minimum_online_time"] = {mod_key = "oarc-mod-minimum-online-time" , ocfg_keys = {"gameplay", "minimum_online_time"}, type = "integer"}, ["gameplay.respawn_cooldown_min"] = {mod_key = "oarc-mod-respawn-cooldown-min" , ocfg_keys = {"gameplay", "respawn_cooldown_min"}, type = "integer"}, + + ["gameplay_sharing_SUBHEADER"] = {mod_key = "" , ocfg_keys = {""}, type = "subheader", text = {"oarc-settings-section-subheader-sharing"}}, + ["gameplay.enable_shared_team_vision"] = {mod_key = "oarc-mod-enable-shared-team-vision" , ocfg_keys = {"gameplay", "enable_shared_team_vision"}, type = "boolean"}, + ["gameplay.enable_shared_team_chat"] = {mod_key = "oarc-mod-enable-shared-team-chat" , ocfg_keys = {"gameplay", "enable_shared_team_chat"}, type = "boolean"}, ["gameplay.enable_shared_power"] = {mod_key = "oarc-mod-enable-shared-power" , ocfg_keys = {"gameplay", "enable_shared_power"}, type = "boolean"}, ["gameplay.enable_shared_chest"] = {mod_key = "oarc-mod-enable-shared-chest" , ocfg_keys = {"gameplay", "enable_shared_chest"}, type = "boolean"}, diff --git a/lib/gui_tabs/mod_info_faq.lua b/lib/gui_tabs/mod_info_faq.lua index c8c01ec..cc74128 100644 --- a/lib/gui_tabs/mod_info_faq.lua +++ b/lib/gui_tabs/mod_info_faq.lua @@ -18,6 +18,7 @@ function CreateModInfoTab(tab_container, player) CreateFAQEntry(scroll_pane, { "oarc-mod-faq-what-is-this-mod" }, { "oarc-mod-faq-what-is-this-mod-answer" }) CreateFAQEntry(scroll_pane, { "oarc-mod-faq-other-surfaces" }, { "oarc-mod-faq-other-surfaces-answer" }) + CreateFAQEntry(scroll_pane, { "oarc-mod-faq-secondary-spawns" }, { "oarc-mod-faq-secondary-spawns-answer" }) CreateFAQEntry(scroll_pane, { "oarc-mod-faq-what-are-teams" }, { "oarc-mod-faq-what-are-teams-answer" }) CreateFAQEntry(scroll_pane, { "oarc-mod-faq-shared-spawn" }, { "oarc-mod-faq-shared-spawn-answer" }) CreateFAQEntry(scroll_pane, { "oarc-mod-faq-buddy-spawn" }, { "oarc-mod-faq-buddy-spawn-answer" }) diff --git a/locale/en/locale.cfg b/locale/en/locale.cfg index 903ef3d..0335831 100644 --- a/locale/en/locale.cfg +++ b/locale/en/locale.cfg @@ -37,7 +37,7 @@ oarc-spawn-menu-shared-header=Join Another Spawn oarc-spawn-menu-buddy-header=Create A Buddy Spawn oarc-spawn-distance-slider-label=Distance From Map Center: -oarc-spawn-distance-slider-tooltip=This is the minimum distance from the center of the map in chunks that you will spawn. You may spawn further away if the map has already been explored. +oarc-spawn-distance-slider-tooltip=This is the minimum distance from the center of the map in chunks that you will spawn. You may spawn further away if the map has already been explored. Resources and enemies are both more abundant the further you go from the center, but you will still be guaranteed a safe starting area. oarc-starting-area-normal=You are spawned in a new area, with pre-set starting resources. oarc-join-someone-dropdown-label=Select Shared Spawn: @@ -217,6 +217,11 @@ oarc-settings-section-header-regrowth=Regrowth oarc-settings-section-header-general-spawn=General Spawn Area Config oarc-settings-section-header-resource-placement=Starting Resources Placement +oarc-settings-section-subheader-spawn-choices=Spawn choices +oarc-settings-section-subheader-difficulty-scaling=Enemy and resource scaling +oarc-settings-section-subheader-gameplay-misc=Misc +oarc-settings-section-subheader-sharing=Sharing and co-op + oarc-settings-section-subheader-resource-placement-circular=For circle/octagon spawns oarc-settings-section-subheader-resource-placement-square=For square spawns @@ -228,7 +233,9 @@ oarc-shared-chest-helper-txt=This connects to a shared storage chest for all pla oarc-mod-faq-what-is-this-mod=What is this mod? oarc-mod-faq-what-is-this-mod-answer=This mod overhauls multiplayer spawning. Players can create their own spawn points away from the center of the map. Players can also join other players' bases, or create buddy spawns. The mod does not change the core gameplay of Factorio, but it does change the way players start the game. The starting area is a preset area with resources, not a "natural" spawn point. oarc-mod-faq-other-surfaces=Can I start on a different surface/planet? -oarc-mod-faq-other-surfaces-answer=[color=red]This feature is currently a work in progress. As such, only spawning on "nauvis" or a default nauvis-like surface will work correctly. Spawning on other surfaces may cause issues.[/color] +oarc-mod-faq-other-surfaces-answer=[color=red]This feature is currently a work in progress. As such, only spawning on "nauvis" or a default nauvis-like surface will work correctly.[/color] +oarc-mod-faq-secondary-spawns=What are secondary spawns? +oarc-mod-faq-secondary-spawns-answer=If enabled, when a player first travels to a new surface that has custom spawning enabled, they will automatically be given a new starting area based on their primary spawn choice (the first spawn they create). [color=red]This feature is currently a work in progress. Secondary spawning on other surfaces may cause issues. Buddy and shared spawns are not implemented yet at this time.[/color] oarc-mod-faq-what-are-teams=What are the different team options? oarc-mod-faq-what-are-teams-answer=I wrote this mod for co-op play only, not pvp. Depending on the mod settings, you can either join the main team, which shares research, or create your own team, which has its own research tree. All teams/forces are friendly to each other and can communicate in chat and (optionally) share map vision. The only reason to create your own team is if you want to have your own research progress. oarc-mod-faq-shared-spawn=What is a shared spawn? diff --git a/scenarios/OARC/control.lua b/scenarios/OARC/control.lua index b0e1228..07b33ae 100644 --- a/scenarios/OARC/control.lua +++ b/scenarios/OARC/control.lua @@ -1,3 +1,6 @@ +-- To edit this scenario, you must make a copy of it and place it in your own scenarios folder first! +-- Do not edit the scenario provided by the mod install directly! + -- I provide this empty scenario to avoid the freeplay scenario extra baggage. -- You can use the freeplay scenario too just fine if you want. -- The main benefit of the scenario is that it lets you modify the any of the config during on_init of the mod. diff --git a/scenarios/OARC/locale/en/locale-scenario.cfg b/scenarios/OARC/locale/en/locale-scenario.cfg index e4adb50..e170617 100644 --- a/scenarios/OARC/locale/en/locale-scenario.cfg +++ b/scenarios/OARC/locale/en/locale-scenario.cfg @@ -1,3 +1,3 @@ scenario-name=OARC-TEMPLATE -description=This is an EMPTY TEMPLATE scenario! It is provided as an example of how to override the default freeplay scenario if you want to. Additionally, experienced server hosts can configure all settings from a file instead of through the mod settings. Please read the control.lua file inside the scenario for notes. +description=This is an EMPTY TEMPLATE scenario! It is provided as an example of how to override the default freeplay scenario if you want to. Additionally, experienced server hosts can configure all settings from a file instead of through the mod settings. Please read the control.lua file inside the scenario for notes. [color=red]To edit this scenario, you must make a copy of it and place it in your own scenarios folder first. Do not edit this scenario directly.[/color]