diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000..72e2e14 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,22 @@ +# Copilot Instructions + +This repository follows the DPC (Dans Plugins Community) conventions defined at +https://github.com/Dans-Plugins/dpc-conventions. Read those conventions before +making any changes. + +## Technology Stack + +- Language: Java +- Build tool: None (manual compilation) +- Target platform: Spigot / Paper (Minecraft plugin) +- API version: 1.13+ + +## Project Structure + +- `me/Daniel/FlyCommand/Main.java` – Plugin source code + +## Contribution Workflow + +- Branch from `main` for all changes. +- Open a pull request against `main`. +- Reference the related GitHub issue in every pull request description. diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..555273e --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,17 @@ +name: Build + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +permissions: + contents: read + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..0e40f13 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,15 @@ +name: Release + +on: + release: + types: [ created ] + +permissions: + contents: write + +jobs: + attach: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e27f2f9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). + +## [Unreleased] + +## [1.0] + +### Added +- `/fly` command to toggle flight mode for players with the `FlyCommand.fly` permission. diff --git a/COMMANDS.md b/COMMANDS.md new file mode 100644 index 0000000..df8c8d4 --- /dev/null +++ b/COMMANDS.md @@ -0,0 +1,5 @@ +# FlyCommand Commands + +| Command | Permission | Description | +|---------|------------|-------------| +| `/fly` | `FlyCommand.fly` | Toggles flight mode on or off for the executing player. | diff --git a/CONFIG.md b/CONFIG.md new file mode 100644 index 0000000..92154e5 --- /dev/null +++ b/CONFIG.md @@ -0,0 +1,3 @@ +# FlyCommand Configuration + +FlyCommand has no `config.yml`. All behaviour is controlled via the `plugin.yml` permissions. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0ec6b94 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Contributing to FlyCommand + +Thank you for your interest in contributing! + +## Workflow + +1. Fork the repository. +2. Create a feature branch from `main`: `git checkout -b feature/my-change` +3. Make your changes. +4. Open a pull request against `main`. +5. Reference the related GitHub issue in your pull request description. + +## Code Style + +- Follow existing Java conventions in the codebase. +- Keep changes focused and minimal. + +## Reporting Issues + +Open a [GitHub issue](https://github.com/Dans-Plugins/FlyCommand/issues) with a clear description of the bug or feature request. diff --git a/USER_GUIDE.md b/USER_GUIDE.md new file mode 100644 index 0000000..cbf4adf --- /dev/null +++ b/USER_GUIDE.md @@ -0,0 +1,25 @@ +# FlyCommand User Guide + +## What is FlyCommand? + +FlyCommand is a Spigot plugin that lets permitted players toggle flight mode on and off with a single command. + +## Installation + +1. Download the latest `FlyCommand.jar` from the [Releases](https://github.com/Dans-Plugins/FlyCommand/releases) page. +2. Place the JAR in your server's `plugins/` folder. +3. Restart the server. + +## Usage + +Type `/fly` to toggle your flight on or off. The plugin will confirm the new state in chat. + +## Permissions + +| Permission | Default | Description | +|------------|---------|-------------| +| `FlyCommand.fly` | `op` | Allows the player to toggle flight. | + +## Support + +Open a [GitHub issue](https://github.com/Dans-Plugins/FlyCommand/issues) to report bugs or request features.