@@ -17,8 +17,12 @@ GNU Affero General Public License for more details.
1717
1818A copy of the GNU Affero General Public License is included in the file LICENSE.txt
1919
20+
2021# Status
2122
23+ ** It is currently a major pain in the ass to build this and get it running.
24+ We know this, and will improve the situation in the near future.**
25+
2226These plugins were converted from an internal project to open source in a rush,
2327so they are not yet well adapted for third party use. Improving this adaptation
2428is a top development priority, specifically:
@@ -31,6 +35,18 @@ is a top development priority, specifically:
3135* Documentation for third-parties (e.g. "how do I run this thing??")
3236
3337
38+ # Getting Help
39+
40+ You * may* find some help on the PGM Discord, in these channels:
41+
42+ [ #help] ( https://discord.gg/wSYAT55 ) Help with * running* a ProjectAres server
43+
44+ [ #contributing] ( https://discord.gg/6zGDEen ) Discussion about * contributing* to ProjectAres
45+
46+ Please keep in mind that this help is provided by volunteers and other users,
47+ out of the kindness of their golden hearts, and not as an obligation to you.
48+
49+
3450# Building
3551
3652At the moment, we don't have a Maven repository thingy, so you will have to build and
@@ -47,6 +63,35 @@ install several dependencies by hand:
4763* https://github.com/OvercastNetwork/BungeeCord (custom fork)
4864* https://github.com/OvercastNetwork/SportBukkit
4965
66+
67+ # Running
68+
69+ The Bukkit plugins in this repo work only with SportBukkit, not regular CraftBukkit.
70+
71+ Appropriate SportBukkit settings are provided in ` bukkit.yml.sample ` in this folder.
72+ Of particular interest are these:
73+
74+ * ` settings.bungeecord: true ` This is required in order to connect through Bungee
75+ * ` settings.legacy-knockback: true ` Emulate knockback mechanics from older versions of Minecraft
76+ * ` settings.water-pushes-tnt: false ` Disable water pushing TNT, a newer Minecraft feature that we don't use.
77+
78+ These plugins are required for any SportBukkit server:
79+
80+ * raven-bukkit
81+ * bukkit-settings
82+ * api-bukkit
83+ * commons-bukkit
84+ * Channels
85+ * chatmoderator (optional)
86+
87+ For a PGM server, you also need these:
88+
89+ * PGM
90+ * Tourney (optional)
91+
92+ For a Lobby server, you just need the Lobby plugin.
93+
94+
5095# Contents
5196
5297* ` Util ` Utility code library (not a plugin) used by everything
@@ -81,34 +126,6 @@ for running a standalone server. The api-ocn plugin is the backend implementatio
81126the former Overcast Network.
82127
83128
84- # Running
85-
86- The Bukkit plugins in this repo work only with SportBukkit, not regular CraftBukkit.
87-
88- Appropriate SportBukkit settings are provided in ` bukkit.yml.sample ` in this folder.
89- Of particular interest are these:
90-
91- * ` settings.bungeecord: true ` This is required in order to connect through Bungee
92- * ` settings.legacy-knockback: true ` Emulate knockback mechanics from older versions of Minecraft
93- * ` settings.water-pushes-tnt: false ` Disable water pushing TNT, a newer Minecraft feature that we don't use.
94-
95- These plugins are required for any SportBukkit server:
96-
97- * raven-bukkit
98- * bukkit-settings
99- * api-bukkit
100- * commons-bukkit
101- * Channels
102- * chatmoderator (optional)
103-
104- For a PGM server, you also need these:
105-
106- * PGM
107- * Tourney (optional)
108-
109- For a Lobby server, you just need the Lobby plugin.
110-
111-
112129# Coding Guidelines
113130
114131* General
0 commit comments