Skip to content

Latest commit

 

History

63 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mods

A Windows CLI for isolated Fallout: New Vegas mod setups. Each Mod Environment has its own Data Mods, mod order, plugin state, INIs, saves, and writable output. A Steam Game Installation supplies the shared base.

Install the CLI

Requires Windows 11 x64, a Steam installation of Fallout: New Vegas, and both x86 and x64 Microsoft Visual C++ 2015-2022 Redistributables.

winget install Reilley64.Mods
mods --version
mods --help

If the terminal cannot find mods after installation, open a new terminal. For ZIP installation, runtime files, and setup errors, see the setup guide. Release binaries and corresponding source are available on GitHub Releases.

Start a Mod Environment

Replace these paths with a new Environment Root and your Steam Game Installation:

mods --environment 'D:\Mod Environments\Mojave' init --game-install 'D:\SteamLibrary\steamapps\common\Fallout New Vegas'
mods --environment 'D:\Mod Environments\Mojave' config list

Use the same --environment path for later commands. Without it, mods uses %LOCALAPPDATA%\mods\environments\default.

Preview a Data Mod installation before writing files:

mods --environment 'D:\Mod Environments\Mojave' install 'D:\Downloads\Textures.zip' --name 'Mojave Textures' --dry-run

Review the Install Plan, then rerun without --dry-run to install. If the archive requires FOMOD Choices, follow the installation guide. Exit zero can mean more choices are required or a preview is ready, rather than a completed installation.

New Data Mods start disabled. The released CLI has no enable command. Installation alone does not make a mod participate in the Virtual Game View.

Commands and limits

  • init creates a Mod Environment.
  • config reads settings or changes the Game Binding.
  • install previews, installs, or replaces a Data Mod. Nexus URL acquisition requires a personal API key from a Premium account for new downloads; see Nexus URL input.
  • conflicts lists File Conflicts, inspects a Data Mod, or explains a Data-relative path.
  • export previews or publishes a resolved Data/Profile payload for manual placement. See the export guide.
  • exec runs a game or tool with a Virtual Game View. Overwrite is the default Output Target.

Run mods <command> --help for the installed command's options. See the command reference for examples.

Conflict analysis does not inspect BSA members or prove runtime compatibility. Managed execution does not guarantee analytical Tombstone suppression. It enforces load order by setting the modification times of plugin and BSA files, including files in the game's Data folder. plugins.txt lists the active plugins. Its line order is the load order. To change the load order, reorder its lines. There is no loadorder.txt. Read the conflict and execution guide before relying on those results.

Preview before exporting. The output must be a new folder outside the Environment Root and Game Installation. Export does not install into a game or launch it.

Install the agent skill

The mods-cli skill gives your coding agent a CLI reference, including FOMOD Choices, Install Plan previews, and approval rules for changes and program execution.

With Node.js and npm available, run:

npx skills add Reilley64/mods --skill mods-cli

Choose your agent and installation scope when prompted. This installs instructions for the agent, not the CLI. To update installed skills:

npx skills update

The skill uses v0.1.0 as its tested reference. It allows minor and patch version differences when installed help confirms the requested commands and options. Read the skill or learn about skills.sh.

AI in development

We use AI agents to research changes, write code and tests, update documentation, and review code. Maintainers set the scope and remain responsible for what ships. Agents follow the repository's coding standards and task instructions in AGENTS.md.

We check changes through human code reviews, compiler checks, formatting, linting, and tests. An AI-assisted style check reviews Rust changes against the coding standards. These checks and agent reviews can miss bugs. They do not replace testing with the game. Agents must report checks they could not run and limits in what they tested.

The optional agent skill lets your agent use the CLI. You can use the CLI without an AI agent.

Documentation

License

mods is licensed under GPL-3.0-or-later. See copyright and license details and the upstream notices.

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages