-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8cc15c4
commit 990f4ca
Showing
1 changed file
with
17 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,22 @@ | ||
| # AvicusNetwork | ||
| A **massive** maven project of all of our private plugins. | ||
| # Atlas | ||
| Run Avicus games on any server. | ||
|
|
||
| # Plugins: | ||
| This version of the code is the standalone release and requires no backend. | ||
|
|
||
| ## Atlas | ||
| Runs matches, parses XML, and generates docs. | ||
| ### Core | ||
| The main plugin. This holds the general parsing infrastructure for maps and running matches. | ||
| This component holds the functionality which loads the rest of the external jars. | ||
| ### Competitive-Objectives | ||
| Holds parsing and data classes for all objectives related to competitive. | ||
| ### Docs-Generator | ||
| Holds code for generating the docs.avicus.net documentation files from the documentation in each file. | ||
| ### Arcade | ||
| Holds modules for the arcade gamemodes. | ||
| ### Walls | ||
| Holds the walls component and special kits. | ||
| While this version of the codebase is far easier to run than the full release, it does come with some drawbacks. These drawbacks include, but are not limited to: | ||
| * No persistence support (nothing is saved) | ||
| * No built-in tournament support | ||
| * No lobby support | ||
| * No punishment enforcement support | ||
|
|
||
| ## Atrio | ||
| This is the lobby plugin. It handles basic lobby things such as portals and jump pads. | ||
| If you require any or all of these features, the backend-dependant version can be found [here](https://github.com/Avicus/AvicusNetwork). | ||
|
|
||
| ## Hook | ||
| ### Core | ||
| This is used to be where all the DB stuff was, but then Magma came along. It's kinda useless. | ||
| ### Discord | ||
| The legacy discord bot. This runs user registration and the such. This is slowly being moved to the ruby app. | ||
| ### TeamSpeak | ||
| The teamspeak bot. Handles user registration and ranks. Useless as of 12/7/17. | ||
| ### Bukkit | ||
| Bukkit plugin which handles database stuff. This is becoming more and more obsolete as things are being moved to Magma. | ||
| This is compiled after Atlas, so it allows us to use Atlas things. T | ||
| his runs on servers without Atlas, however, so checks should be made to ensure Atlas before including classes. | ||
| **NOTE:** This will be the only version of the codebase that will receive any major updates going forward. | ||
|
|
||
| ## Magma | ||
| ### Core | ||
| Core API and database connections live here. This runs on every server bukkit/bungee. | ||
| ### Bungee | ||
| The bungee plugin. Handles user registration and MOTDs. | ||
| ### Bukkit | ||
| Core code for most of the stuff we do. Code ranges from API to backpacks and gadgets. | ||
|
|
||
| ## Mars | ||
| The tournament/scrimmage plugin. This runs all of the tournament and scrimmage things. | ||
| ### People involved (show them some :heart:): | ||
| - **Keenan Thompson** ([@thekeenant](https://github.com/thekeenant)) - Project Direction & Initial Frameworks | ||
| - **Austin Mayes** ([@AustinLMayes](https://github.com/AustinLMayes)) - Project Direction, Feature Implementation, and Standalone Conversion | ||
| - [@kashike](https://github.com/kashike) - Feature Implementation, Performance Improvements, lots of QOL Stuff, and Bugfixes | ||
| - **Andrés Gorrochategui** ([@andrgorr](https://github.com/andrgorr)) - Performence Improvements & Bugfixes | ||
| - **Connor Roizman** ([@connorjayr](https://github.com/connorjayr)) - General Maintenance | ||
| - **Tomaž Bizjak** ([@TheBizii](https://github.com/TheBizii)) - General Maintenance |