Skip to content

About

The catalog of Lua plugins for openOMSI: reviewed, open source, installed from the launcher's Plugins page

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

openOMSI Plugins

The catalog of Lua plugins for openOMSI. The launcher's Content → Plugins → Browse lists what is here; one click installs a plugin into the game's plugins folder, and an update of it is offered when its version here goes up.

Every plugin is open source and read by a maintainer before it is merged, so anyone can see what runs in their game. Plugins come in through pull requests: see CONTRIBUTING.md.

How it works

  • plugins/<id>/ holds a plugin: its main.lua, its other files, and plugin.json (name, author, version, description, licence, tags).
  • catalog.json lists every plugin with the size and the SHA-256 of each of its files. It is made by python3 tools/build_catalog.py, and the checks fail when it is out of date.
  • The launcher reads catalog.json from this repository's main branch, downloads a plugin's files from the same branch, and installs them only when every size and SHA-256 matches. It installs into plugins/<id>/ of the game's content folder and keeps plugins/<id>/data/ (the plugin's settings and saved data) on an update.

Writing a plugin: docs/PLUGINS.md in the game's repository.

Licence

The tools and the files of this repository are AGPL-3.0-only (LICENSE); each plugin has the licence its plugin.json names.

About

The catalog of Lua plugins for openOMSI: reviewed, open source, installed from the launcher's Plugins page

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages