Console Command Runner | Starfield

on

Console Command Runner is an SFSE plugin that executes user-defined console commands on startup. There’s no need to open the console!

Creator: Bobbyclue

Console Command Runner

Nowmods requirements

Mod name Notes
Address Library for SFSE Plugins
Starfield Script Extender (SFSE)

Credits and distribution rights

  • Assets of other users: All of the assets in this Console Command Runner file are either the author’s or free-to-use modder’s resources.
  • Upload authorization: You may upload this Console Command Runner file to other websites, but you must credit me as the file’s creator.
  • Permission to modify: You may alter my files and distribute bug fixes or enhancements without seeking permission or credit from me.
  • Permission to convert: You are free to convert this file to work with other games as long as you credit me as the file’s developer.
  • Permission to utilize an asset: You may use the materials in this Console Command Runner file without asking permission or crediting me.
  • Asset use authorization in purchased mods/files: This file’s assets may not be used in any modifications or files that are sold for money on Steam Workshop or other platforms.
  • Permission to utilize assets in mods/files that earn donation points: If your modifications use my materials, you must obtain permission to earn Donation Points.

Notes from the Author
This author has made no further remarks about file permissions.

File credits

  • po3 for some improvements to executecommand RE, a good example of event sink usage, and considerable contributions to commonlib
  • ianpatt for SFSE
  • ThirdEyeSqueegee for the plugin template
  • shad0wshayd3 for some SFSE plugins that I referenced
  • linuxversion for a workaround for the lack of a dataloaded event in SFSE
    And everyone else who’s contributed to Starfield RE so far!
  • Version 1.3
    • Added OnMenuOpenCloseEvent event type. See the description for how to make use of this new event
  • Version 1.2
    • Updated to support address library. CCR will now work on any game version Address Library supports
  • Version 1.1
    • Fixed an issue that would crash the game if the ConosleCommandRunner folder was not present
    • Data loaded event is now guarunteed to only fire after all data is actually loaded

DESCRIPTIONS

Console Command Runner is an SFSE plugin that automatically runs a list of console commands from user defined .toml files.

While the main game has an ini parameter that can be configured to run console commands on startup, there were a few reasons I wanted to develop my own implementation.

  • On the user end, having to change the ini file to add at least one new command every mod can be time consuming. Console Command Runner will execute as many commands as an author or collection of authors allows.
  • While Console Command Runner currently only allows commands being executed when you reach the main menu, I’d want to add other events in the future, such that a command might be performed on key press or something similar.
  • I couldn’t wait to start modifying Starfield! Furthermore, having the game’s “execute command” function internally described allows quick access to a range of additional capabilities that would otherwise require considerably more effort to fully reverse engineer.

When the CK is released, this mod will become somewhat obsolete, but in the meanwhile, I hope it will encourage more people to start modifying Starfield.

INSTALLATION

Simply drop the mod into the game’s data folder, as you would for any other SFSE plugin.

Now requires Address Library, and will support any game version address library does.

nowmods download

↳Download Console Command Runner

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']

The tag “[[Event]]” precedes each unique event. The event type must be defined within the event. If an event includes parameters, they are shown. The firing orders are then listed. Any legal console command should function in this situation. Commands should be separated by commas and encased in apostrophes (quotes will also work for any command that does not take a string parameter, i.e. does not have quotes inside of quotes).
That’s all there is to it!

Valid Event Names

DataLoaded

When the game is launched, this function fires when the main menu is first reached. Keep in mind that this is a one-time event, so if you load another save or return to the main menu, commands from this event will not be executed again.

OnMenuOpenCloseEvent

When a legitimate menu is opened or closed, this event is triggered. Includes two parameters: asMenuName, which allows filtering by menu type, and abOpening, which allows filtering by whether or not a menu is open.

Source
Go easy on me this is my first script extender plugin :p

Browse for more Starfield mods

NOWMODS.COM
StarUI HUD | Starfield
StarUI Inventory | Starfield


source https://nowmods.com/console-command-runner-starfield/

Comments

Post a Comment