modpol/README.md
2021-03-14 22:52:57 -06:00

72 lines
2.8 KiB
Markdown

# Modular Politics Prototype for Minetest
This is a mod for [Minetest](https://minetest.net) that enables diverse governance mechanisms. It seeks to implement the [Modular Politics](https://metagov.org/modpol) proposal. Ideally, in the future, it
will be possible to use this framework to simulate governance in a
number of platform contexts.
This mod produces an API that can serve as a dependency for other mods that add specific governance functionalities.
Currently modpol requires a Unix-style system. But it is intended to become more fully platform independent. Here, only the init.lua (and the optional storage-mod_storage.lua) files are Minetest-specific.
For background information and project roadmap, see [the wiki](https://gitlab.com/medlabboulder/modpol/-/wikis/home).
## Command line
To interact with the interpreter on Unix systems in CLI mode, install
lua or luajit and execute the following command in this directory:
```
$ lua
> dofile("modpol.lua")
```
For a list of global functions and tables, use `modpol.menu()`.
## Minetest
To use this in Minetest, simply install it as a Minetest mod. Minetest
will load init.lua. See the source code for information about chat
commands which can then be used.
Use the `/menu` command to see a list of registered chat commands.
## Storage
By default, a data directory named "data" will be created in this directory. "/data" will contain a log file and serialized program data files.
Another storage method may be chosen in modpol.lua. A StorageRef-based method for Minetest 5.* is included: storage-mod_storage.lua.
## Standalone Modular Politics
To separate the Modular Politics core from the Minetest mod, simply remove these files:
```
mod.conf
init.lua
description.txt
depends.txt
/storage/storage-mod_storage.lua
/modpol_minetest/
```
Eventually the stand-alone modpol package will be published as a separate repo.
## Credits
Initiated by [Nathan Schneider](https://nathanschneider.info) of the [Media Enterprise Design Lab](https://colorado.edu/lab/medlab) at the University of Colorado Boulder, as part of the [Metagovernance Project](https://metagov.org). Based on the paper "[Modular Politics: Toward a Governance Layer for Online Communities](https://metagov.org/modpol)."
Thanks to contributors:
* [MisterE](https://gitlab.com/gbrrudmin) (project refactoring, core feature development)
* Robert Kiraly [[OldCoder](https://github.com/oldcoder/)] (ocutils.lua, storage-local.lua, project refactoring)
We'd love to welcome more contributors, particularly from the Minetest community! Please join the conversation in the [Issues](https://gitlab.com/medlabboulder/modpol/-/issues) or the [Minetest.net forum](https://forum.minetest.net/viewtopic.php?f=47&t=26037).
## Licenses
* [Project](LICENSE.mt): MIT-based Hippocratic License
* [Lua Serpent Serializer](serpent/LICENSE.txt): MIT