minetest_collective/README.md
Bill Niblock f1553e6c8e First Upload of Collective
This first upload includes a relatively full and untested version of
Collective. Much should be done still.

- README.md: Basic repository and code information
- init.lua: The first implementation of collective. Entirely tested on a
  single-player server, meaning much of the multi-person aspects are
  currently untested. This is first priority.
- mod.conf: Standard Minetest mod stuff

TO-DO:

- Test Collective on a multi-player server with multiple people.
2022-05-25 18:00:39 -04:00

38 lines
1 KiB
Markdown

# Collective
Collective is a mod for [Minetest](https://www.minetest.net/) that facilitates
groups and group-related activities.
Collective is a work-in-progress, and currently should be used at your own risk.
Functionality has not been sufficiently tested, nor completed.
## Installation
Collective has no dependencies. To use Collective, follow the [mod installation
instructions](https://wiki.minetest.net/Installing_Mods) from the wiki, or this
summary:
- Create a folder in your mod directory called `collective`
- Unzip the [latest archive]() into that directory
- Enable the mod by adding `load_mod_collective = true` to your `world.mt` file.
```
minetest/
├── ...
├── mods/
│ ├── ...
│ └── collective/
│ ├── mod.conf
│ └── init.lua
├── ...
└── worlds/
├── ...
└── your_world
├── ...
└── world.mt
```
## Contributing
Open a PR and ping me! I'm
[Vagabond](https://matrix.to/#/@vagabondazulien:exp.farm) on Matrix.