LandSector/README.md

55 lines
1.2 KiB
Markdown

# LandSector Plugin
LandSector is a plugin for the HCU Minecraft server that allows players to claim and utilize land sectors defined by the Lands plugin.
## Dependencies
This plugin depends on:
- **hcu-core**: Core functionality for HCU server
- **Faction**: Faction management system
- **Lands**: Land definition and management system
## Project Structure
This project uses git submodules and Gradle's `includeBuild` feature to manage dependencies:
```
LandSector/
├── hcu-core/ (git submodule)
├── Faction/ (git submodule)
├── Lands/ (git submodule)
├── src/
│ └── main/
│ └── kotlin/
│ └── net/hareworks/hcu/landsector/
└── build.gradle.kts
```
## Building
To build the plugin:
```bash
./gradlew build
```
The compiled plugin will be available in `build/libs/`.
## Development
### Updating Submodules
To update all submodules to their latest versions:
```bash
git submodule update --init --recursive --remote
```
### Adding Features
The plugin is structured to allow easy extension. Main plugin logic should be added to the `net.hareworks.hcu.landsector` package.
## License
Part of the HCU server project.