Skip to content

Latest commit

 

History

History
94 lines (55 loc) · 2.93 KB

README.md

File metadata and controls

94 lines (55 loc) · 2.93 KB
Raw

Lightning Factions

Ever wanted a Factions plugin that runs Lightning fast, with database capabilities, absurd amount of configuration, and an extremely dynamic API? Yeah, me too. When this project started it was just an experiment to see what levels of efficiency I could pump out of Minecraft. Since then it has grown into the most robust and most efficient Faction plugin to date.

Preface

If you want to create a fork or simply poke around in the code, worry not. This plugin is and will remain to be open source. Richard Stallman summed it up by saying "Think free as in freedom of speech, not free beer". That being said, please pay for the compiled software on the official page. The project is maintained by a team of developers, and we like to be able to enjoy a pizza while we program every once and awhile.

For those who want to contribute to the project or modify it to their own needs, here is how to get started. A quick note however; almost everything is disableable. If you do not want a feature, turn it off in the config file. The system will, for almost everything, not use any additional memory or processing power on disabled features.

That being said, let's dive in!

How To Use

Prerequisites

To download and run this application there are a few things you'll need.

  • Git, to download this code and keep it up to date.
  • Maven, to download dependencies and build the project.
  • Spigot, to run the plugin. Alternatively, PaperSpigot and
Give examples

Installing

A step by step series of examples that tell you have to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Code Scene

Get more details at codescene.io.

Deployment

Add additional notes about how to deploy this on a live system

Built With

  • Maven - Dependency Management

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the GPLv3 License - see the LICENSE file for details

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc