Skip to content

Naming Conventions

ChristophLHR edited this page May 12, 2023 · 3 revisions

All those names are configurable.

Repositories

Every program and every library should have their own repository. The repository should be the name of the script followed by the suffix -prog for programs and -lib for library. This is important so that SCM can differentiate between programs and libraries.

A repository should always have a file called infoFile.json in its root folder. This file must meet the following structure:

{
  "files": ["exampleFile.lua", "secondsFile.lua"],
  "versions": {
    "Standard": "Branchname_X",
    "NewFeature2": "Branchname_Y"
  }
}

files must contain the relative paths to all files that should be downloaded.

versions are optional. These must have a name and a Branch which is used for the requested version. These must be present in the Main-Branch for the feature to be utilized.

Here are two example repositories, which you can also install via SCM:


Changelog:


Issue #26: the Old way to support a repo for SCM:

A repository should always have a file called files.txt in its root folder. This file should contain the relative paths to all files that should be downloaded when the script is being installed.


Clone this wiki locally