Argonauts

docs/argonauts/chat.md

@@ -0,0 +1,19 @@
+---
+displayed_sidebar: argonauts
+---
+
+# Chat Screen
+
+Argonauts features a chat screen for privately chatting with guild/party members. The screen displays all members along with how many are online.
+Chat messages can be up to 512 characters in length, and also feature custom embeds for certain links. These embeds are:
+- Images. Displays the image when hovered over the link. Supported image hosts are:
+  - Imgur (i.imgur.com)
+  - Tenor (media.tenor.com)
+  - Discord (media.discordapp.net | cdn.discordapp.com)
+- Videos. Displays the video thumbnail when hovered over the link. Supported video hosts are:
+  - YouTube (youtube.com | youtu.be)
+- Music. Displays the song and album art when hovered over the link. Supported Music hosts are:
+  - Spotify (open.spotify.com)
+
+Chats are not persistent between server restarts, so you will lose your chat history when the server restarts. For admins, it will still be logged in the console.
+For parties, it's `(Argonauts Chat) [PARTY] <message>` and for guilds, it's `(Argonauts Chat) [GUILD] <message>`.

docs/argonauts/guilds/cadmus.md

@@ -0,0 +1,14 @@
+---
+displayed_sidebar: argonauts
+---
+
+# Cadmus Integration
+
+By default, Cadmus uses the vanilla team system. With Argonauts installed, Cadmus will use Argonauts' guild system instead.
+This means that you and your guild members will be able to share the same claims. Your settings, such as name and color, will also
+be displayed on the claim map.
+
+An additional permission is also available in the guild members menu called `Temporary Guild Permissions`. This is
+an alliance system of sorts. When a guild member is granted this permission, and they lead a party, the members in that player's
+party will bypass claim protections within the guild's claims. The party leader is then able to set which types of claim protections 
+are bypassed in the party members menu.

docs/argonauts/guilds/commands/admin.md

@@ -0,0 +1,38 @@
+---
+displayed_sidebar: argonauts
+---
+
+# Admin Commands
+
+Argonauts has a few admin commands for managing guilds.
+
+## Guilds Command
+```text
+/guilds
+```
+Displays all guilds, which includes the display name, guild UUID, owner, and member.
+
+## Disband Command
+
+```text
+/guild admin disband <guild>
+```
+
+Forcefully deletes a guild.
+- `guild`: The UUID of the guild to disband. Use `/guilds` to see a list of guilds mapped to their IDs.
+
+## Disband All Command
+
+```text
+/guild admin disbandall
+```
+
+Completely removes **all** guilds. Use with caution.
+
+## Join Command
+
+```text
+/guild admin join <guild>
+```
+Forcefully joins a guild, without needing to be invited.
+- `guild`: The UUID of the guild to join. Use `/guilds` to see a list of guilds mapped to their IDs.

docs/argonauts/guilds/commands/chat.md

@@ -0,0 +1,15 @@
+---
+displayed_sidebar: argonauts
+---
+
+# Chat Command
+
+```text
+/guild chat
+```
+
+Opens a chat screen for privately speaking with guild members. See [Chat Screen](/docs/argonauts/chat) for more information.
+
+:::note
+The chat screen requires Argonauts to be installed on the client.
+:::

docs/argonauts/guilds/commands/fake-players.md

@@ -0,0 +1,27 @@
+---
+displayed_sidebar: argonauts
+---
+
+# Fake Player Commands
+
+Fake players are entities in the game that simulate player actions without actual players controlling them.
+With Cadmus installed, adding a fake player to this list will bypass claim protections for that fake player.
+This allows them to perform their tasks without being blocked by claim protections.
+
+## Add
+
+```text
+/guild fakeplayers add <uuid>
+```
+
+Adds a fake player to the list of fake players. Requires the `Manage Members` permission.
+- `uuid`: The UUID of the fake player to add.
+
+## Remove
+
+```text
+/guild fakeplayers remove <uuid>
+```
+
+Removes a fake player from the list of fake players. Requires the `Manage Members` permission.
+- `uuid`: The UUID of the fake player to remove.

docs/argonauts/guilds/commands/hq.md

@@ -0,0 +1,14 @@
+---
+displayed_sidebar: argonauts
+---
+
+# Headquarters Command
+
+## Headquarters Command
+
+```text
+/guild headquarters
+/guild hq
+```
+
+Teleports you to your guild's headquarters. Guild headquarters can be set using the `/guild settings hq set` command.

docs/argonauts/guilds/commands/management.md

@@ -0,0 +1,47 @@
+---
+displayed_sidebar: argonauts
+---
+
+# Management Commands
+
+## Create Command
+
+```text
+/guilds create <name>
+```
+Creates a new guild
+- `name`: The display name of the guild. This parameter is **optional**. If not specified, the name of the guild will be "$YOUR_NAME's Guild".
+
+## Disband Command
+
+```text
+/guilds disband
+```
+
+Deletes the guild. Only the owner can disband the guild.
+
+## Transfer Command
+
+```text
+/guilds transfer <player>
+```
+
+Transfers ownership of the guild to another player. Only the owner can transfer the guild.
+- `player`: The player to transfer ownership to.
+
+## Join Command
+
+```text
+/guild join <player>
+```
+
+Joins a player's guild. You must be invited to join.
+- `player`: Any player that is in the party you want to join.
+
+## Leave Command
+
+```text
+/guild leave
+```
+
+Leaves the guild.

docs/argonauts/guilds/commands/members.md

@@ -0,0 +1,42 @@
+---
+displayed_sidebar: argonauts
+---
+
+# Member Commands
+
+## Members Command
+
+```text
+/guilds members
+```
+
+Opens a screen for managing guild members. This screen shows the following information:
+- Their member status (accepted, or invited).
+- Their role.
+- Their permissions. Guild permissions include:
+  - `Manage Members` allows the member to invite, remove, and edit fake players.
+  - `Manage Member Role` allows the member to change the role of other members.
+  - `Manage Member Permissions` allows the member to change the permissions of other members.
+  - `Manage Settings` allows the member to change the guild's settings.
+  - `Teleport Members` does not do anything at the moment as there is no `/tp` command in guilds.
+  - `Temporary Guild Permissions` only available when Cadmus is installed. Allow guild members with parties to bypass claim protections. See [Cadmus Integration](/docs/argonauts/guilds/cadmus) for more information.
+- An action button to remove the member from the guild.
+
+## Invite Command
+
+```text
+/guilds invite <player>
+```
+
+Invites a player to the guild. The person being invited can then either join by using the `/guilds join` command, or accepting the invite message. Requires the `Manage Members` permission.
+- `player`: The player to invite to the guild.
+
+## Remove Command
+
+```text
+/guilds remove <player>
+```
+
+Kicks a player from the guild. Requires the `Manage Members` permission.
+- `player`: The player to kick from the guild.
+

docs/argonauts/guilds/commands/settings.md

@@ -0,0 +1,26 @@
+---
+displayed_sidebar: argonauts
+---
+
+# Settings Commands
+
+## Settings Command
+
+```text
+/guild settings <setting> <value>
+```
+
+A game rule-esque command interface for managing guild settings. Unlike parties, guilds currently do not have a GUI for managing settings and must be done through commands.
+You can check the current value by running the command without specifying a value.
+The settings screen has the following options:
+- `allowFakePlayers`: Allows [fake players](/docs/argonauts/guilds/commands/fake-players) to join the guild.
+- `color`: Sets the color of the guild. If Cadmus is installed, any chunks claimed by the guild will be this color. 
+Entering the guild's chunks will also display the guild's name in this color.
+- `displayName`: Sets the display name of the guild.
+- `hq`: Sets the guild's headquarters to your current location. Running the `/guild headquarters` or `/guild hq` command will teleport you to this location.
+- `motd`: Sets the guild's message of the day. This message will be displayed every time a guild member joins the server.
+As command messages cannot contain section symbols (`§`), typing two ampersands (`&&`) will convert to a section symbol, allowing you to have custom [chat formatting](https://minecraft.tools/en/json_text.php), such as color.
+Additionally on the Fabric mod loader, Argonauts supports [Placeholder API](https://modrinth.com/mod/placeholder-api), allowing you to use placeholders within the message.
+
+In order to change a setting, you must have the `Manage Settings` permission.
+

docs/argonauts/guilds/guilds.md

@@ -0,0 +1,10 @@
+---
+displayed_sidebar: argonauts
+---
+
+# Guilds
+
+Guilds are a more permanent form of team. They are persistent across logins and feature role management, setting headquarters, 
+displaying messages of the day, and more. Guilds also integrate with Cadmus for chunk claiming as a team, and Heracles for completing quests together.
+
+Guilds are created by using the `/guild create` command.

docs/argonauts/guilds/heracles.md

@@ -0,0 +1,8 @@
+---
+displayed_sidebar: argonauts
+---
+
+# Heracles Integration
+
+With Argonauts installed alongside Heracles, you will be able to work towards quests as a group.
+In order to do this, you will need to be in a guild. Then any members in the guild will be able to contribute towards quests.

docs/argonauts/intro.md

@@ -0,0 +1,53 @@
+---
+sidebar_position: 1
+displayed_sidebar: argonauts
+---
+
+# Installing Argonauts
+
+Getting started with Project Odyssey's **Argonauts** mod. This mod and all of its optional
+and required dependencies are available for both Forge and Fabric.
+
+:::tip Quilt support
+While Quilt is not explicitly supported, it has not been tested and may not be
+compatible. If you find an issue with Quilt, or the mod in general, please use the
+[Argonauts GitHub](https://github.com/terrarium-earth/Argonauts)
+:::
+
+## Downloading
+
+Get started by installing Argonauts. Argonauts is required on the server and optional on the client.
+
+- [Modrinth](https://modrinth.com/mod/argonauts)
+- [CurseForge](https://www.curseforge.com/minecraft/mc-mods/argonauts)
+
+## Dependencies
+
+Argonauts requires the following mods to be installed:
+
+> ## Forge
+> - Resourceful Lib
+>   - [Modrinth](https://modrinth.com/mod/resourceful-lib)
+>   - [CurseForge](https://www.curseforge.com/minecraft/mc-mods/resourceful-lib)
+
+> ## Fabric
+> - Resourceful Lib
+>   - [Modrinth](https://modrinth.com/mod/resourceful-lib)
+>   - [CurseForge](https://www.curseforge.com/minecraft/mc-mods/resourceful-lib)
+> - Fabric API
+>   - [Modrinth](https://modrinth.com/mod/fabric-api)
+>   - [CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api)
+
+## Optional Dependencies
+
+Argonauts has the following optional dependencies:
+
+> ### Cadmus
+> - [Modrinth](https://modrinth.com/mod/cadmus)
+> - [CurseForge](https://www.curseforge.com/minecraft/mc-mods/cadmus)
+> ### Heracles
+> - [Modrinth](https://modrinth.com/mod/heracles)
+> - [CurseForge](https://www.curseforge.com/minecraft/mc-mods/heracles)
+> ### Roughly Enough Items
+> - [Modrinth](https://modrinth.com/mod/rei)
+> - [CurseForge](https://www.curseforge.com/minecraft/mc-mods/roughly-enough-items)

docs/argonauts/parties/commands/chat.md

@@ -0,0 +1,15 @@
+---
+displayed_sidebar: argonauts
+---
+
+# Chat Command
+
+```text
+/party chat
+```
+
+Opens a chat screen for privately speaking with party members. See [Chat Screen](/docs/argonauts/chat) for more information.
+
+:::note
+The chat screen requires Argonauts to be installed on the client.
+:::

docs/argonauts/parties/commands/ignore.md

@@ -0,0 +1,23 @@
+---
+displayed_sidebar: argonauts
+---
+
+# Ignore Commands
+
+## Ignore Command
+
+```text
+/party ignore <player>
+```
+
+Adds the player to the party's ignore list. Players in the ignore list will not be able to join the party. Requires the `Manage Members` permission.
+- `player`: The player to add to the ignore list.
+
+## Unignore Command
+
+```text
+/party unignore <player>
+```
+
+Removes the player from the party's ignore list. Requires the `Manage Members` permission.
+- `player`: The player to remove from the ignore list.