This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
tutorial:program:oppm [2014/08/18 14:15] vexatos [Using OPPM] |
tutorial:program:oppm [2015/02/04 16:57] vexatos [Registering packages globally] |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| ============================================ | ============================================ | ||
| - | The OpenPrograms Package Manager, called OPPM, is a program available through a dungeon loot disk in OpenComputers. It provides a large variety of programs, henceforth called "packages", for you to download and install easily. It is meant to make users able to easily distribute their programs, it is supposed to make installing, updating and uninstalling packages just as easy as creating and registering them. | + | The OpenPrograms Package Manager, called OPPM, is a program available through a dungeon loot disk in OpenComputers. It provides a large variety of programs, from now on called "packages", for you to download and install easily. It is meant to make users able to easily distribute their programs, it is supposed to make installing, updating and uninstalling packages just as easy as creating and registering them. |
| ##Using OPPM | ##Using OPPM | ||
| Line 19: | Line 19: | ||
| - `oppm update <package>` | - `oppm update <package>` | ||
| - | This command uninstalls the specified package and re-downloads it, making sure you have the very-most up-to-date version of the package. if `package` is "all", every package that is currently installed will be updated. | + | This command uninstalls the specified package and re-downloads it, making sure you have the very-most up-to-date version of the package. If `package` is "all", every package that is currently installed will be updated. |
| - `oppm uninstall <package>` | - `oppm uninstall <package>` | ||
| Line 27: | Line 27: | ||
| _Note_: If you only want to use packages provided by other people and do not want to make any packages yourself, you can stop reading now. | _Note_: If you only want to use packages provided by other people and do not want to make any packages yourself, you can stop reading now. | ||
| - | _Note 2_: General knowledge of using Lua and GitHub is henceforth presupposed. | + | _Note 2_: General knowledge of using Lua and GitHub is being required. |
| To register a package yourself, you need to have every file the program needs to run on some repository on [[https://github.com/|GitHub]]. | To register a package yourself, you need to have every file the program needs to run on some repository on [[https://github.com/|GitHub]]. | ||
| Line 58: | Line 58: | ||
| }, | }, | ||
| dependencies = { | dependencies = { | ||
| - | ["some-dependency"] = "/lib"--This package is installed into the specified subfolder | + | ["GML"] = "/lib"--This package is installed into the specified subfolder |
| }, | }, | ||
| name = "Package name",--This is for "oppm info" | name = "Package name",--This is for "oppm info" | ||
| Line 68: | Line 68: | ||
| }, | }, | ||
| ["yet-another-package"] = { | ["yet-another-package"] = { | ||
| - | --...-- | + | ... |
| } | } | ||
| }, | }, | ||
| Line 97: | Line 97: | ||
| ```lua | ```lua | ||
| {--This is an example for a programs.cfg file. Please do not add any comments inside actual programs.lua files | {--This is an example for a programs.cfg file. Please do not add any comments inside actual programs.lua files | ||
| - | ["example-package"] = { | + | ["example-package"] = { |
| - | files = { | + | files = { |
| - | ["master/somefolder/bar.lua"] = "/",--"/" means the file will be placed inside the folder the user specified, defaults to /usr | + | ["master/somefolder/bar.lua"] = "/",--"/" means the file will be placed inside the folder the user specified, defaults to /usr |
| - | ["master/somefolder/barinfo.txt"] = "//etc", -- double slash for using an absolute path | + | ["master/somefolder/barinfo.txt"] = "//etc", -- double slash for using an absolute path |
| - | ["master/somefolder/barlib.lua"] = "/subfolder",--Places the file in a subfolder in the user-specified folder | + | ["master/somefolder/barlib.lua"] = "/subfolder",--Places the file in a subfolder in the user-specified folder |
| - | ["master/somefolder/libfolder/"] = "/" | + | ["master/somefolder/libfolder/"] = "/" |
| + | }, | ||
| + | dependencies = { | ||
| + | ["GML"] = "/lib"--This package is installed into the specified subfolder | ||
| + | }, | ||
| + | name = "Package name",--This is for "oppm info" | ||
| + | description = "This is an example description",--This is for "oppm info" | ||
| + | authors = "Someone, someone else",--This is for "oppm info" | ||
| + | note = "Additional installation instructions, general instructions and additional information/notes go here, this is an optional line.", | ||
| + | hidden = true, -- Add this optional line to make your package not visible in "oppm list", useful for custom dependency libraries | ||
| + | repo="tree/master/somefolder" --Used by the website. This is where the package will link to on the website | ||
| }, | }, | ||
| - | dependencies = { | + | ["yet-another-package"] = { |
| - | ["GML"] = "/lib"--This package is installed into the specified subfolder | + | ... |
| - | }, | + | } |
| - | name = "Package name",--This is for "oppm info" | + | |
| - | description = "This is an example description",--This is for "oppm info" | + | |
| - | authors = "Someone, someone else",--This is for "oppm info" | + | |
| - | note = "Additional installation instructions, general instructions and additional information/notes go here, this is an optional line.", | + | |
| - | hidden = true, -- Add this optional line to make your package not visible in "oppm list", useful for custom dependency libraries | + | |
| - | repo="tree/master/somefolder" --Used by the website. This is where the package will link to on the website | + | |
| - | }, | + | |
| - | ["yet-another-package"] = { | + | |
| - | ... | + | |
| - | } | + | |
| } | } | ||
| ``` | ``` | ||