]> git.lizzy.rs Git - cheatdb.git/blob - app/flatpages/policy_and_guidance.md
Improve documentation
[cheatdb.git] / app / flatpages / policy_and_guidance.md
1 title: Package Inclusion Policy and Guidance
2
3 <div class="alert alert-warning">
4         <b>Note:</b> This is a draft
5 </div>
6
7 ## 0. Overview
8
9 ContentDB is for the community, and as such listings should be useful to the
10 community. To help with this, there are a few rules to improve the quality of
11 the listings and to combat abuse.
12
13 * **No inappropriate content.** <sup>2.1</sup>
14 * **Content must be playable/useful, but not necessarily finished.** <sup>2.2</sup>
15 * **Don't use the name of another mod unless your mod is a fork or reimplementation.** <sup>3</sup>
16 * **Licenses must allow derivatives, redistribution, and must not discriminate.** <sup>4</sup>
17 * **Don't put promotions or advertisements in any package metadata.** <sup>5</sup>
18 * **The ContentDB admin reserves the right to remove packages for any reason**,
19   including ones not covered by this document, and to ban users who abuse
20   this service. <sup>1</sup>
21
22
23 ## 1. General
24
25 The ContentDB admin reserves the right to remove packages for any reason,
26 including ones not covered by this document, and to ban users who abuse this service.
27
28
29 ## 2. Accepted Content
30
31 ### 2.1. Acceptable Content
32
33 Sexually-orientated content is not permitted.
34
35 Mature content, including that relating to drugs, excessive gore, violence, or
36 excessive horror, is not currently permitted - but will be in the future.
37
38 The submission of malware is strictly prohibited. This includes software that
39 does not do as it advertises, for example, if it posts telemetry without stating
40 clearly that it does in the package meta.
41
42 ### 2.2. State of Completion
43
44 ContentDB should only currently contain playable content - content which is
45 sufficiently complete to be useful to end-users. It's fine to add stuff which
46 is still a Work in Progress (WIP) as long as it adds sufficient value -
47 MineClone 2 is a good example of a WIP package which may break between releases
48 but still has value. Note that this doesn't mean that you should add a thing
49 you started working on yesterday, it's worth adding all the basic stuff to
50 make your package useful.
51
52 Adding non-player facing mods, such as libraries and server tools, is perfectly fine
53 and encouraged. ContentDB isn't just for player-facing things, and adding
54 libraries allows them to be installed when a mod depends on it.
55
56
57 ## 3. Technical Names
58
59 ### 3.1 Right to a name
60
61 The first package to use a name based on the creation of its forum topic or
62 ContentDB submission has the right to the technical name. The use of a package
63 on a server or in private doesn't reserve its name. No other packages of the same
64 type may use the same name, except for the exception given by 3.2.
65
66 If it turns out that we made a mistake by approving a package and that the
67 name should have been given to another package, then we *may* unapprove the
68 package and give the name to the correct one.
69
70 If you submit a package where you don't have the right to the name you will be asked
71 to change the name of the package, or your package won't be accepted.
72
73 We reserve the right to issue exceptions for this where we feel necessary.
74
75 ### 3.2. Mod Forks and Reimplementations
76
77 An exception to the above is that mods are allowed to have the same name as a
78 mod if it's a fork of that mod (or a close reimplementation). In real terms, it
79 should be possible to use the new mod as a drop-in replacement.
80
81 We reserve the right to decide whether a mod counts as a fork or
82 reimplementation of the mod that owns the name.
83
84
85 ## 4. Licenses
86
87 ### 4.1. Allowed Licenses
88
89 Please ensure that you correctly credit any resources (code, assets, or otherwise)
90 that you have used in your package.
91
92 **The use of licenses that do not allow derivatives or redistribution is not
93 permitted. This includes CC-ND (No-Derivatives) and lots of closed source licenses.
94 The use of licenses that discriminate between groups of people or forbid the use
95 of the content on servers or singleplayer is also not permitted.**
96
97 However, closed sourced licenses are allowed if they allow the above.
98
99 If the license you use is not on the list then please select "Other", and we'll
100 get around to adding it.
101
102 Please note that the definitions of "free" and "non-free" is the same as that
103 of the [Free Software Foundation](https://www.gnu.org/philosophy/free-sw.en.html).
104
105 ### 4.2. Recommended Licenses
106
107 It is highly recommended that you use a Free and Open Source software (FOSS)
108 license. FOSS licenses result in a sharing community and will increase the
109 number of potential users your package has. Using a closed source license will
110 result in your package being massively penalised in the search results and
111 package lists. See the help page on [non-free licenses](/help/non_free/) for more
112 information.
113
114 It is recommended that you use a proper license for code with a warranty
115 disclaimer, such as the (L)GPL or MIT. You should also use a proper media license
116 for media, such as a Creative Commons license.
117
118 The use of WTFPL is discouraged as it doesn't contain a
119 [valid warranty disclaimer](https://cubicspot.blogspot.com/2017/04/wtfpl-is-harmful-to-software-developers.html),
120 and also includes swearing which prevents settings like schools from using your content.
121 [Read more](/help/wtfpl/).
122
123 Public domain is not a valid license in many countries, please use CC0 or MIT instead.
124
125
126 ## 5. Promotions and Advertisements (inc. asking for donations)
127
128 You may not place any promotions or advertisements in any meta data including
129 screenshots. This includes asking for donations, promoting online shops,
130 or linking to personal websites and social media. Please instead use the
131 fields provided on your user profile page to place links to websites and
132 donation pages.
133
134 ContentDB is for the community. We may remove any promotions if we feel that
135 they're inappropriate.
136
137
138 ## 6. Reporting Violations
139
140 See the [Reporting Content](/help/reporting/) page.