<commit_before>ProjectAres
===========

Custom Bukkit/Bungee plugins used by the former Overcast Network

# License

ProjectAres is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

A copy of the GNU Affero General Public License is included in the file LICENSE.txt


# Status

**It is currently a major pain in the ass to build this and get it running.
We know this, and will improve the situation in the near future.**

These plugins were converted from an internal project to open source in a rush,
so they are not yet well adapted for third party use. Improving this adaptation
is a top development priority, specifically:

* Build/deployment infrastructure
* Eliminating dependencies on external plugins (e.g. raven-minecraft)
* Allowing network features to be fully disabled
* Expanding standalone functionality
* Map author username lookup through Mojang API
* Documentation for third-parties (e.g. "how do I run this thing??")


# Getting Help

You *may* find some help on the PGM Discord, in these channels:

[#help](https://discord.gg/wSYAT55) Help with *running* a ProjectAres server

[#contributing](https://discord.gg/6zGDEen) Discussion about *contributing* to ProjectAres

Please keep in mind that this help is provided by volunteers and other users,
out of the kindness of their golden hearts, and not as an obligation to you.


# Building

At the moment, we don't have a Maven repository thingy, so you will have to build and
install several dependencies by hand:

* https://github.com/OvercastNetwork/gson (custom fork)
* https://github.com/OvercastNetwork/sk89q-command-framework (custom fork)
* https://github.com/OvercastNetwork/test-util
* https://github.com/OvercastNetwork/raven-minecraft
* https://github.com/OvercastNetwork/Settings
* https://github.com/OvercastNetwork/BukkitSettings
* https://github.com/OvercastNetwork/ChatModerator
* https://github.com/OvercastNetwork/minecraft-api
* https://github.com/OvercastNetwork/BungeeCord (custom fork)
* https://github.com/OvercastNetwork/SportBukkit


# Running

The Bukkit plugins in this repo work only with SportBukkit, not regular CraftBukkit.

Appropriate SportBukkit settings are provided in `bukkit.yml.sample` in this folder.
Of particular interest are these:

* `settings.bungeecord: true` This is required in order to connect through Bungee
* `settings.legacy-knockback: true` Emulate knockback mechanics from older versions of Minecraft
* `settings.water-pushes-tnt: false` Disable water pushing TNT, a newer Minecraft feature that we don't use.

These plugins are required for any SportBukkit server:

* raven-bukkit
* bukkit-settings
* api-bukkit<commit_msg>Add Channels dependency to README<commit_after>ProjectAres
===========

Custom Bukkit/Bungee plugins used by the former Overcast Network

# License

ProjectAres is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

A copy of the GNU Affero General Public License is included in the file LICENSE.txt


# Status

**It is currently a major pain in the ass to build this and get it running.
We know this, and will improve the situation in the near future.**

These plugins were converted from an internal project to open source in a rush,
so they are not yet well adapted for third party use. Improving this adaptation
is a top development priority, specifically:

* Build/deployment infrastructure
* Eliminating dependencies on external plugins (e.g. raven-minecraft)
* Allowing network features to be fully disabled
* Expanding standalone functionality
* Map author username lookup through Mojang API
* Documentation for third-parties (e.g. "how do I run this thing??")


# Getting Help

You *may* find some help on the PGM Discord, in these channels:

[#help](https://discord.gg/wSYAT55) Help with *running* a ProjectAres server

[#contributing](https://discord.gg/6zGDEen) Discussion about *contributing* to ProjectAres

Please keep in mind that this help is provided by volunteers and other users,
out of the kindness of their golden hearts, and not as an obligation to you.


# Building

At the moment, we don't have a Maven repository thingy, so you will have to build and
install several dependencies by hand:

* https://github.com/OvercastNetwork/gson (custom fork)
* https://github.com/OvercastNetwork/sk89q-command-framework (custom fork)
* https://github.com/OvercastNetwork/test-util
* https://github.com/OvercastNetwork/raven-minecraft
* https://github.com/OvercastNetwork/Settings
* https://github.com/OvercastNetwork/BukkitSettings
* https://github.com/OvercastNetwork/Channels
* https://github.com/OvercastNetwork/ChatModerator
* https://github.com/OvercastNetwork/minecraft-api
* https://github.com/OvercastNetwork/BungeeCord (custom fork)
* https://github.com/OvercastNetwork/SportBukkit


# Running

The Bukkit plugins in this repo work only with SportBukkit, not regular CraftBukkit.

Appropriate SportBukkit settings are provided in `bukkit.yml.sample` in this folder.
Of particular interest are these:

* `settings.bungeecord: true` This is required in order to connect through Bungee
* `settings.legacy-knockback: true` Emulate knockback mechanics from older versions of Minecraft
* `settings.water-pushes-tnt: false` Disable water pushing TNT, a newer Minecraft feature that we don't use.

These plugins are required for any SportBukkit server:

* raven-bukkit
* bukkit-settings
* api-bukkit
{'fraction_non_alphanumeric': 0.07076079948420375, 'fraction_numerical': 0.0019342359767891683, 'mean_word_length': 4.85377358490566, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 25, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2416925', 'n_tokens_mistral': 1711, 'n_tokens_neox': 1676, 'n_words': 754}