Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -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.
17 changes: 17 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -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
15 changes: 15 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Release

on:
release:
types: [ created ]

permissions:
contents: write

jobs:
attach:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 5 additions & 0 deletions COMMANDS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# FlyCommand Commands

| Command | Permission | Description |
|---------|------------|-------------|
| `/fly` | `FlyCommand.fly` | Toggles flight mode on or off for the executing player. |
3 changes: 3 additions & 0 deletions CONFIG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# FlyCommand Configuration

FlyCommand has no `config.yml`. All behaviour is controlled via the `plugin.yml` permissions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
25 changes: 25 additions & 0 deletions USER_GUIDE.md
Original file line number Diff line number Diff line change
@@ -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.
Loading