Skip to content

Configuration

Josh edited this page Sep 11, 2022 · 3 revisions

All configurations are of type string unless otherwise specified.

GitHub

The default source for programs and libraries is our GitHub organisation. If you want to use your own instead, you can change the user name in the configuration.

If you've forked this repository, you can change the configurations directly within the script.

The values you may want to change are,

  • user
  • repository
  • branch
  • rawURL - If you are not on GitHub, you can change the URL here.
  • programSuffix and librarySuffix - Those are used to differentiate between libraries and programs, as they should be installed in different directories.
  • infoFile - Here you can change the name of the info file, which is used to get the names of all files that should be downloaded when installing a program.
  • apiGithubURL - API URL of GitHub, not sure if this can be easily replaced for a different website.
  • apiGithubGetRepos - API Call for GitHub to get all repositories of this organisation.
  • installScript - Add your own install script to the configuration so that scm update updates from the correct source. You can just copy ours and replace the URL: SCM Installer

Local

Local changes only affect the structure and behaviour of SCM on your local machines within Minecraft.

  • programDirectory
  • libraryDirectory
  • configDirectory
  • configFile
  • scriptFile
  • verbose - boolean Whether or not to print additional information.
  • printPrefix - Adds a custom prefix to log outputs.
  • logDate - boolean Decides if a date should be attached to log outputs.
  • writeLogFile - boolean Gives the option to write logs to a file.
  • logFilePath
  • repoScriptsFile - File to store the repositories after an API call
  • allowCLIPrefix - boolean Decides if cliPrefix can be activated.
  • cliPrefix - boolean When activated, automatically adds scm infront of your cursor when SCM was called directly from within the console.
Clone this wiki locally