Modpol/modpol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README to reflect current conditions

Browse Source
This commit is contained in:
Nathan Schneider 2021-04-27 22:28:29 -06:00
parent 06dd824f35
commit 257c7e47db
1 changed files with 17 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -1,36 +1,34 @@
# 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
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. 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
## Installation in Minetest
To interact with the interpreter on Unix systems in CLI mode, install
lua or luajit and execute the following command in this directory:
To use this in Minetest, simply install it in your mods/ or worldmods/ folder. Minetest will load init.lua.
In the game, open the Modular Politics interface with the command `/modpol`.
## Standalone Version on the Command Line
Modular Politics can also be used independently of Minetest as a command-line tool. Currently command-line use of modpol requires a Unix-style system, but it is intended to become more fully platform independent.
The command-line version is in the `modpol` subdirectory. To interact with the interpreter on Unix systems in CLI mode, install lua or luajit and execute the following command in this directory:
```
$ lua
$ cd modpol/
$ lua [or luajit]
> 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.
@ -38,28 +36,13 @@ By default, a data directory named "data" will be created in this director
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:
Other contributors include:
* [Luke Miller](https://gitlab.com/lukvmil) (main control flow, object orientation, module spec)
* [MisterE](https://gitlab.com/gbrrudmin) (project refactoring, core feature development)
* Robert Kiraly [[OldCoder](https://github.com/oldcoder/)] (ocutils.lua, storage-local.lua, project refactoring)
@ -67,5 +50,5 @@ We'd love to welcome more contributors, particularly from the Minetest community
## Licenses
* [Project](LICENSE.mt): MIT-based Hippocratic License
* [Project](LICENSE.mt): MIT
* [Lua Serpent Serializer](serpent/LICENSE.txt): MIT