Skip to content

A simple CLI based mod manager for Cities: Skylines.

License

Notifications You must be signed in to change notification settings

d4vzz/CSMM-CLI

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CSMM-CLI

Mod manager for Cities: Skylines.

Version Downloads License

Description

csmm-cli is a command line application to manage your Cities: Skylines mods. It lets you install any mod or collection from Cities: Skyline's steam workshop page, uninstall a mod if you don't need it any more, or update your installed mods. It automates most of your work to manage mods and does it reliably and quickly, allowing you to spend more time playing and less time getting frustrated.

Features

  • Install single mod or collection
  • Required mods installed automatically
  • Concurrent installations to optimize speed
  • Multiple sources to install mods from
  • Uninstall multiple mods at once
  • Update all mods at once
  • List all installed mods
  • Supports multiplatform

Table of Contents

Getting Started

Prerequisites

  • Install Node.js if you haven't already.
  • Delete any mods installed previously.
  • Backup your game's saves directory.

Installation

csmm-cli is distributed on npm. In order to install it globally, run the following command:

$ npm install -g csmm-cli

Usage

When you run the CLI for the first time it will ask you a few configuration questions.

  • Max Concurrent Tasks: Maximum no. of simultaneous downloads or fetching.

  • Saves Directory: Your Cities: Skylines user path.

  • Temperory Downloads Folder: Folder to store temperory downloads.

If the pre-filled details are correct, just press enter (or return) otherwise you can fill in your own custom details.

Commands

csmm install <steamId>

Install a single mod, complete collection or part of collection along with all of their dependencies.

USAGE
  $ csmm install <steamId> [options]

ARGUMENTS
  steamId                     steamId of item/collection

OPTIONS
  -e, --edit                  To edit items of a collection before install.
  -m, --method={STEAM|SMODS}  To set download source [default: STEAM] .

Use id in steam workshop's URL for <steamId>.

csmm uninstall [<steamId>]

Uninstall a single item or choose from an interactive list.

USAGE
  $ csmm uninstall [<steamId>]

ARGUMENTS
  steamId (Optional)           steamId of installed item

Use command with <steamId> to uninstall single mod. Executing command without <steamId> will provide an interactive list to uninstall multiple items at once.

csmm update

Updates all outdated mods at once, and also installs missing dependencies if any.

USAGE
  $ csmm update

csmm list

Lists all installed mods.

USAGE
  $ csmm list

csmm config

Re-run configuration setup, to modify :

  • Max Concurrent Tasks
  • Saves Directory
  • Temperory Downloads Folder
$ csmm config

All previously saved configuration values will be preserved.

csmm help [command]

Display help for csmm-cli commands.

USAGE
  $ csmm help [command] [options]

ARGUMENTS
  command (optional)            command to show help for

OPTIONS
  --all                         see all commands in CLI

FAQ

  • Y SO EMPTY?
    • Havn't got many questions yet :) Feel free to ask though.

License

About

A simple CLI based mod manager for Cities: Skylines.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%