Home - litjisz/Astra GitHub Wiki

Astra Framework

What is Astra?

Astra is a comprehensive framework for developing Minecraft plugins for Paper servers. Designed to simplify the development process, Astra provides a modular architecture and a set of tools that reduce boilerplate code and promote good programming practices.

Key Features

Module System: Modular architecture with automatic lifecycle management
Dependency Injection: Access to registered modules through the Implements system
Command Framework: Simplified command creation with integrated permission handling
Configuration Management: Advanced system for handling YAML configuration files
Task System: Management of asynchronous and scheduled tasks
Development Utilities: Logging, class scanning, and more

Requirements

Java 17 or higher
Paper server (latest version recommended)
Maven

Getting Started

To start using Astra, check out our Getting Started Guide.

Documentation

Examples

You can find examples of plugins created with Astra in our examples repository.

Wiki out of date?

The wiki may not be updated to the latest release of the project, this wiki was written for version 0.0.4. Astra does not usually change the methods or their operation in a radical way, so if you are using a higher version of the framework, the wiki will probably still be functional despite not having all the documented features of future versions. This wiki is updated whenever possible, since this project is only being developed by 1 person and he has more occupations besides maintaining this project.

License

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

To contribute:

Fork the repository
Create a branch for your feature (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add some amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Support

If you have any questions or issues, please open an issue in the repository.