Skip to content
This repository has been archived by the owner on Oct 20, 2024. It is now read-only.

Latest commit

 

History

History
42 lines (32 loc) · 2.02 KB

README.md

File metadata and controls

42 lines (32 loc) · 2.02 KB
Raw

First Officer

⚠️ IMPORTANT: Please Read the License First ⚠️

Before using or contributing to this project, it is crucial that you read and understand the LICENSE agreement.

Introduction

First Officer is a Discord bot designed to enhance your Discord aviation experience by providing flight plan information directly within your server. This project is built using the Hikari framework and integrates with Flight Plan Database to fetch flight plans.

Table of Contents

  1. Introduction
  2. Features
  3. Installation
  4. Usage
  5. Dependencies
  6. Contributors
  7. License

Features

  • Flight Plan Retrieval: Users can request flight plans by specifying departure and arrival airports.
  • Data Visualization: The bot provides an interactive map plotting the flight path.
  • Easy Interaction: Utilizes slash commands for easy and intuitive interactions.

Installation

This project is not intended for self-hosting. To use First Officer in your Discord server, please invite the official bot using this (coming soon).

Usage

After adding First Officer to your Discord server, you can interact with it using the following commands:

  • /flightplan from_airport:<IATA_CODE> to_airport:<IATA_CODE> - Fetches a flight plan between the specified airports.

Dependencies

To contribute to this project or understand its workings, here are the key dependencies:

  • Hikari: A Discord API wrapper used for bot development.
  • Plotly: For generating interactive flight path maps.
  • Requests: To fetch data from external APIs.

For a complete list of dependencies, please refer to the requirements.txt file.

Contributors

This project is open to contributions. If you would like to contribute, please read our contribution guidelines.

License

This project is licensed under the NiceBots Discord Bot License Agreement Version 1.0. Please refer to the LICENSE file for the full agreement.