0 of 0
About this mod
An SFSE plugin that automatically runs user defined console commands on startup and when a menu opens or closes. No need to open the console!
- Requirements
- Permissions and credits
- Changelogs
What is it?
Console Command Runner is an SFSE plugin that automatically runs a list of console commands from user defined .toml files.
Why?
While there is an ini setting in the base game that can be set to run console commands on startup, there were still a few reasons I wanted to make my own implementation.
Eventually when the CK releases this mod will be made somewhat redundant, but in the meantime I hope that it can enable more people to start modding Starfield.
User Installation
Simply drop the mod into the game's data folder, as you would for any other SFSE plugin.
Requirements
I also highly recommend Baka Achievement Enabler as console commands would otherwise disable achievements.
Author Use
In order to create a Console Command Runner preset, first create a uniquely named .toml file in the Starfield\Data\SFSE\Plugins\ConsoleCommandRunner directory. Any number of .toml files can be read, you are not limited to a single file. This ensure compatibility with other mods.
In this new .toml file you'll want to create layout that looks like this:
Each individual event is prefaced with the "[[Event]]" tag. Within the event the event type needs to be defined. If an event has any parameters those are listed. Then the actual commands to fire are listed. Any valid console command should work here. Commands should be encased in apostrophes (quotes will also work for any command that does not take a string parameter, meaning does not have quotes inside of quotes) and separated by commas.
And that's it!
Valid Event Names
DataLoaded
Fires when the main menu is first reached when the game is launched. Keep in mind this is a one off o if you load another save or back out to the main menu, commands from this event will not fire again.
OnMenuOpenCloseEvent
Fires when a valid menu is opened or closed. Includes two parameters, asMenuName which allows filtering based on the type of menu, and abOpening which allows filtering based on whether a menu is opening or not.
Valid menu names include:
Source
Go easy on me this is my first script extender plugin :p
Console Command Runner is an SFSE plugin that automatically runs a list of console commands from user defined .toml files.
Why?
While there is an ini setting in the base game that can be set to run console commands on startup, there were still a few reasons I wanted to make my own implementation.
- Needing to edit the ini file to add at the least one new command per mod can be tedious on the user end of things. Console Command Runner will run as many commands as an author or authors list.
- Commands with this mod can be fired on menu open/close in addition to when the main menu first loads, allowing more interesting and targeted firing of commands.
- I was eager to start modding Starfield! Plus having the "execute command" function the game uses internally documented means easy access to a variety of other functionalities that might otherwise take much more time to properly reverse engineer.
Eventually when the CK releases this mod will be made somewhat redundant, but in the meantime I hope that it can enable more people to start modding Starfield.
User Installation
Simply drop the mod into the game's data folder, as you would for any other SFSE plugin.
Requirements
I also highly recommend Baka Achievement Enabler as console commands would otherwise disable achievements.
Author Use
In order to create a Console Command Runner preset, first create a uniquely named .toml file in the Starfield\Data\SFSE\Plugins\ConsoleCommandRunner directory. Any number of .toml files can be read, you are not limited to a single file. This ensure compatibility with other mods.
In this new .toml file you'll want to create layout that looks like this:
[[Event]]
EventType = "DataLoaded"
Commands = ['tgm', 'tcl', 'coc CityNeonEuphorika']
[[Event]]
EventType = "OnMenuOpenCloseEvent"
asMenuName = "BSMissionMenu"
abOpening = true
Commands = ['tgm', 'tcl']
Each individual event is prefaced with the "[[Event]]" tag. Within the event the event type needs to be defined. If an event has any parameters those are listed. Then the actual commands to fire are listed. Any valid console command should work here. Commands should be encased in apostrophes (quotes will also work for any command that does not take a string parameter, meaning does not have quotes inside of quotes) and separated by commas.
And that's it!
Valid Event Names
DataLoaded
Fires when the main menu is first reached when the game is launched. Keep in mind this is a one off o if you load another save or back out to the main menu, commands from this event will not fire again.
OnMenuOpenCloseEvent
Fires when a valid menu is opened or closed. Includes two parameters, asMenuName which allows filtering based on the type of menu, and abOpening which allows filtering based on whether a menu is opening or not.
Valid menu names include:
Spoiler:
Show
# CursorMenu
# TitleSequenceMenu
# SleepWaitMenu
# SitWaitMenu
# MessageBoxMenu
# MainMenu - CURRENTLY NON FUNCTIONAL
# CreditsMenu
# LoadingMenu
# FanfareMenu
# HUDMenu
# FavoritesMenu
# DialogueMenu
# FaderMenu
# ContainerMenu
# ConsoleNativeUIMenu
# BookMenu
# Console
# Workshop_BlueprintMenu
# WorkshopTargetMenu
# WorkshopQuickMenu
# WorkshopMenu
# WorkshopBuilderMenu
# WeaponsCraftingMenu
# TextInputMenu
# PowersMenu
# TestMenu
# GenesisTerminalMenu
# StreamingInstallMenu
# StatusMenu
# GalaxyStarMapMenu
# TakeoffMenu
# SpaceshipHudMenu
# ScopeMenu
# PlayBinkMenu
# PauseMenu
# DrugsCraftingMenu
# DataMenu
# ChargenMenu
# SkillsMenu
# ShipRefuelMenu
# WeaponGroupAssignmentMenu
# ShipCrewAssignMenu
# ShipCrewMenu
# SecurityMenu
# ResearchMenu
# PickpocketMenu
# PhotoModeMenu
# MonocleMenu
# MissionBoard
# InventoryMenu
# IndustrialCraftingMenu
# HUDMessagesMenu
# FoodCraftingMenu
# DataSlateMenu
# DataSlateButtons
# BSMissionMenu
# EndGameCreditsMenu
# BarterMenu
# ArmorCraftingMenu
# SpaceshipEditorMenu
# BoundaryMenu
# DocAcceptMenu
# PhotoGalleryMenu
# TitleSequenceMenu
# SleepWaitMenu
# SitWaitMenu
# MessageBoxMenu
# MainMenu - CURRENTLY NON FUNCTIONAL
# CreditsMenu
# LoadingMenu
# FanfareMenu
# HUDMenu
# FavoritesMenu
# DialogueMenu
# FaderMenu
# ContainerMenu
# ConsoleNativeUIMenu
# BookMenu
# Console
# Workshop_BlueprintMenu
# WorkshopTargetMenu
# WorkshopQuickMenu
# WorkshopMenu
# WorkshopBuilderMenu
# WeaponsCraftingMenu
# TextInputMenu
# PowersMenu
# TestMenu
# GenesisTerminalMenu
# StreamingInstallMenu
# StatusMenu
# GalaxyStarMapMenu
# TakeoffMenu
# SpaceshipHudMenu
# ScopeMenu
# PlayBinkMenu
# PauseMenu
# DrugsCraftingMenu
# DataMenu
# ChargenMenu
# SkillsMenu
# ShipRefuelMenu
# WeaponGroupAssignmentMenu
# ShipCrewAssignMenu
# ShipCrewMenu
# SecurityMenu
# ResearchMenu
# PickpocketMenu
# PhotoModeMenu
# MonocleMenu
# MissionBoard
# InventoryMenu
# IndustrialCraftingMenu
# HUDMessagesMenu
# FoodCraftingMenu
# DataSlateMenu
# DataSlateButtons
# BSMissionMenu
# EndGameCreditsMenu
# BarterMenu
# ArmorCraftingMenu
# SpaceshipEditorMenu
# BoundaryMenu
# DocAcceptMenu
# PhotoGalleryMenu
Source
Go easy on me this is my first script extender plugin :p