diff --git a/docs/dev-corner/development-projects/.pages b/docs/dev-corner/development-projects/.pages index a8e4a92be..7307c1459 100644 --- a/docs/dev-corner/development-projects/.pages +++ b/docs/dev-corner/development-projects/.pages @@ -3,6 +3,5 @@ nav: - Overview: index.md - Documentation Project: documentation-project - Website Project: website.md - - Discord Bot: discord-bot.md + - Discord Bot Project: discord-bot.md - Advanced Cockpit Emulator: ace.md - - ... diff --git a/docs/dev-corner/development-projects/discord-bot-sticky.md b/docs/dev-corner/development-projects/discord-bot-sticky.md new file mode 100644 index 000000000..eea9810ce --- /dev/null +++ b/docs/dev-corner/development-projects/discord-bot-sticky.md @@ -0,0 +1,54 @@ +# Sticky Discord Bot + +This page contains information about the Sticky Discord Bot implementation for the FlyByWire Simulations Discord server. + +## GitHub Repositories and Contacts + +For information on how to contribute to bot development, visit the Discord bot repository or contact the following users on Discord for assistance: + +!!! note "" + + - benw8484 + - oim + - straks + +
+ +- **Current Discord Bot** + + --- + + Our current iteration of the Discord Bot (Version 2). + + -> :fontawesome-brands-github:{: .github } [Repository](https://github.com/flybywiresim/discord-bot) + + -> [Return to Version 2](discord-bot.md) + + - **Version 3 Discord Bot** + + --- + + Latest iteration with new features and command structure (Version 3). + + -> :fontawesome-brands-github:{: .github } [Repository](https://github.com/flybywiresim/discord-bot-utils) + + -> [Return to Version 3](discord-bot-utils.md) + +- **Sticky Discord Bot** + + --- + + Our own implementation of a "Sticky" bot for Discord. + + -> :fontawesome-brands-github:{: .github } [Repository](https://github.com/flybywiresim/discord-bot-sticky) + +
+ +## Bot Commands + +Command documentation table coming soon. + +## Changelog + +Changelog coming soon. + diff --git a/docs/dev-corner/development-projects/discord-bot-utils.md b/docs/dev-corner/development-projects/discord-bot-utils.md new file mode 100644 index 000000000..7f67832b4 --- /dev/null +++ b/docs/dev-corner/development-projects/discord-bot-utils.md @@ -0,0 +1,58 @@ +# Discord Bot Version 3 + +This page details the available bot commands and changelog for the FlyByWire Simulations Discord server custom bot **(Version 3)**. + +!!! info "Version 3 Notice" + This version (3) will be released concurrently with the current state of our Discord Bot. It will have a new set of commands and features moving forward. + +## GitHub Repositories and Contacts + +For information on how to contribute to bot development, visit the Discord bot repository or contact the following users on Discord for assistance: + +!!! note "" + + - benw8484 + - oim + - straks + +
+ +- **Current Discord Bot** + + --- + + Our current iteration of the Discord Bot (Version 2). + + -> :fontawesome-brands-github:{: .github } [Repository](https://github.com/flybywiresim/discord-bot) + + -> [Return to Version 2](discord-bot.md) + +- **Version 3 Discord Bot** + + --- + + Latest iteration with new features and command structure (Version 3). + + -> :fontawesome-brands-github:{: .github } [Repository](https://github.com/flybywiresim/discord-bot-utils) + +- **Sticky Discord Bot** + + --- + + Our own implementation of a "Sticky" bot for Discord. + + -> :fontawesome-brands-github:{: .github } [Repository](https://github.com/flybywiresim/discord-bot-sticky) + + -> [Visit Commands and Changelog Page](discord-bot-sticky.md) + +
+ +## Bot Commands + +The following commands utilize the ++slash++ prefix. + +{{ external_markdown('https://assets.discord.flybywirecdn.com/utils/commands_table.md', '') }} + +## Changelog + +{{ external_markdown('https://raw.githubusercontent.com/flybywiresim/discord-bot-utils/staging/.github/CHANGELOG.md', '') }} diff --git a/docs/dev-corner/development-projects/discord-bot.md b/docs/dev-corner/development-projects/discord-bot.md index f176e2a0f..78b134997 100644 --- a/docs/dev-corner/development-projects/discord-bot.md +++ b/docs/dev-corner/development-projects/discord-bot.md @@ -1,18 +1,77 @@ -# Discord Bot +# Discord Bot Overview -This page details the available bot commands on the FlyByWire Simulations Discord server custom bot. +This page details the available bot commands for the FlyByWire Simulations Discord server custom bot **(Version 2)**. + +!!! warning "Discord Bot Version 3" + We are releasing a new version of the Discord bot. This version (3) will be released concurrently with the current state of our Discord Bot. The new version will have a new set of commands and features moving forward. + + The documentation below is for the current version of the bot. + +## GitHub Repositories and Contacts For information on how to contribute to bot development, visit the Discord bot repository or contact the following users on Discord for assistance: -- benw8484 -- oim -- straks +!!! note "" + - benw8484 + - oim + - straks + +
+ +- **Current Discord Bot** + + --- + + Our current iteration of the Discord Bot (Version 2). + + -> :fontawesome-brands-github:{: .github } [Repository](https://github.com/flybywiresim/discord-bot) + + -> [Jump to Commands](#bot-commands) + +- **Version 3 Discord Bot** + + --- + + Latest iteration with new features and command structure (Version 3). + + -> :fontawesome-brands-github:{: .github } [Repository](https://github.com/flybywiresim/discord-bot-utils) + + -> [Visit Commands and Changelog Page](discord-bot-utils.md) -[:fontawesome-brands-github:{: .github } **Discord Bot**](https://github.com/flybywiresim/discord-bot){ .md-button target=new} + - **Sticky Discord Bot** + + --- + + Our own implementation of a "Sticky" bot for Discord. + + -> :fontawesome-brands-github:{: .github } [Repository](https://github.com/flybywiresim/discord-bot-sticky) + + -> [Visit Commands and Changelog Page](discord-bot-sticky.md) + +
## Bot Commands -{{ external_markdown('https://raw.githubusercontent.com/flybywiresim/discord-bot/master/.github/command-docs.md', '') }} +!!! note "" + We have moved most functionality to Version 3 of our new Discord Bot. + +The following commands still utilize the ++period++ prefix. + +### General + +{{ external_markdown('https://raw.githubusercontent.com/flybywiresim/discord-bot/master/.github/command-docs.md', '### General') }} + +### Aircraft + +{{ external_markdown('https://raw.githubusercontent.com/flybywiresim/discord-bot/master/.github/command-docs.md', '### Aircraft') }} + +### Support + +{{ external_markdown('https://raw.githubusercontent.com/flybywiresim/discord-bot/master/.github/command-docs.md', '### Support') }} + +### Memes + +{{ external_markdown('https://raw.githubusercontent.com/flybywiresim/discord-bot/master/.github/command-docs.md', '### Memes') }} ## Changelog