Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/README.md
121 changes: 0 additions & 121 deletions README.md

This file was deleted.

3 changes: 1 addition & 2 deletions _layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,10 @@
<nav>
<li><a href="{{ page.root }}index.html">Home</a></li>
<li><a href="{{ page.root }}mods.html">Mods</a></li>
<li><a href="{{ page.root }}README.html">Manifest</a></li>
<li><a class="hr"
href="https://github.com/minetest-mods">GitHub</a></li>
<li><a
href="https://forum.minetest.net/viewtopic.php?f=47&t=13839">Forum</a></li>
href="https://forum.luanti.org/viewtopic.php?t=13839">Forum</a></li>



Expand Down
150 changes: 116 additions & 34 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,137 @@
---
---
title: Welcome
layout: default
---

This project exists to **provide a semi-trusted source of Minetest Mods**.
Mods here should be stable (at least in the master branches).
All mods should work well together.

## How is a Mod added?
## Introduction

The original author of the Mod should be the one submitting it to the minetest-mods
project. Under circumstances (abandoned, author not responsive etc.) we will consider
forks. To submit your project to be added and become the maintainer of a project, submit
a new github issue.
This project exists to **provide a semi-trusted source of Luanti/Minetest mods**.
The mod repositories are primarily developed by their author(s), or are taken care of
by the community, managed by the admins.

In your request, please provide the following information:
### General rules

* your mod name
* author (github username)
* the license(s) of your mod
* Keep the `master` branch stable as possible.
* Keep the mods in a usable and secure (maintained) state.
* Behave and respect each other.

## Roles

### 1. Organisation administrator

Brief: _Keeps an eye on all repositories, and manages them._

**Privileges:**

* Has full access to all minetest-mods repositories, which includes:
* Repository creation and deletion
* Access/permission management
* Modifying content and managing user contributions (patches, issues, PRs)

**Duties:**

* Must respect the decisions of the mod author.
* Must obtain a decision from the mod author (if active) before deciding on their own.
* Ensures that the mod requirements are met (section "How to add a mod?").
* Is in charge to resolve security-related topics.

### 2. Mod author

Brief: _Develops their mod, with or without external contributions._

**Privileges:**

* Has full access to their mod repository, which includes:
* Access/permission management (e.g. co-authorship)
* Modifying content and managing user contributions (patches, issues, PRs)
* If any action cannot be performed due to technical limitations - e.g. repository removal -
the task shall be done by an admin.

**Duties:**

* Unless communicated explicitly, the mod author permits the community to maintain their
project, managed by the co-authors or organisation admins.
* Ensures proper functionality of the mod.

### 3. Individual contributor

By submitting a project, you acknowledge that you agree to the rules in the [manifest](README.html)
Brief: _Contributes to mods within the organisation._

Click here: [Open Request](https://github.com/minetest-mods/minetest-mods.github.io/issues/new?title=New%20mod%20request)
**Privileges:**

After opening a request ticket, you will be asked to initiate a "Transfer" request to move your mod. If you want to fork your moved repository back, you are obviously free to do so. You will be granted admin access on the moved repository. More information on the "Transfer" procedure can be found here: [Transfer Information](https://help.github.com/articles/transferring-a-repository/)
* May propose commits, PRs, and submit issues.
* May have limited access to mod repositories - granted by mod authors or admins.

We also send all mod owners a "become a member of minetest-mods" invitation. This invitation does not need to be accepted, and is merely for you (and us) to show who is participating in the minetest-mods organization. You do not require the invite. If you missed it, and would still like to become a listed member, please request another invitation.
**Duties:**

* Must respect the decisions of the mod author.

## How to add a mod?

Mods added to this organisation must follow a few minimal requirements, which are listed below.

### Requirements

**Ownership**

* The original author of the mod should be the one submitting it to the minetest-mods
organisation.
* Under circumstances (abandoned by author) we will consider
forks.

**Licensing**

* An OSI-approved license is strongly preferred.
* Mods do not need to be Luanti-licensing compatible (meaning, GPL 3.0+ is accepted)
* Public Domain is not defined well in many countries, thus licenses such as
MIT or CC0 should be used. Prefer CC0 over WTFPL.

**Mod structure**

* Required
* A clear statement on the code and media licensing
* A `mod.conf` file
* Strongly recommended
* Screenshot
* Matching LICENSE files

**Mod name**

Many mods have similar names but sometimes provide very different functionality.
For the purpose of clarity, conflicting names are to be prevented.
Repositories in the minetest-mods organisation should have clear and unambiguous
names.

### Submitting

In your request, please provide the following information:

* your mod name
* author (GitHub username, if available)
* the license(s) of your mod

## Can any Minetest mod be added?
By submitting a project, you acknowledge that you agree to the rules specified in this document.

* Mods should preferrably be licensed under an OSI approved license.
* Mods do not need to be minetest-licensing compatible (meaning, GPL3.0+ is fine)
* Non-OSI licenses may be acceptable.
* Public Domain is not defined well in many countries, so licenses such as WTFPL,
MIT or CC0 should be used.
* [Open Request (GitHub)](https://github.com/minetest-mods/minetest-mods.github.io/issues/new?title=New%20mod%20request) (preferred)
* [Open Request (Luanti Forums)](https://forum.luanti.org/viewtopic.php?t=13839) (alternative)

## What's in it for users?
### Repository transfer

* A central place to find well-maintained mods.
* Clarity as to which fork is the recommended version of a mod.
* Well-defined mods with proper metadata that work without renaming and installation issues.
* The security of knowing many more developers are looking at mod code than just one person.
After opening a request ticket, you will be asked to initiate a "Transfer" request to move your mod.
If you want to fork your moved repository back, you are obviously free to do so.
You will be granted admin access on the moved repository. More information on the "Transfer" procedure
can be found here: [Transfer Information](https://help.github.com/articles/transferring-a-repository/)

## What's in it for developers?
* Knowing that they can take a break from Minetest when they need or choose to, and that someone will be capable of taking care of their mods.
* A large group of experienced mod developers that are willing to help out improve their code.
* More users looking at their mods and better exposure.
We also send all mod owners a "become a member of minetest-mods" invitation.
This invitation does not need to be accepted, and is merely for you (and us)
to show who is participating in the minetest-mods organisation.
You do not require the invite. If you missed it, and would still like to become a listed member,
please request another invitation.

## Got any more questions?

Read [our full manifest](README.html).
Read the informal [forum announcement post](https://forum.luanti.org/viewtopic.php?t=13839),
and leave feedback or join the discussion.

Alternatively, read the informal [forum announcement post](https://forum.minetest.net/viewtopic.php?f=47&t=13839), and leave feedback or join the discussion.
Request a clarification of the rules stated above: [Open Request (GitHub)](https://github.com/minetest-mods/minetest-mods.github.io/issues/new).