From 0e290d2b298fe1a15657e78a08c9df46cecb1057 Mon Sep 17 00:00:00 2001 From: Victor Raphael de Moraes Date: Fri, 4 Sep 2026 09:49:36 -0300 Subject: [PATCH] docs: restructure by task, and document what was missing MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The tree split "Discord Bot" from the feature sections, organising by surface. The product is not split that way — /configure server carries a "Manage on Website" button, and almost every task exists in both places — so a reader had to know which surface a capability lived on before they could find it. Configuration was documented twice; Guild League was one paragraph inside Signups and nothing else. Regrouped by job: Start Here, Events, Scores and VOD, Guild Tracker, Public Data, Configuration, Community, Reference. Each page covers a task and shows both paths to it. Sixteen pages added for areas that had no documentation at all: VOD Reviews, Guild League's web side, event types and signup profiles, platoons and function roles, waitlist and priority, the Platoon Builder, the website settings, the five public data pages, a glossary, an end-to-end first node war walkthrough, and a 404. Five pages retired, each after its replacement existed and its content was verified as migrated: bot/commands, bot/configuration, features/parties-and-waitlist, features/tierlists-and-stats and website/overview. Every command was checked against Discord's own command picker on a live Guild server rather than against the bot's built-in help, which omits five commands that exist and lists two that do not. Co-Authored-By: Claude Opus 5 --- docs/.vitepress/config.ts | 52 ++++++--- docs/404.md | 12 +++ docs/bot/commands.md | 107 ------------------- docs/bot/configuration.md | 115 -------------------- docs/bot/members-and-roster.md | 48 ++++++--- docs/bot/schedulers.md | 4 + docs/configuration/server-settings.md | 127 ++++++++++++++++++++++ docs/events/event-types.md | 53 ++++++++++ docs/events/guild-league.md | 73 +++++++++++++ docs/events/platoon-builder.md | 86 +++++++++++++++ docs/events/platoons.md | 113 ++++++++++++++++++++ docs/events/waitlist-and-priority.md | 125 ++++++++++++++++++++++ docs/features/attendance.md | 36 ++++++- docs/features/community-tools.md | 4 + docs/features/guild-tracker.md | 39 ++++++- docs/features/parties-and-waitlist.md | 141 ------------------------- docs/features/scores.md | 52 ++++++++- docs/features/signups.md | 35 +++--- docs/features/tierlists-and-stats.md | 83 --------------- docs/features/trial-servers.md | 4 + docs/features/yap.md | 18 +++- docs/getting-started/first-node-war.md | 26 +++++ docs/getting-started/how-it-works.md | 82 ++++++++++++++ docs/getting-started/server-types.md | 10 +- docs/getting-started/setup.md | 17 ++- docs/index.md | 17 +-- docs/premium.md | 43 ++++++-- docs/public/arena-of-solare.md | 40 +++++++ docs/public/class-statistics.md | 57 ++++++++++ docs/public/guild-wars.md | 45 ++++++++ docs/public/screenshots/README.md | 4 + docs/public/streams-and-tools.md | 49 +++++++++ docs/public/tierlists.md | 93 ++++++++++++++++ docs/reference/commands.md | 100 ++++++++++-------- docs/reference/glossary.md | 37 +++++++ docs/scores/vod-reviews.md | 65 ++++++++++++ docs/website/overview.md | 76 ------------- 37 files changed, 1453 insertions(+), 635 deletions(-) create mode 100644 docs/404.md delete mode 100644 docs/bot/commands.md delete mode 100644 docs/bot/configuration.md create mode 100644 docs/configuration/server-settings.md create mode 100644 docs/events/event-types.md create mode 100644 docs/events/guild-league.md create mode 100644 docs/events/platoon-builder.md create mode 100644 docs/events/platoons.md create mode 100644 docs/events/waitlist-and-priority.md delete mode 100644 docs/features/parties-and-waitlist.md delete mode 100644 docs/features/tierlists-and-stats.md create mode 100644 docs/getting-started/first-node-war.md create mode 100644 docs/getting-started/how-it-works.md create mode 100644 docs/public/arena-of-solare.md create mode 100644 docs/public/class-statistics.md create mode 100644 docs/public/guild-wars.md create mode 100644 docs/public/streams-and-tools.md create mode 100644 docs/public/tierlists.md create mode 100644 docs/reference/glossary.md create mode 100644 docs/scores/vod-reviews.md delete mode 100644 docs/website/overview.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index b6fb42f..0624fd3 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -11,38 +11,56 @@ const enSidebar = [ text: "Start Here", items: [ { text: "Introduction", link: "/" }, + { text: "How GuildYapper Works", link: "/getting-started/how-it-works" }, { text: "Setup", link: "/getting-started/setup" }, { text: "Server Types", link: "/getting-started/server-types" }, - { text: "Website Overview", link: "/website/overview" }, + { text: "Running Your First Node War", link: "/getting-started/first-node-war" }, ], }, { - text: "Discord Bot", + text: "Events", items: [ - { text: "Command Overview", link: "/bot/commands" }, - { text: "Members and Roster", link: "/bot/members-and-roster" }, - { text: "Configuration", link: "/bot/configuration" }, - { text: "Schedulers", link: "/bot/schedulers" }, + { text: "Event Types and Signup Profiles", link: "/events/event-types" }, + { text: "Signups", link: "/features/signups" }, + { text: "Guild League", link: "/events/guild-league" }, + { text: "Attendance", link: "/features/attendance" }, + { text: "Platoons and Function Roles", link: "/events/platoons" }, + { text: "Waitlist and Priority", link: "/events/waitlist-and-priority" }, + { text: "Platoon Builder", link: "/events/platoon-builder" }, ], }, { - text: "Event Management", + text: "Scores and VOD", items: [ - { text: "Signups", link: "/features/signups" }, - { text: "Attendance", link: "/features/attendance" }, - { text: "Parties and Waitlist", link: "/features/parties-and-waitlist" }, { text: "Scores", link: "/features/scores" }, + { text: "VOD Reviews", link: "/scores/vod-reviews" }, ], }, { - text: "Tracking and Public Tools", + text: "Guild Tracker", items: [ { text: "Guild Tracker", link: "/features/guild-tracker" }, - { text: "Tierlists and Stats", link: "/features/tierlists-and-stats" }, ], }, { - text: "Community Tools", + text: "Public Data", + items: [ + { text: "Tierlists", link: "/public/tierlists" }, + { text: "Guild Wars", link: "/public/guild-wars" }, + { text: "Arena of Solare", link: "/public/arena-of-solare" }, + { text: "Class Statistics", link: "/public/class-statistics" }, + { text: "Streams and Tools", link: "/public/streams-and-tools" }, + ], + }, + { + text: "Configuration", + items: [ + { text: "Server Settings", link: "/configuration/server-settings" }, + { text: "Schedulers", link: "/bot/schedulers" }, + ], + }, + { + text: "Community", items: [ { text: "Yap", link: "/features/yap" }, { text: "Recruiting, Mercs, Verify", link: "/features/community-tools" }, @@ -50,10 +68,12 @@ const enSidebar = [ ], }, { - text: "Premium and Reference", + text: "Reference", items: [ - { text: "Premium", link: "/premium" }, { text: "Slash Commands", link: "/reference/commands" }, + { text: "Glossary", link: "/reference/glossary" }, + { text: "Premium", link: "/premium" }, + { text: "Members and Roster", link: "/bot/members-and-roster" }, ], }, ]; @@ -166,7 +186,7 @@ export default defineConfig({ ], footer: { message: - 'Discord · GitHub · Privacy Policy · Terms of Service · Support · Donate', + 'Discord · GitHub · Privacy Policy · Terms of Service · Support · Donate', copyright: "© GuildYapper. Documentation licensed under CC BY 4.0.", }, }, diff --git a/docs/404.md b/docs/404.md new file mode 100644 index 0000000..95a79bc --- /dev/null +++ b/docs/404.md @@ -0,0 +1,12 @@ +--- +title: Page Not Found +description: The page you're looking for does not exist. Find your way back to Setup, the Introduction, or the Slash Commands reference. +--- + +# 404 + +That page does not exist. + +- [Introduction](/) +- [Setup](/getting-started/setup) +- [Slash Commands](/reference/commands) diff --git a/docs/bot/commands.md b/docs/bot/commands.md deleted file mode 100644 index 7d8c6f4..0000000 --- a/docs/bot/commands.md +++ /dev/null @@ -1,107 +0,0 @@ -# Discord Command Overview - -GuildYapper commands are slash commands. Discord only shows commands that fit your server type. - -```text -/help -``` - -::: info Start With Help -`/help` shows a command overview inside Discord and is the quickest way to confirm what is available in your server. -::: - -## Everyday Member Commands - -These are the commands most members interact with. - -```text -/member update -/member view member:@Member -/attendance me -/yap -/addyap content:Your message -/scores menu -/premium -``` - -| Command | What it does | -| --- | --- | -| `/member update` | Opens the member update flow for your own GuildYapper profile. | -| `/member view` | Shows a member's gear/profile overview. | -| `/attendance me` | Shows your own attendance summary. | -| `/yap` | Posts a random saved yap when Yap is enabled. | -| `/addyap` | Adds a new yap message if it passes mention checks. | -| `/scores menu` | Opens the score menu in Discord. | -| `/premium` | Shows Premium status, trial, store, and subscription options. | - -## Officer Commands - -Officers/admins use these to configure and operate the server. - -```text -/configure server -/configure nwparty -/configure class -/configure member member:@Member -/configure scheduler -/signup nodewar -/signup gvg -/signup gleague -/signup custom -/signup list -/attendance overview -/attendance member member:@Member -/attendance export -/member list sorting:gearscore -/member missing -/scores upload file:score.png -``` - -::: warning Permissions -Officer actions require the configured officer/admin role. If the wrong people can use or cannot use commands, check `/configure server`. -::: - -## Tracker Commands - -Guild Tracker commands are available in supported regions. - -```text -/guild add guildname:Example guildtype:PVP region:EU -/guild list region:EU type:PVP -/guild history guild:Example region:EU -/guild members guild:Example region:EU -/guild consistency guild:Example region:EU -/player history player:FamilyName region:EU -/player profile player:FamilyName region:EU -``` - -::: warning Region Limit -Guild Tracker commands are not supported for RU, MENA, SEA, KR, or JP server regions. -::: - -## Community Commands - -Community servers can use public coordination tools. - -```text -/recruiting register guildname:Example dc-server-link:https://discord.gg/example gs-requirement:700 -/recruiting update -/recruiting remove -/merc lf-signup -/verify post -/tierlist updates announce:false -``` - -## Trial Server Commands - -Trial Servers get trial-specific commands. - -```text -/trial signup -/trial configure -/trial end result:passed reason:Good fit trialee:FamilyName -``` - -## Full Command Reference - -For a complete list grouped by area, see [Slash Commands](/reference/commands). diff --git a/docs/bot/configuration.md b/docs/bot/configuration.md deleted file mode 100644 index 428afe6..0000000 --- a/docs/bot/configuration.md +++ /dev/null @@ -1,115 +0,0 @@ -# Configuration - -Most server settings live under `/configure`. Use it after `/setup` to fine-tune GuildYapper for your guild. - -```text -/configure server -/configure nwparty -/configure class -/configure member member:@Member -/configure scheduler -/configure guildfilter file:guilds.txt -``` - -## What It Does - -Configuration controls server identity, permissions, Guild Tracker behavior, Yap settings, guild names, event channels, waitlist behavior, party logic, class priority, member overrides, and schedulers. - -## Who Can Use It - -Configuration is for officers/admins with the configured officer/admin role. - -::: warning Changes Affect Live Workflows -Changing roles, channels, waitlist mode, guild names, or party settings can affect future signups and roster views. Make small changes and check the next signup before changing more. -::: - -## Server Configuration - -```text -/configure server -``` - -The server configuration screen has several tabs. - -| Tab | What it controls | -| --- | --- | -| General | Server type, region, member role, officer/admin role, log channel, Yap, Yap cooldown, custom bot profile. | -| Guild Tracker | Tracker update type, update channel, custom guild filter. | -| Guild | Guild names, vacation channel, profile update channel, rename mode. | -| Nodewar | Node War voice channel, signup sort mode, waitlist mode, visible signup values, waitlist fair mode, move notifications, party swapping. | - -
- Screenshot placeholder - Add a screenshot of `/configure server`. - Suggested path: `/screenshots/configuration/server-config.webp` -
- -## Yap Settings - -Server config can enable or disable Yap, block all mentions in new yaps, and set a custom cooldown. The default cooldown is 3 minutes unless changed. - -## Guild Tracker Settings - -The tracker tab lets you decide what GuildYapper posts: - -- All tracked guild updates. -- PvP-focused updates. -- Disabled tracker posting. - -You can also use a custom guild filter so only selected tracked guilds are posted. - -::: info Custom Guild Filter -`/configure guildfilter` uploads a text file. Keep it to up to 30 guild names and make sure the guilds already exist in the tracker list. -::: - -## Guild Names - -Guild names are used when members register and when GuildYapper groups member data for signups and roster views. A guild or alliance can add multiple guild names. - -## Node War Modes - -Node War settings include: - -| Setting | Meaning | -| --- | --- | -| Signup sort mode | How members are ordered in signup lists. | -| Waitlist mode | How waitlisted members move into open spots. | -| Waitlist tie-breaker | What decides between members with equal priority. | -| Displayed values | Which member values appear on signups; family name always stays visible. | -| Waitlist fair mode | Adds priority for members who were waitlisted on previous Node Wars. | -| Waitlist move notifications | Can announce or DM members when they are moved from waitlist to attending. | -| Party swap | Lets members swap parties when enabled. | - -## Class Priority - -```text -/configure class -``` - -Class configuration lets officers define class/spec priorities and class type limits. These priorities can affect signup ordering, waitlist decisions, and party composition. - -::: tip Class Priority Is A Planning Tool -Use it to express what your comp needs, not as a permanent judgment of members. Keep priorities understandable for officers. -::: - -## Member Overrides - -```text -/configure member member:@Member -``` - -Member configuration is for individual overrides, such as custom priority, party assignment, or display details used in signups. - -## Common Issues - -### Commands disappeared - -Check server type in `/configure server`. Discord command sync depends on the current server type. - -### Guild Tracker is disabled - -Check your region and tracker tab. Guild Tracker is only supported for EU, NA, and SA. - -### Yap messages mention everyone - -Enable mention blocking in `/configure server`. Role mentions are blocked by default, and the stronger option blocks all mentions in newly added yaps. diff --git a/docs/bot/members-and-roster.md b/docs/bot/members-and-roster.md index fb5528f..5881cc1 100644 --- a/docs/bot/members-and-roster.md +++ b/docs/bot/members-and-roster.md @@ -1,6 +1,10 @@ +--- +description: How GuildYapper tracks member profiles, gear, class/spec, and roster data across Discord and the website. +--- + # Members And Roster -Member tools keep your GuildYapper roster usable: who is registered, which class/spec they play, their guild, gear, party assignment, attendance history, priority, and score snapshots. +Member tools keep your GuildYapper roster usable: who is registered, which class/spec they play, their guild, gear, platoon (in-game party) assignment, attendance history, priority, and score snapshots.
Profile @@ -11,9 +15,9 @@ Member tools keep your GuildYapper roster usable: who is registered, which class - Lets members update their own profile. - Lets officers view, sort, and filter the roster. -- Shows member details such as gearscore, class/spec, guild, party, attendance, and scores. +- Shows member details such as GS, AP, AAP, and DP, class/spec, guild, platoon, attendance, and scores. - Helps officers find members who have not registered yet. -- Supports officer configuration for individual member settings such as priority, party, and signup display labels. +- Supports officer configuration for individual member settings such as priority, platoon, and signup display labels. ## Who Can Use It @@ -31,9 +35,11 @@ Members can update and view their own information. Officers can manage member da /configure member member:@Member ``` +`/configure member` also sets a member's platoon (in-game party) with `party`, forces a specific slot with `partyindex`, marks them a platoon lead with `leader`, and sets individual priority with `priority`. See [Assigning Members](/events/platoons#assigning-members) for the full parameter table. + ## Member Profile Updates -Members should keep their profile current through either Discord or the website. +A profile starts with `/member update` in Discord — the website doesn't create one from scratch, only edits an existing one. Members should keep it current through either Discord or the website afterwards. ```text /member update @@ -45,9 +51,12 @@ Typical profile data includes: | --- | --- | | Family name | Used in signups, roster, attendance, scores, and lookup. | | Class/spec | Used for signup display, class distribution, class priority, and stats. | -| Gearscore | Used for sorting and roster context. | +| Gear (GS, AP, AAP, DP) | Shown on the roster as four separate values, used for sorting and roster context. | | Guild | Used in roster filters, signups, and alliance views. | | Garmoth link | Gives officers and the member a quick route to detailed gear. | +| Weekly availability | Registered per member; see [Availability](/features/attendance#availability) for how it's used. | + +A profile is stored per region: family name, gear, and class apply to whichever region is currently selected. See [Regions](/getting-started/how-it-works#regions) for how the bot, website, and profile region scopes interact. ::: tip Website Profile The [Profile page](https://guildyapper.com/profile) is usually easier for full profile cleanup because it has more room than a Discord modal. @@ -75,6 +84,18 @@ You can filter by guild if your server has multiple guild names configured. /member list sorting:gearscore guild-filter:ExampleGuild ``` +Use `/member view member:@Member` ("View user's gear") to look up one member's gear and profile info directly. + +## Class Distribution + +```text +/stats classes +``` + +`/stats classes` shows your own server's class distribution — how your registered members break down by class. This is separate from the public, site-wide [Class Statistics](/public/class-statistics), which aggregates popularity and performance across GuildYapper rather than one server's roster. + +Useful for officers checking comp gaps or class stacking before adjusting class priority in `/configure class`. + ## Finding Missing Registrations Use `/member missing` when you want to see who has the Discord role but has not registered with GuildYapper yet. @@ -92,15 +113,18 @@ Many list and overview commands include a `private` option. Use it when the outp The [Roster page](https://guildyapper.com/management/roster) is the main place for officer roster work. -Officers can review: +Officers can review, per member: -- Member details. -- Attendance summaries. -- Party assignment. -- Class/spec. +- **GS, AP, AAP, and DP** as four separate gear values, not one gearscore number. +- A shortcut to the member's Garmoth link. +- Platoon assignment and class/spec. - Personal priority and priority sources. -- Score snapshots. -- Recent attendance history. +- Attendance percentage and recent attendance history. +- Attendance bars by state. +- A score snapshot that identifies its source (Ikusa or BDO OCR). +- Recent signups. + +This is the same member details panel used by the [Platoon Builder](/events/platoon-builder#member-details).
Screenshot placeholder diff --git a/docs/bot/schedulers.md b/docs/bot/schedulers.md index 7b924fb..8e80412 100644 --- a/docs/bot/schedulers.md +++ b/docs/bot/schedulers.md @@ -1,3 +1,7 @@ +--- +description: How to automate recurring events and reminders with GuildYapper's schedulers. +--- + # Schedulers Schedulers automate repeated event and reminder work. Configure them from Discord with: diff --git a/docs/configuration/server-settings.md b/docs/configuration/server-settings.md new file mode 100644 index 0000000..b3168b6 --- /dev/null +++ b/docs/configuration/server-settings.md @@ -0,0 +1,127 @@ +--- +description: Every server setting, in Discord and on the website, and which tab holds what. +--- + +# Server Settings + +The same server settings exist in two places. In Discord, they live in `/configure server`. On the website, they live on the **Settings** page. The bot itself links to the web version with a **Manage on Website** button, so officers can jump between the two without hunting for the URL. + +```text +/configure server +/configure scheduler +``` + +## Discord Tabs Vs Website Tabs + +The tabs do not line up one-to-one. The website splits Yap and Schedulers out into their own tabs, so Discord's five tabs become seven on the website. + +| Discord tab | Website tab | +| --- | --- | +| General | General, plus Yap as its own tab | +| Guild Tracker | Guild Tracker | +| Guild | Guild | +| Nodewar | Nodewar Signups | +| Waitlist | Waitlist and Automation | +| (inside `/configure scheduler`) | Schedulers | + +
+ Screenshot placeholder + Add a screenshot of the website Settings page. + Suggested path: `/screenshots/configuration/web-settings.webp` +
+ +## Who Can Use It + +Officers/admins with the configured admin role. + +## General + +The General tab covers server identity: + +- Server type. +- Region. +- Officer/admin role. +- Member role. +- Log channel. +- Custom bot profile (Premium): a custom avatar and banner, uploaded from Discord. + +The log channel also receives changes made from the website, not just from Discord. + +## Guild + +The Guild tab covers: + +- Up to **five** guild names for an alliance — the main guild plus four more. +- Vacation channel. +- Profile update channel, which receives gearscore change posts and a monthly summary. +- The member rename pattern: + +```text +{GUILD} {FAMILY} {CHARCLASS} {GS} {PARTY} +``` + +`{PARTY}` is the member's platoon (in-game party). + +::: warning Saving A New Pattern Renames Everyone At Once +Setting the pattern to `DISABLED` turns off automatic renaming. Saving any other pattern renames every member immediately, not just new ones. +::: + +## Nodewar Signups + +The Nodewar Signups tab (Discord: Nodewar) covers: + +- Signup sort order. +- Which values show per member. Family name is always visible; if nothing else is selected, every value shows. +- Automatic sync of platoon names and roles. +- Whether priority is displayed on the signup. +- Auto-signup by availability (Premium). Without Premium, member availability is informational only and does not create signups automatically. +- Whether a platoon swap needs officer approval. + +
+ Screenshot placeholder + Add a screenshot of the Discord Waitlist tab. + Suggested path: `/screenshots/configuration/waitlist-tab.webp` +
+ +## Waitlist And Automation + +The Waitlist and Automation tab (Discord: Waitlist) sets waitlist mode, tie-breaker, and fair mode. That mechanic is covered in full on [Waitlist and Priority](/events/waitlist-and-priority) — this section only covers what's specific to this tab. + +**No-show penalty** (Premium): + +- Applies automatically when a member is marked No Show. +- Subtracts priority per occurrence, and occurrences accumulate. +- Duration is configurable from 1 to 60 days. +- DMs the affected member. + +**Attendance watch channel**: posts applied no-show penalties, and also warns about members who have sat at `Can't` or `Undecided` for 7, 14, and 21 days. + +## Guild Tracker + +The Guild Tracker tab covers: + +- Update type: all tracked guild updates, PvP-only updates, or posting disabled. +- Update channel. +- Custom guild filter, uploaded with `/configure guildfilter`. See [Guild Tracker](/features/guild-tracker) for filter limits. + +## Yap + +The Yap tab covers: + +- Enable or disable Yap. +- Block all mentions in new yaps (stronger than the default role-mention block). +- Custom cooldown. The default is 3 minutes; setting `0` reverts to the default. + +## Common Issues + +### Commands disappeared + +Check server type on the General tab. Discord command sync depends on the current server type. + +### Guild Tracker is disabled + +Check region and the Guild Tracker tab. Guild Tracker is only supported for EU, NA, and SA. + +### Yap messages mention everyone + +Enable mention blocking on the General or Yap tab. Role mentions are blocked by default; the stronger option blocks all mentions in newly added yaps. diff --git a/docs/events/event-types.md b/docs/events/event-types.md new file mode 100644 index 0000000..776b86a --- /dev/null +++ b/docs/events/event-types.md @@ -0,0 +1,53 @@ +--- +description: The signup profiles that decide which platoons and function roles each kind of event offers. +--- + +# Event Types And Signup Profiles + +A signup profile is a layout: it decides which platoons (in-game parties) and which function roles are available on an event. The default platoon is always available. One profile is the default for new Node War signups when no profile is chosen. + +## Who Can Use It + +Officers/admins configure signup profiles. Members simply see the resulting layout on their signups. + +## System Profiles + +GuildYapper ships with five system profiles. + +| Profile | Use it for | +| --- | --- | +| Nodewar (Occupation) | Occupation node wars. Default profile out of the box. | +| Nodewar (Construction) | Construction node wars. | +| Siege | Siege wars. | +| Blue Battlefield | Blue Battlefield events. | +| War of the Roses | War of the Roses events. | + +## Custom Profiles + +You can create custom profiles beyond the five system profiles. On the free plan, a server has five profiles and five function roles. Premium unlocks custom profiles and unlimited function roles. + +## Configuring Profiles + +Configure profiles in Discord: + +```text +/configure profiles +``` + +Or on the website, open the **Signup Profiles** page and use the **Profiles** tab. + +Each profile has a name, a description, available platoons, available function roles, an activation switch, and the option to set it as the default. + +::: info Activation Does Not Affect Existing Signups +Activating or deactivating a profile only changes what is offered for new signups. It does not affect signups that already exist. +::: + +
+ Screenshot placeholder + Add a screenshot of the Signup Profiles page, Profiles tab. + Suggested path: `/screenshots/parties/signup-profiles.webp` +
+ +## Where To Go Next + +See [Platoons and Function Roles](/events/platoons) for how platoons and function roles are configured, and [Creating and Managing Signups](/features/signups) for how signups use a profile. diff --git a/docs/events/guild-league.md b/docs/events/guild-league.md new file mode 100644 index 0000000..c0cda43 --- /dev/null +++ b/docs/events/guild-league.md @@ -0,0 +1,73 @@ +--- +description: Guild League signups with automatic time slots, officer actions, and the public match browser and standings. +--- + +# Guild League + +Guild League runs on its own signup command, generating time slots for the matches the game will actually run, instead of one fixed slot for the whole window. + +
+ Match Browser + Standings +
+ +## Who Can Use It + +Officers create the signup. Any member with the required role takes a timeslot. The public match browser and standings need no account. + +## Create A Signup + +```text +/signup gleague date:19.05.2026 start-time:20:00 end-time:22:00 role:@Guild +``` + +| Option | Required | Meaning | +| --- | --- | --- | +| `date` | Yes | Format `dd.MM.yyyy`. | +| `start-time` | Yes | When the queue starts. EU uses Europe/Berlin, NA uses America/New_York. | +| `end-time` | Yes | When the queue ends. Each end time tells you how many slots it buys. | +| `role` | No | Role to ping, and to restrict the signup to when that toggle is on. | +| `vc` | No | Voice channel checked by the "missing in voice" action. Leave it out to count any voice channel on the server. | +| `interval` | No | Minutes between time slots. Defaults to 20, the game's match cycle. | +| `nodewar-slots` | No | Set `True` to keep slots inside the node war window, which the game normally blocks. | + +::: info How Slot Timing Works +Guild League matches run every 20 minutes and cannot start during node war. The `start-time`/`end-time` autocomplete only offers times the game will actually match. Because the time fields accept any typed value, `interval` and `nodewar-slots` together let you build a signup that runs off the game's default cycle. +::: + +## Officer Actions + +Guild League signups add officer actions on top of the usual signup management menu: + +- Refresh message, useful when menus get stuck. +- Ping members missing from voice for the next match. +- Ping all participants of the next match. +- Ping members who have not responded yet. + +::: warning Restrict Signups To Mentioned Role Is Server-Wide +The **Restrict signups to mentioned role** toggle applies to every signup on the server, not just the Guild League signup you're creating or managing. +::: + +## Signing Up + +On the website, a member takes a timeslot by picking a role: **Tank**, **DPS**, or **Shai**. Each entry shows the member's gearscore. Upcoming, Past, and All tabs let members browse timeslots by status. + +## Match Browser + +The Match Browser is public and lists matches submitted through Ikusa. It includes match tabs, class statistics, and guild/player statistics, with filters for season, guild, and visibility. Each match has a per-player scoreboard covering kills, deaths, damage dealt, damage taken, healing, and CC. Every match accepts a VOD. + +
+ Screenshot placeholder + Add a screenshot of the Guild League match browser. + Suggested path: `/screenshots/signups/guild-league-browser.webp` +
+ +## Standings + +Standings show the in-game top 100, captured by players through Ikusa and kept as dated history. Each capture can be compared against the previous one, with highlights for the biggest climb, the biggest drop, and the most points gained. The table itself covers rank, movement, guild, guild master, W/L, win rate, and score change. + +::: warning Not An Official Feed +Standings depend on players submitting Ikusa captures. This is not an official feed from the game, just a history built from what players have uploaded. +::: + +See [Scores](/features/scores) for war score sessions, and [VOD Reviews](/scores/vod-reviews) for reviewing submitted match VODs. diff --git a/docs/events/platoon-builder.md b/docs/events/platoon-builder.md new file mode 100644 index 0000000..2b8f2a8 --- /dev/null +++ b/docs/events/platoon-builder.md @@ -0,0 +1,86 @@ +--- +description: The website tool for building one event's composition, with staged changes and Discord hand-off. +--- + +# Platoon Builder + +The Platoon Builder is a website tool for assembling the platoon (in-game party) composition of one specific event. Open it from the Signups page: a **Platoon Builder** button appears on the event card, in the signup list row, and inside the event's detail view. + +This page covers the builder itself. For how platoons are configured and how members get their default assignment, see [Platoons and Function Roles](/events/platoons). For how priority decides who gets a spot, see [Waitlist and Priority](/events/waitlist-and-priority). + +
+ Screenshot placeholder + Add a screenshot of the Platoon Builder. + Suggested path: `/screenshots/parties/platoon-builder.webp` +
+ +## Who Can Use It + +The Platoon Builder is for officers/admins only. It is a management tool. + +## Applies To + +Every move in the builder is made with an **Applies To** choice: + +| Option | Effect | +| --- | --- | +| This signup | Changes the member's platoon for this event only. | +| Default party | Changes the member's standing platoon assignment, used for future events too. | + +This is the temporary-versus-permanent distinction from [Platoons and Function Roles](/events/platoons), turned into a switch you set before making a move. + +## Instant And Planner + +**Changes** mode controls when a move actually takes effect: + +| Mode | Behavior | +| --- | --- | +| Instant | Each change writes immediately. | +| Planner | Changes accumulate as a pending count and only apply when you select **Save**. **Discard all** abandons them. | + +::: tip Use Planner For Big Remakes +Switch to Planner before reworking a large composition. It lets you try several moves, see the pending count grow, and back out cleanly with Discard all if the result isn't right — instead of every drag committing on the spot. +::: + +## The Participant Pool + +The pool lists everyone in the signup, with search and filters by class, platoon, status, and guild. + +**Promote top by priority** promotes members from the waitlist in bulk, taking the top of the list by effective priority. See [Waitlist and Priority](/events/waitlist-and-priority) for how that priority is calculated. + +## Reading The Composition + +The builder summarizes the current composition: + +- Count by class. +- Count by function role. +- Count of specialists: BSR, PA, and Shai. +- Attendance. +- Per platoon: how full it is and its average gearscore. + +## Member Details + +Selecting a member opens a side panel with: + +- **GS**, **AP**, **AAP**, and **DP** as four separate values. +- A shortcut to the member's Garmoth link. +- Platoon and priority. +- Attendance percentage. +- A score snapshot with its source identified. +- Attendance bars by state. +- Recent signups. +- Buttons to move the member to each platoon. + +## Sharing The Result + +| Action | Result | +| --- | --- | +| Preview screenshot | Generates an image of the composition. | +| Send to Discord | Posts that image to the server. | + +## Notifications + +Two switches control what happens when the composition changes: + +- Announce the change. +- DM participants (Premium). diff --git a/docs/events/platoons.md b/docs/events/platoons.md new file mode 100644 index 0000000..add5ba8 --- /dev/null +++ b/docs/events/platoons.md @@ -0,0 +1,113 @@ +--- +description: "Platoons and function roles: how a server defines its in-game parties and the signup labels that go on members." +--- + +# Platoons And Function Roles + +A **platoon** is an in-game party. The default platoon is always available and cannot be removed. The order of platoons in the list is the order they display on a signup. + +```text +/configure parties +``` + +## Who Can Use It + +Officers/admins configure platoons and function roles. Members see their assignment reflected on signups. + +## Platoon Settings + +| Setting | What it does | +| --- | --- | +| Name | Display name on signups and party views. | +| Discord role | Role used to identify or assign members of that platoon. | +| Priority | Adds priority to members in that platoon. | +| Limit % | Share of attending members past which the platoon's priority is reduced. | +| Reduce | How much priority is subtracted once the limit is reached. | +| Exclude class | Keeps a class out of the platoon. | +| Size | Maximum members before overflow behavior starts. | +| Overflow | `SPLIT`, `OVERFLOW` or `LIMIT`. | +| Target | Lets the platoon ask for volunteers when it is below target. | + +
+ Screenshot placeholder + Add a screenshot of `/configure parties`. + Suggested path: `/screenshots/parties/platoon-config.webp` +
+ +## Overflow Behavior + +| Overflow | Behavior | +| --- | --- | +| `SPLIT` | Splits a large platoon into equal sub-platoons such as Main 1 and Main 2. | +| `OVERFLOW` | Keeps the platoon capped and moves extra members to the default platoon. | +| `LIMIT` | Keeps the platoon capped and leaves excess members on the waitlist. | + +::: tip SPLIT Is Best For Large Flexible Groups +Use `SPLIT` when a platoon can become multiple balanced groups. Use `LIMIT` when a group is truly capped. +::: + +## How Split Platoons Work + +When a platoon uses `SPLIT`, GuildYapper tries to make clean sub-platoons: + +1. Members forced into a specific party index stay there when possible. +2. Sub-platoons are kept as equal in size as possible. +3. Special roles such as BSR, PA, and Shai are spread across sub-platoons where possible. +4. Gearscore balance is used as a secondary improvement. +5. When a signup is frozen or already has assignments, GuildYapper keeps existing assignments stable where it can. + +Example: if Main has a limit of 20 and 44 attending members, it can become Main 1, Main 2, and Main 3. + +::: warning Forced Party Index +If an officer forces a member into Main 2 for one event, GuildYapper treats that as intentional and avoids moving them away just to make the math prettier. +::: + +## Function Roles + +Function roles are **signup labels, not Discord roles**. Each one has an emoji, an optional priority, a limit, and class exclusion. Out of the box, GuildYapper ships Elephant Rider, Flag, Shotcaller, and BSR Target. Function roles are assigned globally as a member's default and can be overridden per profile. + +Function roles are also created and edited through `/configure parties`, on the Roles tab on the website. + +
+ Screenshot placeholder + Add a screenshot of the Roles tab. + Suggested path: `/screenshots/parties/function-roles.webp` +
+ +## Assigning Members + +A member's platoon and function role assignment can be global or overridden per profile. On the website, dragging a member into a platoon changes their global assignment. Cards marked with a dot indicate a profile override of the roster default. + +Configure member-level assignment in Discord: + +```text +/configure member member:@Member +``` + +| Parameter | What it does | +| --- | --- | +| `party` | Sets the member's platoon. | +| `partyindex` | Forces the member into a specific party slot. | +| `leader` | Marks the member as a platoon lead. | +| `priority` | Sets the member's individual priority. | + +To build the composition of one specific event instead of the server default, use the [Platoon Builder](/events/platoon-builder). + +## Temporary Vs Permanent Platoon Moves + +The website platoon builder and Discord management actions can handle two kinds of moves: + +| Move type | Use it when | +| --- | --- | +| Temporary event move | You only want this member moved for the current signup. | +| Server roster move | You want this member's default platoon assignment changed for future signups. | + +
+ Screenshot placeholder + Add a screenshot of the website platoon builder with pool and platoon board. + Suggested path: `/screenshots/parties/party-builder.webp` +
+ +## Where To Go Next + +See [Waitlist and Priority](/events/waitlist-and-priority) for how platoon priority combines with class, individual, and waitlist-streak priority. See the [Glossary](/reference/glossary) for other GuildYapper and Black Desert terms used across these docs. diff --git a/docs/events/waitlist-and-priority.md b/docs/events/waitlist-and-priority.md new file mode 100644 index 0000000..92e138c --- /dev/null +++ b/docs/events/waitlist-and-priority.md @@ -0,0 +1,125 @@ +--- +description: How effective priority is calculated and how waitlisted members move into open spots. +--- + +# Waitlist And Priority + +A **platoon** (in-game party) is one of several sources that add up to a member's effective priority. This page covers how that priority stack is built, how waitlist mode uses it, and how officers check why a specific member did or did not get a spot. + +```text +/priority view +/configure class +/configure server +``` + +## Who Can Use It + +Officers/admins configure waitlist behavior and priority. Members are affected by it and can check their own standing. + +## The Priority Stack + +In Custom Priority waitlist mode, GuildYapper sums four sources for each member: + +- Class priority, from `/configure class`. +- Platoon priority, from the member's platoon. +- Function role priority, from the member's function role. +- Personal priority, set per member. + +::: info Priority Adds Together +These four sources are added together to produce a member's effective priority. `/priority view` shows exactly that combined number for every registered member. +::: + +## Dynamic Class Types + +```text +/configure class +``` + +Class configuration lets officers assign a dynamic type to a class/spec: `DEFAULT`, `PA`, `BSR`, or `SHAI`. + +| Parameter | What it does | +| --- | --- | +| `char-class` | The class being configured. | +| `spec` | Succession, Awakening, or Both Specs. | +| `priority` | Priority value for that class/spec. | +| `type` | Dynamic class type: `DEFAULT`, `PA`, `BSR`, or `SHAI`. | + +Each type has a share limit of attending members. Once a type reaches its limit, its priority is temporarily reduced for the rest of that signup. A 10% limit lets in roughly 10 out of 100 members, and partial results round up. For a hard cutoff instead of a soft reduction, set the reduction to 99. + +Classes with a dynamic type also get a marker on the signup so officers can see them at a glance, and they are distributed across split platoons rather than clustering into a single sub-platoon. + +::: tip Class Priority Is A Planning Tool +Use it to express what your comp needs, not as a permanent judgment of members. Keep priorities understandable for officers. +::: + +## Waitlist Modes + +Waitlist mode is configured in: + +```text +/configure server +``` + +| Mode | Meaning | +| --- | --- | +| Default | Earlier signups move in first. | +| Custom Priority | Higher effective priority moves in first. | +| Gearscore | Higher gearscore moves in first. | +| Random | Move-ins are randomized. | +| Manual | GuildYapper does not automatically move waitlisted members. | + +When two members are otherwise tied, the waitlist tie-breaker decides between them: earlier signup time, or random. + +## Fair Mode + +Fair mode gives members extra priority when they were waitlisted on previous Node Wars. Officers can decide how much priority is added per waitlisted Node War, and there is a switch deciding whether `Can't` also counts as a waitlist appearance. + +::: info Fair Mode Goal +Fair mode helps members who repeatedly miss the final roster get a better chance later, while still letting officers keep class and platoon needs in the system. +::: + +## Move Notifications + +When a member moves from waitlist to attending, GuildYapper can announce it in the signup's channel and DM the member directly (Premium). The notification window sets how many minutes before the event this applies, with `0` meaning notify on every move regardless of timing. + +## Checking Priority + +```text +/priority view +``` + +`/priority view` is the tool for answering "why did this member get in and that one didn't." It has three buttons, and its footer prints the breakdown verbatim: + +```text +Individual + Party + Class + Function roles = Total Priority +``` + +| Button | Shows | +| --- | --- | +| Member list | Registered members and their effective priority. | +| Config overview | A compact view of all class priorities. | +| CSV export | The full priority configuration, exported as CSV. | + +
+ Screenshot placeholder + Add a screenshot of `/priority view`. + Suggested path: `/screenshots/parties/priority-view.webp` +
+ +## Backtracking Excess Attendees + +When caps or platoon limits change, officers can move excess attendees back to the waitlist. This is useful after lowering a cap or cleaning up a signup that had too many Can responses. + +## Common Issues + +### A platoon split looks uneven + +Check forced platoon indexes, platoon limits, and special role distribution. GuildYapper may keep some assignments stable even if a perfect split would require moving them. + +### A member did not move from waitlist + +Check waitlist mode, cap, signup status, priority, and whether manual mode is enabled. + +### A member keeps returning to the same platoon + +They may have a permanent server platoon assignment. Update it in the roster or `/configure member`. diff --git a/docs/features/attendance.md b/docs/features/attendance.md index 5282acb..93f5b4e 100644 --- a/docs/features/attendance.md +++ b/docs/features/attendance.md @@ -1,3 +1,7 @@ +--- +description: How GuildYapper records event attendance and gives officers participation history. +--- + # Attendance Attendance tracks how members respond to events and gives officers a way to review participation over time. @@ -37,6 +41,13 @@ Members can view their own attendance. Officers/admins can view member and serve /attendance export ``` +| Command | Use | +| --- | --- | +| `/attendance me` | View your own attendance. | +| `/attendance member` | View your members attendance. | +| `/attendance overview` | Get an overview of the servers Attendance. | +| `/attendance export` | Export Attendance to CSV. | + Useful options: | Option | Used on | Meaning | @@ -54,7 +65,7 @@ CSV exports can include member-level attendance data. Use the `private` option u Attendance is shown inside the signup and roster tools: -- Signup detail view: current attendance states and party view. +- Signup detail view: current attendance states and platoon (in-game party) view. - Member detail card: attendance breakdown and recent history. - Roster page: attendance summaries across members. @@ -72,6 +83,29 @@ Officers can move members between states such as Can, Waiting, Can't, Vacation, Attendance history can connect to score snapshots when event scores are uploaded, making member detail views more useful after wars. ::: +## No-Show Penalty + +**Premium.** When enabled, GuildYapper applies a no-show penalty automatically the moment a member is marked No Show. It subtracts priority per occurrence, and **stacks**: each additional no-show adds another hit on top of the last. The penalty lasts **1 to 60 days** after the missed war, and can DM the affected member with the penalty's value and duration. + +The effect of that penalty depends on waitlist mode: + +- **Custom Priority mode**: the penalty is applied as negative priority, lowering the member's effective priority for the duration. +- **Every other mode**: the member is sent to the back of the waitlist instead. + +See [Waitlist and Priority](/events/waitlist-and-priority) for how effective priority and waitlist mode work, and [Server Settings](/configuration/server-settings) to configure the penalty amount and duration. + +## Attendance Watch Channel + +**Premium.** A dedicated channel where GuildYapper posts no-show penalties as they're applied. The same channel also warns about members who have sat at **Can't** or **Undecided** for **7, 14, and 21 days**, so officers can follow up before it becomes a pattern. + +Configure the channel in [Server Settings](/configuration/server-settings). + +## Availability + +Every member has a weekly availability registered on their profile. Without Premium, it is informational only — officers can see it, but nothing acts on it automatically. With Premium active, Node War signups use that availability to automatically mark a member **Can** or **Can't**. + +See [Server Settings](/configuration/server-settings) for the auto-signup toggle. + ## Common Issues ### Attendance seems empty diff --git a/docs/features/community-tools.md b/docs/features/community-tools.md index c50930a..78e7cd6 100644 --- a/docs/features/community-tools.md +++ b/docs/features/community-tools.md @@ -1,3 +1,7 @@ +--- +description: "Recruiting posts, looking-for-merc posts, and verification tools for community servers." +--- + # Recruiting, Mercs, And Verify Community servers get tools for public coordination: recruiting posts, looking-for-merc posts, and verification messages. diff --git a/docs/features/guild-tracker.md b/docs/features/guild-tracker.md index 3032f18..23755c7 100644 --- a/docs/features/guild-tracker.md +++ b/docs/features/guild-tracker.md @@ -1,3 +1,7 @@ +--- +description: How guild and player detection works, PvP/PvX tracking, and the website Guild Tracker dashboard. +--- + # Guild Tracker Guild Tracker helps communities follow guild membership, guild history, player history, and consistency across supported regions. @@ -17,7 +21,16 @@ Guild Tracker helps communities follow guild membership, guild history, player h - Shows guild consistency information. - Shows player history and player profiles. - Can post tracker updates to a configured Discord channel. -- Powers public website Guild Tracker pages. +- Powers the website's Guild Tracker pages, which require Discord login. + +## What Gets Detected + +Guild Tracker publishes to the configured channel every day at **13:00 server time**. Each run can detect: + +- Guild entries and exits. +- Guild renames and player renames. +- Guild dissolutions. +- Deleted accounts. ## Who Can Use It @@ -45,6 +58,12 @@ Guild Tracker commands are not supported for RU, MENA, SEA, KR, or JP server reg /player profile player:FamilyName region:EU ``` +`guildtype` classifies a tracked guild as **PVP** or **PVX**; `/guild list` filters on that same classification and splits its response into active guilds and dissolved guilds. + +::: info Most Tracker Commands Are Private By Default +Almost every Guild Tracker command accepts a `private` parameter, and it is on by default. +::: + ## Tracker Update Types Tracker posting is configured in `/configure server`. @@ -69,7 +88,17 @@ The uploaded file should contain guild names, one per line. Keep custom tracker filters to up to 30 guild names. Guilds not already in the tracker list should be added first with `/guild add`. ::: -## Website Views +## On The Website + +The Guild Tracker dashboard requires logging in with Discord. + +It filters by **All guilds**, **PvP**, **PvX**, and **NW alliances**, and its top-level indicators cover tracked guilds, players, entries, exits, and renames, each with its 24-hour change. + +A **movement feed** covers the last three days across three tabs: entries and exits, renames, and alerts. Each row shows how long the person had been in the guild before the move, and auto-tags flag patterns like **guild hopper** and **likely temporary**. + +A gains-and-losses panel highlights the biggest risers and fallers over two weeks, and shows which guild each mover came from or went to. + +Guild and player detail pages give the full history behind any name in the feed. The website provides larger views for tracker data: @@ -77,6 +106,12 @@ The website provides larger views for tracker data: - [Guilds](https://guildyapper.com/guild-tracker/guilds): searchable guild list and details. - [Players](https://guildyapper.com/guild-tracker/players): searchable player list and details. +
+ Screenshot placeholder + Add a screenshot of the movement feed. + Suggested path: `/screenshots/guild-tracker/movement-feed.webp` +
+
Screenshot placeholder Add a screenshot of the Guild Tracker dashboard. diff --git a/docs/features/parties-and-waitlist.md b/docs/features/parties-and-waitlist.md deleted file mode 100644 index 271a96e..0000000 --- a/docs/features/parties-and-waitlist.md +++ /dev/null @@ -1,141 +0,0 @@ -# Parties And Waitlist - -Parties and waitlists decide how a full signup becomes an actual plan. GuildYapper can keep people in configured groups, split large parties, respect priorities, and move waitlisted members into open spots. - -```text -/configure nwparty -/configure class -/configure member member:@Member -/configure server -``` - -## What It Does - -- Creates and configures Node War parties such as Main, Defense, Flex, or custom groups. -- Assigns members to configured parties. -- Splits oversized parties into sub-parties. -- Uses class, party, individual, and waitlist-streak priority when configured. -- Lets officers temporarily move members for one event or permanently change roster party assignment. -- Supports waitlist behavior such as default order, custom priority, gearscore, random, or manual. - -## Who Can Use It - -Officers/admins configure parties and waitlist behavior. Members see the resulting signup and party assignments. - -## Required Permissions And Config - -- Guild / Alliance server type. -- Officer/admin role. -- Node War parties configured through `/configure nwparty`. -- Optional class priorities through `/configure class`. -- Optional member overrides through `/configure member`. - -
- Screenshot placeholder - Add a screenshot of `/configure nwparty`. - Suggested path: `/screenshots/parties/nwparty-config.webp` -
- -## Party Basics - -Every signup has a Main/default party. Guild / Alliance setup also creates starter parties. Officers can add more parties and configure: - -| Setting | Meaning | -| --- | --- | -| Party name | Display name on signup and party views. | -| Party role | Discord role used to assign or identify members for that party. | -| Sort key | Higher values make the party appear earlier in signup views. | -| Party priority | Adds priority to members in that party. | -| Party limit | Maximum size before overflow behavior starts. | -| Target participants | Lets the party request volunteers if it is below target. | -| Overflow type | Controls what happens when the party exceeds its limit. | -| Priority limit rate | Stops or reduces priority once enough of the party is already represented. | - -::: info Priority Adds Together -A member's effective priority can include personal priority, class priority, party priority, and waitlist-streak priority. -::: - -## Overflow Types - -| Overflow type | Behavior | -| --- | --- | -| `SPLIT` | Splits a large party into equal sub-parties such as Main 1 and Main 2. | -| `OVERFLOW` | Keeps the party capped and moves extra members to the default/Main party. | -| `LIMIT` | Keeps the party capped and leaves excess members on the waitlist. | - -::: tip SPLIT Is Best For Large Flexible Groups -Use `SPLIT` when a party can become multiple balanced groups. Use `LIMIT` when a group is truly capped. -::: - -## How Split Parties Work - -When a party uses `SPLIT`, GuildYapper tries to make clean sub-parties: - -1. Members forced into a specific party index stay there when possible. -2. Sub-parties are kept as equal in size as possible. -3. Special roles such as BSR, PA, and Shai are spread across sub-parties where possible. -4. Gearscore balance is used as a secondary improvement. -5. When a signup is frozen or already has assignments, GuildYapper keeps existing assignments stable where it can. - -Example: if Main has a limit of 20 and 44 attending members, it can become Main 1, Main 2, and Main 3. - -::: warning Forced Party Index -If an officer forces a member into Main 2 for one event, GuildYapper treats that as intentional and avoids moving them away just to make the math prettier. -::: - -## Temporary vs Permanent Party Moves - -The website party builder and Discord management actions can handle two kinds of moves: - -| Move type | Use it when | -| --- | --- | -| Temporary event move | You only want this member moved for the current signup. | -| Server roster move | You want this member's default party assignment changed for future signups. | - -
- Screenshot placeholder - Add a screenshot of the website party builder with pool and party board. - Suggested path: `/screenshots/parties/party-builder.webp` -
- -## Waitlist Modes - -Waitlist mode is configured in: - -```text -/configure server -``` - -| Mode | Meaning | -| --- | --- | -| Default | Earlier signups move in first. | -| Custom Priority | Higher effective priority moves in first. | -| Gearscore | Higher gearscore moves in first. | -| Random | Move-ins are randomized. | -| Manual | GuildYapper does not automatically move waitlisted members. | - -## Waitlist Fair Mode - -Fair mode gives members extra priority when they were waitlisted on previous Node Wars. Officers can decide how much priority is added per waitlisted Node War and whether `Can't` should count. - -::: info Fair Mode Goal -Fair mode helps members who repeatedly miss the final roster get a better chance later, while still letting officers keep class and party needs in the system. -::: - -## Backtracking Excess Attendees - -When caps or party limits change, officers can move excess attendees back to the waitlist. This is useful after lowering a cap or cleaning up a signup that had too many Can responses. - -## Common Issues - -### A party split looks uneven - -Check forced party indexes, party limits, and special role distribution. GuildYapper may keep some assignments stable even if a perfect split would require moving them. - -### A member did not move from waitlist - -Check waitlist mode, cap, signup status, priority, and whether manual mode is enabled. - -### A member keeps returning to the same party - -They may have a permanent server party assignment. Update it in the roster or `/configure member`. diff --git a/docs/features/scores.md b/docs/features/scores.md index f3f24b3..4122bb0 100644 --- a/docs/features/scores.md +++ b/docs/features/scores.md @@ -1,3 +1,7 @@ +--- +description: How guilds upload and review war score sessions from screenshots or Ikusa logs. +--- + # Scores Scores let your guild collect war results from screenshot uploads or Ikusa logs, then review sessions on Discord and the website. @@ -10,7 +14,7 @@ Scores let your guild collect war results from screenshot uploads or Ikusa logs, ## What It Does -- Uploads BDO war score screenshots through Discord or the website. +- Uploads BDO war scores — screenshots or a `.csv` export — through Discord or the website. - Supports multiple screenshot attachments in one Discord upload. - Supports Ikusa logger uploads on the website. - Links score sessions to signups where possible. @@ -35,12 +39,40 @@ Members can upload and view personal scores where allowed. Officers manage serve /scores upload file:score.png ``` -You can upload one required screenshot plus additional optional screenshots. +`/scores upload` accepts screenshots or a `.csv` export — GuildYapper describes it as "Upload bdo war scores (screenshots or .csv export)". You can attach one required file plus additional optional screenshots. ::: tip Use Clear Screenshots BDO OCR depends on image quality. Use clean, readable scoreboard screenshots and avoid heavy compression. ::: +## Ikusa Or OCR + +`/scores menu` presents Ikusa as the recommended score source, with BDO OCR as the alternative. + +**Ikusa** + +- Alliance-wide scores from one log. +- Automatic class detection. +- Guild-level score breakdowns. +- Automatic merc detection. +- Needs one member to run the Ikusa logger during the war, then upload the log afterward. + +**BDO OCR** + +- No third-party app needed — any member can upload a screenshot quickly. +- Detects structure kills. +- Accuracy depends on screenshot quality. + +Both sources can be used on the same server at once. + +::: tip Ikusa By Default, OCR To Fill Gaps +Recommend Ikusa as your server's default score source, and keep BDO OCR available as a quick fallback for members without a log. +::: + +## Connecting The Ikusa App + +The website has a login-completion step for pairing an external app — this is how the Ikusa logger links to a GuildYapper account. It comes before your first Ikusa upload. + ## BDO OCR Scores BDO OCR uses in-game scoreboard screenshots. It is fast and easy because any member can upload screenshots, but OCR may need review when the image is low quality. @@ -55,6 +87,20 @@ Ikusa uploads use log data from the Ikusa logger. They can provide alliance-wide GuildYapper keeps BDO OCR and Ikusa as separate score sources. The website lets you switch between them where both are available. ::: +## Personal Stats + +Personal stats surface through `/member view` ("View user's gear") and the personal pages on the website. + +## Server Score Stats + +The [Scores Management](https://guildyapper.com/management/scores) page has **Stats**, **IKUSA**, and **BDO OCR** tabs, with filters by source, class, and period. + +The Stats tab includes: + +- A historical record card with cumulative K/D across all wars. +- Highlights for top killer, best average K/D, longest streak, largest killfeed, and war MVP. +- A K/D-over-wars chart. + ## Website Score Pages | Page | Link | Use it for | @@ -63,6 +109,8 @@ GuildYapper keeps BDO OCR and Ikusa as separate score sources. The website lets | Personal Scores | [Open](https://guildyapper.com/scores) | Member personal uploads, bookmarks, and stats. | | Class Performance | [Open](https://guildyapper.com/class-performance) | Comparing class-level performance from score data. | +Each score session has its own link, keyed by source and public identifier, so it can be shared outside Discord. A VOD can be attached to a session — see [VOD Reviews](/scores/vod-reviews). +
Screenshot placeholder Add a screenshot of a score session detail page. diff --git a/docs/features/signups.md b/docs/features/signups.md index cc20b87..6605232 100644 --- a/docs/features/signups.md +++ b/docs/features/signups.md @@ -1,10 +1,15 @@ +--- +description: How signups work for Guild and Alliance servers, from event creation to waitlists and results. +--- + # Signups -Signups are the core event flow for Guild / Alliance servers. They let officers create events, members choose attendance, and leadership manage waitlists, parties, charts, results, and score links. +Signups are the core event flow for Guild / Alliance servers. They let officers create events, members choose attendance, and leadership manage waitlists, platoons (in-game parties), charts, results, and score links.
Website Signups - Parties and Waitlist + Platoons and Function Roles + Waitlist and Priority Attendance Scores
@@ -28,7 +33,7 @@ Members can usually respond to signups. Officers/admins create and manage signup - Officer/admin role configured. - Guild names configured for guild/alliance registration. - Optional Node War voice channel for missing-in-voice checks. -- Optional parties configured through `/configure nwparty`. +- Optional platoons configured through `/configure parties`. ## Create A Node War Signup @@ -69,13 +74,9 @@ GvG signups include an enemy guild and a match type. For ranked GvG signups, make sure your own guild names are configured in `/configure server`. ::: -## Create A Guild League Signup - -```text -/signup gleague date:19.05.2026 start-time:20:00 end-time:22:00 role:@Guild -``` +## Guild League -Guild League signups create time slots for valid matches in the configured time range. +Guild League has its own command, officer actions, and public match pages. See [Guild League](/events/guild-league). ## Create A Custom Signup @@ -85,10 +86,12 @@ Guild League signups create time slots for valid matches in the configured time Use custom signups for practice, training, meetings, or other events that still need attendance tracking. -::: info Custom Party Size -Custom and GvG signups can use a custom party size. If no custom size is set, GuildYapper uses normal signup behavior. +::: info Custom Platoon Size +Custom and GvG signups can use a custom platoon size. If no custom size is set, GuildYapper uses normal signup behavior. ::: +Every signup uses a signup profile, which decides the platoons (in-game parties) and function roles it offers. See [Event Types and Signup Profiles](/events/event-types) for the profiles, [Platoons and Function Roles](/events/platoons) for how a platoon is built, [Waitlist and Priority](/events/waitlist-and-priority) for how priority decides who gets a spot, and the [Platoon Builder](/events/platoon-builder) for assembling one event's composition on the website. + ## Attendance States | State | Meaning | @@ -108,6 +111,8 @@ Officers can use the signup's management menu and `/signup list`. /signup list ``` +`/signup list` shows every signup with its channel, name, date, result (**N/A**, **WON**, or **LOST**), attendance count, and a numeric **Id**, each with its own **Manage** button. The footer totals the number of signups shown and the **server's average attendance**. + Common management actions include: - Refresh message. @@ -134,7 +139,11 @@ Common management actions include: ## Website Signup Management -Open [Website Signups](https://guildyapper.com/management/signups) for a bigger event view. Officers can browse signups, open one event, inspect participants, update attendance, move members, and work with party assignments. +Open [Website Signups](https://guildyapper.com/management/signups) for a bigger event view. Officers can browse signups, open one event, inspect participants, update attendance, move members, and work with platoon assignments. + +The event detail view has keyboard shortcuts: `/` focuses search, `a` marks the selected member Can, `w` marks them Waiting, and `Esc` clears the selection. Three switches control the view: announcing the change and DMing participants (Premium) fire on every attendance change, and a **priority badges** toggle shows each member's priority next to them — see [Waitlist and Priority](/events/waitlist-and-priority) for how that priority is calculated. + +Every event also has a **VODs** button. See [VOD Reviews](/scores/vod-reviews).
Screenshot placeholder @@ -154,7 +163,7 @@ Ask the member to update their profile: ### Waitlist order looks unexpected -Check waitlist mode, class priority, member priority, party priority, fair mode, and party overflow settings. See [Parties and Waitlist](/features/parties-and-waitlist). +Check waitlist mode, class priority, member priority, platoon priority, fair mode, and platoon overflow settings. See [Waitlist and Priority](/events/waitlist-and-priority). ### The signup message was deleted diff --git a/docs/features/tierlists-and-stats.md b/docs/features/tierlists-and-stats.md deleted file mode 100644 index c50da21..0000000 --- a/docs/features/tierlists-and-stats.md +++ /dev/null @@ -1,83 +0,0 @@ -# Tierlists And Stats - -GuildYapper has public website pages for guild tierlists, class tierlists, guild wars, Arena of Solare scores, streams, class popularity, and class performance. - -
- NW Tierlist - Class Tierlist - Guild Wars - AOS Browser - Streams - Class Popularity - Class Performance -
- -## What It Does - -- Shows guild/alliance tierlists by region and tierlist context. -- Shows class/spec tierlist entries. -- Shows tierlist update history and methodology where available. -- Shows upcoming and past ranked GvG/Guild Wars pages. -- Shows Arena of Solare match scores and class/player stats. -- Shows streams with PvP-relevant keywords. -- Shows class popularity and class performance views. - -## Who Can Use It - -Most of these pages are public. Admin editing tools are only available to users with the relevant admin permissions. - -## Required Permissions And Config - -- Public browsing does not require a Guild / Alliance server. -- Tierlist editing requires tierlist admin permissions. -- Class tierlist editing requires class-tierlist admin permissions. -- Guild Wars data depends on ranked GvG signups and results. -- Class performance depends on available score/combat data. - -## Guild Tierlists - -Use [NW Tierlist](https://guildyapper.com/tierlist) to browse active alliances, tiers, update history, and methodology where present. - -Community servers can also use: - -```text -/tierlist updates announce:false days:7 -/tierlist retire-guild guildname:Example region:EU -``` - -::: info Tierlist Contexts -Tierlists can be scoped by contexts such as siege or cap tiers. Use the website filters to make sure you are viewing the intended ladder. -::: - -## Class Popularity And Performance - -| Page | Use it for | -| --- | --- | -| [Class Popularity](https://guildyapper.com/class-statistics) | Class population, spec split, and trend views. | -| [Class Performance](https://guildyapper.com/class-performance) | Comparing classes by score-derived and combat-derived performance metrics. | - -
- Screenshot placeholder - Add a screenshot of the class performance overview. - Suggested path: `/screenshots/stats/class-performance.webp` -
- -## Guild Wars And AOS - -- [Guild Wars](https://guildyapper.com/guildwars) shows ranked GvG information. -- [AOS Browser](https://guildyapper.com/wars/solare) shows Arena of Solare score and class/player views. -- [Streams](https://guildyapper.com/wars/streams) surfaces streams with PvP-relevant titles such as Nodewar, NW, AOS, or RBF. - -## Common Issues - -### A ranked GvG is missing - -Make sure the GvG signup was created as ranked and closed with a result. - -### A stream does not appear - -The stream title needs a PvP-relevant keyword. - -### Class stats look incomplete - -Stats depend on the available score and combat data for the selected filters. diff --git a/docs/features/trial-servers.md b/docs/features/trial-servers.md index 30b5a78..ef9af35 100644 --- a/docs/features/trial-servers.md +++ b/docs/features/trial-servers.md @@ -1,3 +1,7 @@ +--- +description: How Trial Server mode runs a separate applicant workflow from a normal guild Discord. +--- + # Trial Servers Trial Server mode creates a dedicated Discord workflow for applicants. It is separate from a normal Guild / Alliance server. diff --git a/docs/features/yap.md b/docs/features/yap.md index 7e51538..00fa44c 100644 --- a/docs/features/yap.md +++ b/docs/features/yap.md @@ -1,3 +1,7 @@ +--- +description: How members save and post short community messages with the Yap feature. +--- + # Yap Yap is GuildYapper's lightweight community message feature. Members can save short messages, and the bot can later post a random saved yap. @@ -11,6 +15,7 @@ Yap is GuildYapper's lightweight community message feature. Members can save sho - Stores server-specific yap messages. - Posts a random yap with `/yap`. +- Adds four message context menu actions: Yap, Add Yap, Delete Yap, and Mute Yaps. - Lets admins enable or disable Yap. - Blocks role mentions by default. - Can block all mentions if enabled in server config. @@ -41,7 +46,7 @@ Guild / Alliance and Community servers can use Yap when it is enabled. Members c /yap ``` -3. Remove a bad yap through the message context menu if available. +3. Manage yaps through the message [context menu](#message-context-menu). ::: info Cooldown The default yap cooldown is 3 minutes. Officers can set a custom cooldown in `/configure server`. @@ -51,6 +56,17 @@ The default yap cooldown is 3 minutes. Officers can set a custom cooldown in `/c Role mentions are blocked by default. If your community keeps trying to add noisy yaps, enable the setting that blocks all mentions. ::: +## Message Context Menu + +Right-click (or long-press) a message and open **Apps** for four yap actions: + +| Action | What it does | +| --- | --- | +| Yap | Replies to the message with a random saved yap. | +| Add Yap | Turns the selected message into a new saved yap. | +| Delete Yap | Removes a yap, with buttons to delete it or blacklist it, and logs the action to the log channel. | +| Mute Yaps | Stops the bot from mentioning you when someone yaps on your messages — the only control an annoyed member has. | +
Screenshot placeholder Add a screenshot of a yap message in Discord. diff --git a/docs/getting-started/first-node-war.md b/docs/getting-started/first-node-war.md new file mode 100644 index 0000000..ea3f9a7 --- /dev/null +++ b/docs/getting-started/first-node-war.md @@ -0,0 +1,26 @@ +--- +description: "An end-to-end walkthrough: from inviting the bot to uploading the war scores." +--- + +# Running Your First Node War + +## Who Can Use It + +This tutorial is aimed at the officer/admin setting up GuildYapper for a Guild / Alliance server. Steps that members handle themselves are called out below. + +This is a map of the full flow, in order. Each step links to the page that covers it in depth — go there for options, edge cases, and screenshots. + +1. Invite the bot and run `/setup`, choosing your server type and region. See [Setup](/getting-started/setup). +2. Set the member and officer roles and the log channel, in `/configure server` or the website's Settings page. See [Server Settings](/configuration/server-settings). +3. Register members: they run `/member update`; `/member missing` shows who hasn't yet. See [Members and Roster](/bot/members-and-roster). +4. Set up platoons (in-game parties) with `/configure parties`, and optionally event profiles with `/configure profiles`. See [Platoons and Function Roles](/events/platoons). +5. Adjust priority and waitlist behavior, and check it with `/priority view`. See [Waitlist and Priority](/events/waitlist-and-priority#checking-priority). +6. Create the signup with `/signup nodewar`. See [Signups](/features/signups#create-a-node-war-signup). +7. Track responses and the waitlist; `/signup list` opens management. See [Signups](/features/signups#managing-a-signup). +8. Build the composition in the Platoon Builder and send it to Discord. See [Platoon Builder](/events/platoon-builder). +9. After the war, upload scores with `/scores upload` or through Ikusa. See [Scores](/features/scores). +10. Close the event with a result and check attendance with `/attendance overview`. See [Attendance](/features/attendance). + +::: tip Automate The Repeat Work +Once this flow feels familiar, look at [Schedulers](/bot/schedulers) to automate signup posting and closing instead of running each step by hand every Node War. +::: diff --git a/docs/getting-started/how-it-works.md b/docs/getting-started/how-it-works.md new file mode 100644 index 0000000..2e9e203 --- /dev/null +++ b/docs/getting-started/how-it-works.md @@ -0,0 +1,82 @@ +--- +description: "How the Discord bot and the website divide the work, and how regions scope what you see." +--- + +# How GuildYapper Works + +## Who Can Use It + +This page is for anyone — no login needed to read it. GuildYapper itself is a mix: some Discord commands and website pages are public, and some require Discord login. See [What Needs A Login](#what-needs-a-login) below for the exact split. + +## Two Surfaces, One System + +GuildYapper is a Discord bot and a website working from the same data, not two separate products. + +- **The bot** is best for quick actions: creating a signup, updating your profile, checking `/priority view`, uploading a score screenshot — things you do in the moment, inside Discord. +- **The website** is best when you need tables, filters, charts, bulk roster editing, or a detail page — the things a Discord modal is too small for. + +A signup created in Discord appears on the website, and edits made on the website update the same underlying event or member record the bot reads. `/configure server` itself has a **Manage on Website** button that jumps you straight into the matching website page. + +## What Needs A Login + +| Area | Access | +| --- | --- | +| Tierlists, Guild Wars, Arena of Solare, Class Statistics, Streams, Tools, Guild League browser and standings | Public, no account | +| Guild Tracker dashboard, guilds and players | Discord login required | +| Signups, roster, scores management, settings, profile, VOD upload | Discord login, and membership of a server running GuildYapper | + +::: warning Guild Tracker Is Not Public +Guild Tracker's website pages require Discord login. Only the areas in the first row above are open to anyone without an account. +::: + +## What Officers Usually Use + +1. [Signups](https://guildyapper.com/management/signups) to manage event attendance. +2. [Roster](https://guildyapper.com/management/roster) to review and edit member data. +3. [Scores Management](https://guildyapper.com/management/scores) to upload and correct war score sessions. +4. [Guild Tracker Dashboard](https://guildyapper.com/guild-tracker/dashboard) to watch tracked guild activity. +5. [Class Performance](https://guildyapper.com/class-performance) to compare class results across data sources. + +## What Members Usually Use + +1. [Profile](https://guildyapper.com/profile) to keep their own info current. +2. [Personal Scores](https://guildyapper.com/scores) to review uploads, bookmarks, and stats. +3. [Signups](https://guildyapper.com/management/signups) when officers want members to inspect event details on the website. + +## Regions + +GuildYapper uses "region" in three separate places. They are independent of each other — changing one does not change the others. + +1. **Bot command default** — the region chosen during [`/setup`](/getting-started/setup) sets the default region for the bot's own commands, such as `/guild list` or `/player history`, in that Discord server. +2. **Website region selector** — the website has its own region selector at the top of the page, separate from any Discord server's setup. It rescopes tierlists, Guild Tracker, streams, and class statistics to the chosen region, and includes a **World** view that combines all regions. +3. **Member profile region** — a member's profile is stored per region. Family name, gear, and class apply to whichever region is currently selected when the profile is viewed or edited. + +::: info Don't Conflate These Three +A member registered under the EU region will not show up when the website region selector is set to NA, even in the same Discord server. Before assuming data is missing, check which of the three scopes above you're actually looking at. +::: + +## Where To Go Next + +| Goal | Where to go next | +| --- | --- | +| Run first-time setup | [Setup](/getting-started/setup) | +| Understand server types before choosing one | [Server Types](/getting-started/server-types) | +| Walk through a full Node War from setup to signup | [First Node War tutorial](/getting-started/first-node-war) | + +## Common Issues + +### I cannot see my server on the website + +Make sure you are logged in with the Discord account that is in the server and has the configured member role. + +### I can view a page but cannot edit it + +Editing requires officer/admin privileges for that GuildYapper server. + +### My member data looks outdated + +Update your profile on the website, or with: + +```text +/member update +``` diff --git a/docs/getting-started/server-types.md b/docs/getting-started/server-types.md index 5cc0159..6280cf4 100644 --- a/docs/getting-started/server-types.md +++ b/docs/getting-started/server-types.md @@ -1,3 +1,7 @@ +--- +description: The server types GuildYapper supports and how each one changes available commands. +--- + # Server Types GuildYapper changes its available commands based on the server type selected during `/setup`. This keeps a guild Discord from being cluttered with community-only tools, and keeps a trial Discord focused on trials. @@ -16,7 +20,7 @@ Use this for a guild or alliance Discord that runs events and manages a member r - Node War, GvG, Guild League, and custom signups. - Attendance and signup history. - Roster and member profile management. -- Node War parties, waitlist behavior, and class priority. +- Node War platoons (in-game parties), waitlist behavior, and class priority. - Guild Tracker lookup and updates in supported regions. - Scores and score uploads. - Yap. @@ -24,7 +28,7 @@ Use this for a guild or alliance Discord that runs events and manages a member r ### Who Can Use It -Members with the configured member role can use regular member tools. Officers/admins with the configured officer role can manage signups, server settings, parties, rosters, schedules, and other admin tools. +Members with the configured member role can use regular member tools. Officers/admins with the configured officer role can manage signups, server settings, platoons, rosters, schedules, and other admin tools. ### Best For @@ -94,7 +98,7 @@ Trial Server setup creates roles, channels, categories, permissions, and an invi ## Changing Server Type Later -Use `/configure server` to view and change the server type. Changing into Guild / Alliance mode creates default class configs and Node War parties if they are missing. +Use `/configure server` to view and change the server type. Changing into Guild / Alliance mode creates default class configs and Node War platoons if they are missing. ::: warning Be Careful With Server Type Changes Changing server type affects which commands GuildYapper syncs to Discord. If users say commands disappeared, check the current server type first. diff --git a/docs/getting-started/setup.md b/docs/getting-started/setup.md index 30c84e2..d53ebad 100644 --- a/docs/getting-started/setup.md +++ b/docs/getting-started/setup.md @@ -1,3 +1,7 @@ +--- +description: How to run /setup and configure GuildYapper for your server. +--- + # Setup Use `/setup` once after inviting GuildYapper. Setup chooses the server type, region, roles, and channels GuildYapper uses later. @@ -77,7 +81,7 @@ Guild Tracker commands are available for EU, NA, and SA. RU, MENA, SEA, KR, and | Server type | Choose it when | Main tools | | --- | --- | --- | -| Guild / Alliance | Your Discord runs Node War, GvG, Guild League, or other guild events. | Signups, attendance, roster, parties, Guild Tracker, Yap, scores. | +| Guild / Alliance | Your Discord runs Node War, GvG, Guild League, or other guild events. | Signups, attendance, roster, platoons (in-game parties), Guild Tracker, Yap, scores. | | Community | Your Discord is a public or community hub rather than one guild roster. | Guild Tracker, recruiting, merc posts, verification, tierlist updates, Yap. | | Trial Server | You want a dedicated Discord for trial applicants. | Trial signup, automatic channels, trial history, trial ending flow. | @@ -103,8 +107,8 @@ Read more in [Server Types](/getting-started/server-types). /configure server ``` -::: tip Default Parties -Guild / Alliance setup creates starter Node War parties such as Main, Defense, and Flex. You can adjust these later with `/configure nwparty`. +::: tip Default Platoons +Guild / Alliance setup creates starter Node War platoons such as Main, Defense, and Flex. You can adjust these later with `/configure parties`. :::
@@ -119,7 +123,8 @@ The next useful actions are: ```text /configure server -/configure nwparty +/configure parties +/configure profiles /configure class /member missing /signup nodewar @@ -129,7 +134,9 @@ The next useful actions are: | Goal | Where to go next | | --- | --- | | Create events | [Signups](/features/signups) | -| Configure parties and waitlist behavior | [Parties and Waitlist](/features/parties-and-waitlist) | +| Configure platoons and function roles | [Platoons and Function Roles](/events/platoons) | +| Configure waitlist and priority behavior | [Waitlist and Priority](/events/waitlist-and-priority) | +| Change server settings | [Server Settings](/configuration/server-settings) | | Let members update their profile | [Members and Roster](/bot/members-and-roster) | | Enable reminders and automation | [Schedulers](/bot/schedulers) | | Check paid and trial status | [Premium](/premium) | diff --git a/docs/index.md b/docs/index.md index f79903b..1809c8e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,6 @@ --- layout: home +description: The GuildYapper documentation home, with quick links into setup, events, tracking, and community features. hero: name: GuildYapper @@ -18,7 +19,7 @@ hero: features: - title: Event management - details: Create Node War, GvG, Guild League, and custom signups with attendance, waitlists, party splits, charts, and score links. + details: Create Node War, GvG, Guild League, and custom signups with attendance, waitlists, platoon (in-game party) splits, charts, and score links. - title: Member and roster tools details: Let members update their class, gear, guild, Garmoth link, and vacation state while officers manage roster details. - title: Tracking and insights @@ -37,7 +38,7 @@ GuildYapper combines a Discord bot with the [GuildYapper website](https://guildy /> ::: info Best First Read -If GuildYapper is new in your server, [invite the bot](https://discord.com/oauth2/authorize?client_id=1238194592982110248), then start with [Setup](/getting-started/setup). If it is already running, use the cards below to jump into the feature you need. +New here? Start with [How GuildYapper Works](/getting-started/how-it-works). If GuildYapper is new in your server, [invite the bot](https://discord.com/oauth2/authorize?client_id=1238194592982110248), then start with [Setup](/getting-started/setup). If it is already running, use the cards below to jump into the feature you need. :::
@@ -45,9 +46,9 @@ If GuildYapper is new in your server, [invite the bot](https://discord.com/oauth Signups Create events, manage attendance, move waitlisted members, and close events. - - Parties and Waitlist - Understand party assignment, split behavior, priority, limits, and fair mode. + + Waitlist and Priority + Understand the priority stack, dynamic class limits, waitlist modes, and fair mode. Members and Roster @@ -77,7 +78,7 @@ If GuildYapper is new in your server, [invite the bot](https://discord.com/oauth Profile Guild Tracker Class Performance - Support + Support
## What GuildYapper Helps With @@ -86,8 +87,8 @@ If GuildYapper is new in your server, [invite the bot](https://discord.com/oauth | --- | --- | | Setup | Guided Discord setup with server type, region, roles, channels, Guild Tracker settings, and Trial Server automation. | | Events | Node War, GvG, Guild League, and custom signups with attendance states and officer actions. | -| Parties | Configurable parties, party sizes, priority, waitlist rules, split parties, and temporary event-only moves. | -| Roster | Member profiles, gear, class/spec, guild, role-like labels, party assignments, priorities, attendance history, and score snapshots. | +| Platoons | Configurable platoons, platoon sizes, priority, waitlist rules, split platoons, and temporary event-only moves. | +| Roster | Member profiles, gear, class/spec, guild, role-like labels, platoon assignments, priorities, attendance history, and score snapshots. | | Scores | BDO OCR screenshot uploads, Ikusa uploads, score menus, personal stats, alliance/guild breakdowns, and class filters. | | Tracking | Guild and player lookup, guild consistency, public guild lists, tierlists, class popularity, class performance, and Guild Wars pages. | | Community | Yap messages, recruiting browser posts, merc signup posts, verification posts, and Trial Server flows. | diff --git a/docs/premium.md b/docs/premium.md index 465818b..428da10 100644 --- a/docs/premium.md +++ b/docs/premium.md @@ -1,3 +1,7 @@ +--- +description: Premium and VIP pricing, the full list of what Premium unlocks, and what happens to your config when it lapses. +--- + # Premium Premium unlocks advanced automation and customization for a GuildYapper server while supporting development. @@ -6,15 +10,34 @@ Premium unlocks advanced automation and customization for a GuildYapper server w /premium ``` -## What It Does +## Plans + +| Plan | Price | Includes | +| --- | --- | --- | +| Free | — | Signups, attendance, roster, scores, and every public tracker, plus 5 signup profiles and 5 function roles. | +| Premium | US$7.99/month | Everything listed in [What Premium Unlocks](#what-premium-unlocks) below. | +| VIP | US$19.99/month | Exactly the same feature set as Premium. | + +::: info VIP Does Not Unlock More Than Premium +VIP costs more than Premium but unlocks **exactly the same features**. It exists for guilds that want to support GuildYapper's development beyond the base Premium price, not for guilds that want extra functionality. +::: + +Prices are set by Discord's store, billed in US dollars as a recurring subscription, and are managed and cancelled from Discord's own user subscription settings. + +
+ Screenshot placeholder + Add a screenshot of the Premium and VIP plan cards. + Suggested path: `/screenshots/premium/plans.webp` +
-Premium unlocks: +## What Premium Unlocks -- Advanced scheduler automation. -- Signup customization through member configuration. -- Custom bot profile options. -- Direct-message utilities. -- Premium-only scheduler actions such as automatic signup posting, closing, pre-war announcements, and inactive-member checks. +- **VOD Reviews** — timestamped notes and Ikusa context on top of any uploaded recording. See [VOD Reviews](/scores/vod-reviews). +- **Scheduler automation** — automatic signup posting and closing, pre-war announcements, and inactive-member checks. See [Schedulers](/bot/schedulers). +- **Attendance safeguards** — no-show penalties and an attendance watch channel for stale responses. See [Server Settings](/configuration/server-settings). +- **Smart signup flow** — auto-signup from weekly availability, and waitlist move DMs. See [Server Settings](/configuration/server-settings) and [Waitlist and Priority](/events/waitlist-and-priority). +- **Custom signup profiles and unlimited function roles** — beyond the free plan's 5 and 5. See [Event Types and Signup Profiles](/events/event-types) and [Platoons and Function Roles](/events/platoons). +- **Member markers, a custom bot profile, and officer DMs** — covered below in [Included Features](#included-features). ## Who Can Use It @@ -103,6 +126,12 @@ GuildYapper's Premium message states that any member on the Discord server can p Subscriptions are cancelled when the user who purchased the subscription leaves the Discord server. ::: +## What Happens When It Ends + +When Premium ends, your configuration is **preserved** — it simply stops applying until Premium is active again. + +The one exception is the custom bot profile: it is reverted, since a Premium-only avatar or nickname would otherwise stay visibly active on a server without an active subscription. + ## Store And Donations The Premium message includes: diff --git a/docs/public/arena-of-solare.md b/docs/public/arena-of-solare.md new file mode 100644 index 0000000..3072f02 --- /dev/null +++ b/docs/public/arena-of-solare.md @@ -0,0 +1,40 @@ +--- +description: "Arena of Solare match scores and the seasonal ranking snapshots." +--- + +# Arena of Solare + +
+ Match Browser + Rankings +
+ +## Who Can Use It + +Browsing is public. Uploading a match requires an account and being logged in. + +::: info Two Different Pages +Arena of Solare is two separate pages on the site, not one. The [Match Browser](https://guildyapper.com/wars/solare) is a browser of individual matches uploaded by players. [Rankings](https://guildyapper.com/aos-rankings) is a daily snapshot of the game's ladder, by season. They cover different data — use the Match Browser to look at specific fights, and Rankings to see where classes and players stand on the ladder over time. +::: + +## Match Browser + +The [Match Browser](https://guildyapper.com/wars/solare) lists community-uploaded matches. Toggle between **Public Matches** and **Private Matches**. + +Each match shows a win or loss with its **rating change** (observed values run from +27 to −24). Opening a match shows a per-player breakdown with K/D, CC, damage dealt, damage taken, and healing, plus **ACE** and **MVP** badges. + +At the end of a match, a class performance table summarizes games, players, K/D, CCs, damage, damage taken, healing, and win rate per class. + +## Rankings + +[Rankings](https://guildyapper.com/aos-rankings) is a separate page showing seasonal ranking snapshots. It compares the current snapshot against the previous one. + +The **Top 100 Mix** panel shows class representation in the top 100 (the observed snapshot had 27 of 32 classes represented). For each class it shows the **entry**, **median**, and **peak** elo. Toggle between a combined view and a per-spec view. Classes outside the top 100 are listed separately. + +Filters are available by class and by elo range, along with a Patch Notes button. + +
+ Screenshot placeholder + Add a screenshot of the AOS Rankings page. + Suggested path: `/screenshots/stats/aos-rankings.webp` +
diff --git a/docs/public/class-statistics.md b/docs/public/class-statistics.md new file mode 100644 index 0000000..226fe1a --- /dev/null +++ b/docs/public/class-statistics.md @@ -0,0 +1,57 @@ +--- +description: "Class popularity, combat performance and the node war leaderboards." +--- + +# Class Statistics + +
+ Class Popularity + Class Performance + Leaderboards +
+ +## Who Can Use It + +All three pages are public. No account and no Guild / Alliance server are required to browse them. + +## Where The Data Comes From + +Popularity numbers come from players registered on GuildYapper who sign up for node wars. Performance numbers come from submitted score sessions. Read the numbers with that in mind: popularity reflects signups, not necessarily every class actually played, and performance reflects only the wars that were scored and uploaded. + +## Class Popularity + +The [Class Popularity](https://guildyapper.com/class-statistics) page scopes by tier — **T1**, **T2**, **T3** — and offers cuts for **top 10 alliances** and **active in 30 days**. + +Top-level indicators show total players, active players, number of classes, most popular class, and the biggest 14-day gainer and biggest 14-day drop. + +The class ranking table splits each class between **Succession** and **Awakening**, and shows share of the population, average gearscore, and 14-day trend per row. + +## Class Performance + +The [Class Performance](https://guildyapper.com/class-performance) page filters by period (**30 days**, **14 days**, **all time**) and by node war tier, over a total wars analyzed count shown on the page. + +Highlight indicators call out the most picked class, best average K/D, most damage, most kills, most CC, most healing, most healing on allies, and most damage on fort. A comparison chart toggles between kills, damage, and K/D. + +The main table toggles between per-hour and per-war views, and between class and class+spec rows. Selecting a row opens matchups and further detail. + +## Leaderboards + +The [Leaderboards](https://guildyapper.com/class-leaderboards) page is not covered by the other two — it surfaces standout individual performances rather than aggregates. + +**Single-War Highs** lists the record for a single war in each category — most damage, most CCs, most healing on allies, biggest killfeed, most damage on fort, and most damage taken — each with the player, guild, and date it happened. + +**Top 25 Players** ranks players by impact, toggling between an advanced view and a K/D-only view. + +**Best Node Wars** ranks individual wars by kills minus deaths. This is where a single standout performance shows up even if the player isn't in the season's Top 25 — a good match earns its place here regardless of season-long standing. + +A class ranking rounds out the page, ranked by a selectable metric. + +
+ Screenshot placeholder + Add a screenshot of the Leaderboards page. + Suggested path: `/screenshots/stats/leaderboards.webp` +
+ +## Related Pages + +Class stats are war-derived, not live. For live PvP streams, see [Streams and Tools](/public/streams-and-tools). diff --git a/docs/public/guild-wars.md b/docs/public/guild-wars.md new file mode 100644 index 0000000..9c21055 --- /dev/null +++ b/docs/public/guild-wars.md @@ -0,0 +1,45 @@ +--- +description: "Ranked GvG: seasons, points, standings and match history." +--- + +# Guild Wars + +
+ Guild Wars +
+ +## Who Can Use It + +The [Guild Wars](https://guildyapper.com/guildwars) page is public. Getting a guild onto the board requires a ranked GvG signup created by an officer. + +## How A Guild Gets On The Board + +A guild enters the board when an officer creates a ranked GvG signup with `/signup gvg`. If no war is currently scheduled, the page says so directly and tells you how to schedule one. + +## Seasons + +The board runs by season. At the time of writing, the site shows the **Preseason** label. The page itself includes a "How ranking works" explainer covering the scoring in more detail. + +## Guild Rankings + +The season standings show each guild's points (observed in the 520–580 range), along with a win/loss record. Expand a guild to see its recent matchups as a sequence of W and L results. + +
+ Screenshot placeholder + Add a screenshot of the Guild Rankings standings. + Suggested path: `/screenshots/stats/guild-wars.webp` +
+ +## Match History + +Match History lists completed wars with date, time, the two guilds, and the final score. A match can have a **VOD** attached and a roster breakdown. See [VOD Reviews](/scores/vod-reviews) for more on reviewing attached VODs. + +::: tip See Also +Guild Wars and [Arena of Solare](/public/arena-of-solare) are both competitive PvP pages — Guild Wars tracks ranked GvG, while Arena of Solare covers open-world PvP matches and rankings. +::: + +## Common Issues + +### A ranked GvG is missing + +Make sure the GvG signup was created as ranked and closed with a result. diff --git a/docs/public/screenshots/README.md b/docs/public/screenshots/README.md index 94b6362..6b843d8 100644 --- a/docs/public/screenshots/README.md +++ b/docs/public/screenshots/README.md @@ -1,3 +1,7 @@ +--- +description: Contributor notes on where to place documentation screenshots and how to reference them. +--- + # Screenshot Assets Place documentation screenshots in this folder. Anything here is served from `/screenshots/...` in VitePress. diff --git a/docs/public/streams-and-tools.md b/docs/public/streams-and-tools.md new file mode 100644 index 0000000..90259b1 --- /dev/null +++ b/docs/public/streams-and-tools.md @@ -0,0 +1,49 @@ +--- +description: "Live PvP streams and the curated directory of Black Desert tools and communities." +--- + +# Streams And Tools + +
+ Streams + Tools +
+ +## Who Can Use It + +Both pages are public. No account and no login are required to browse them. + +## PvP Streams + +The [Streams](https://guildyapper.com/wars/streams) page lists live Twitch broadcasts, filterable by mode: **Nodewar/Siege**, **GvG**, **Guild League**, **AOS**, and **RBF**. Each card shows the mode, the streamer, the stream title, viewer count, and language. + +The page header shows how many streams are currently live and how many are from partners. Partner streams get **privileged placement** at the top of the list, with the rest below. A **Show my stream** button explains how to get a stream onto the list. + +## Tools + +[Tools](https://guildyapper.com/tools) is a whole section of the site not covered elsewhere in this documentation. It gathers: + +- **Combat Toolkit** — links out to Ikusa and Garmoth. +- A **PvP damage calculator**. +- A **gear planner**. +- **Fort location maps** for Balenos and Serendia. +- A collection of community-creator **video guides**. +- A **resource library** — skill builders, PvP guides, a client performance guide, a utility hub, an AOS ladder, the community's open API, and a ping monitor. +- **Regional communities**. +- A directory of **class Discords**. + +::: info External Resources +Tools is a curated collection of external resources maintained by third parties, not GuildYapper features. +::: + +
+ Screenshot placeholder + Add a screenshot of the Tools page. + Suggested path: `/screenshots/website/tools.webp` +
+ +## Common Issues + +### A stream does not appear + +The stream title needs a PvP-relevant keyword. diff --git a/docs/public/tierlists.md b/docs/public/tierlists.md new file mode 100644 index 0000000..1633f49 --- /dev/null +++ b/docs/public/tierlists.md @@ -0,0 +1,93 @@ +--- +description: "Node war alliance tiers and class tierlists, how they are decided, and how they change." +--- + +# Tierlists + +
+ NW Tierlist + Class Tierlist +
+ +## Who Can Use It + +Both tierlist pages are public. No account and no Guild / Alliance server are required to browse them. Editing is restricted: NW Tierlist editing requires tierlist admin permissions, and Class Tierlist editing requires class-tierlist admin permissions. + +## NW Tierlist + +The [NW Tierlist](https://guildyapper.com/tierlist) ranks alliances by region. It covers three contexts, each on its own tab: + +- **Capped (Tier 1)** +- **Capped (Tier 2)** +- **Uncapped** + +Each tab shows a table with these columns: + +| Column | Meaning | +| --- | --- | +| Tier | The alliance's current tier. | +| Alliance | Alliance name. | +| Guilds | Guilds in the alliance. | +| NW Days | Node war days the alliance fights. | +| Caps | Cap size the alliance runs. | +| Attendance | The alliance's declared attendance ceiling. | +| Contact | Contact for the alliance. | +| Backup | Backup contact. | +| Updated | When this row was last reviewed. | + +A separate **Unknown Status** section lists guilds with no known alliance. A toggle lets you also show guilds with fewer than 20 members, and you can filter the list by tier and by NW days. + +::: info Curated, Not Automatic +The tierlist is curated by a named person on the page, who also shows the date of the last full review. +::: + +
+ Screenshot placeholder + Add a screenshot of the NW Tierlist. + Suggested path: `/screenshots/stats/nw-tierlist.webp` +
+ +## Update History + +The NW Tierlist page has its own **Update History** tab. Each entry shows the alliance, its tier change (for example `S → S+`), and its position change (for example `2 → 1`), with a date. A filter lets you view history across all tierlists instead of just the one you're currently viewing. + +## Methodology + +This is published on the site and reproduced here because it's the question guilds ask most often. + +**Initial placement** considers: + +- Node war performance over the last month. +- Consistency of attendance and performance. +- Average gearscore and playstyle. + +**Promotion and relegation** consider: + +- Win rate against similar tiers. +- Consistent losses to equal or lower tiers. +- Consistent wins against equal or higher tiers. +- Siege participation and performance. +- Significant influx of new members, for example when a guild dissolves and its members migrate into another guild. + +::: info Disputing A Placement +Curation accepts evidence to reassess a placement. +::: + +## Class Tierlist + +The [Class Tierlist](https://guildyapper.com/class-tierlist) is not a single list. It covers four separate contexts: + +- **Capped Nodewar** +- **Uncapped Nodewar** +- **AOS** +- **GvG** + +Each context has its own tiers, and each tier carries its own description. Every class entry lists its spec — Succession, Awakening, or Ascension — along with a written justification for its placement. + +::: tip Check The Context +A class's tier in Capped Nodewar can differ from its tier in AOS or GvG. Make sure you're reading the tierlist for the context you actually care about. +::: + +## Related Pages + +Guild Wars and Class Statistics are separate public pages. See [Guild Wars](/public/guild-wars) for ranked GvG results, and [Class Statistics](/public/class-statistics) for class popularity and performance data. diff --git a/docs/reference/commands.md b/docs/reference/commands.md index 463c4fe..ece3692 100644 --- a/docs/reference/commands.md +++ b/docs/reference/commands.md @@ -1,9 +1,17 @@ +--- +description: The full list of GuildYapper's user-facing slash commands, grouped by area. +--- + # Slash Commands -This page lists the user-facing slash commands found in GuildYapper's Discord bot. Discord may show fewer commands depending on your server type. +This page lists the user-facing slash commands found in GuildYapper's Discord bot, with a **Who** column showing who typically reaches for each one. ::: info Server Type Matters -Guild / Alliance, Community, and Trial Server mode do not share the exact same command set. If a command is missing, check `/configure server`. +Guild / Alliance, Community, and Trial Server are different Discord server types, chosen in `/setup`. Discord only shows the commands your server type unlocks — Community and Trial commands never appear on a Guild / Alliance server, and vice versa. The bot's own built-in `/help` menu can lag behind; this page follows what Discord actually registers. +::: + +::: tip Member Vs Officer +**Member** commands are available to anyone with the configured member role. **Officer** commands require the configured officer/admin role. If the wrong people can or cannot use a command, check `/configure server`. ::: ## Setup And Help @@ -14,31 +22,35 @@ Guild / Alliance, Community, and Trial Server mode do not share the exact same c /premium ``` -| Command | Use | -| --- | --- | -| `/setup` | First-time server setup. Administrator permission required. | -| `/help` | Opens the command help menu. | -| `/premium` | Shows Premium status, trial, store, subscription, and donation buttons. | +| Command | Who | Use | +| --- | --- | --- | +| `/setup` | Officer | First-time server setup. Administrator permission required. | +| `/help` | Member | Opens the command help menu. | +| `/premium` | Member | Shows Premium status, trial, store, subscription, and donation buttons. | ## Configuration ```text /configure server -/configure nwparty +/configure parties +/configure profiles /configure class /configure member member:@Member /configure scheduler /configure guildfilter file:guilds.txt +/priority view ``` -| Command | Use | -| --- | --- | -| `/configure server` | Server type, region, roles, channels, Yap, tracker, guild names, and Node War behavior. | -| `/configure nwparty` | Node War parties, limits, priority, overflow, targets, and assignments. | -| `/configure class` | Class/spec priorities and class type priority limits. | -| `/configure member` | Individual member configuration. | -| `/configure scheduler` | Reminder and automation schedules. | -| `/configure guildfilter` | Upload custom Guild Tracker filter file. | +| Command | Who | Use | +| --- | --- | --- | +| `/configure server` | Officer | Server type, region, roles, channels, Yap, tracker, guild names, and Node War behavior. | +| `/configure parties` | Officer | Platoons (in-game parties) and function roles: Discord role, priority, limit, reduction, class exclusion, size, overflow, and target. | +| `/configure profiles` | Officer | Signup profiles per event type — which platoons and function roles each event layout offers. | +| `/configure class` | Officer | Class/spec priorities and class type priority limits. | +| `/configure member` | Officer | Individual member configuration. | +| `/configure scheduler` | Officer | Reminder and automation schedules. | +| `/configure guildfilter` | Officer | Upload custom Guild Tracker filter file. | +| `/priority view` | Officer | Paginated priority overview by Family, Priority, and Class, with Member list, Config overview, and Get CSV buttons. See [Waitlist and Priority](/events/waitlist-and-priority). | ## Signups @@ -50,13 +62,13 @@ Guild / Alliance, Community, and Trial Server mode do not share the exact same c /signup list ``` -| Command | Use | -| --- | --- | -| `/signup nodewar` | Create a Node War signup. | -| `/signup gvg` | Create a ranked or practice GvG signup. | -| `/signup gleague` | Create Guild League signup time slots. | -| `/signup custom` | Create a custom event signup. | -| `/signup list` | List and manage existing signups. | +| Command | Who | Use | +| --- | --- | --- | +| `/signup nodewar` | Officer | Create a Node War signup. | +| `/signup gvg` | Officer | Create a ranked or practice GvG signup. | +| `/signup gleague` | Officer | Create Guild League signup time slots. | +| `/signup custom` | Officer | Create a custom event signup. | +| `/signup list` | Officer | List and manage existing signups. | ## Attendance @@ -67,12 +79,12 @@ Guild / Alliance, Community, and Trial Server mode do not share the exact same c /attendance export ``` -| Command | Use | -| --- | --- | -| `/attendance me` | View your own attendance. | -| `/attendance member` | View one member's attendance. | -| `/attendance overview` | View server attendance overview. | -| `/attendance export` | Export attendance to CSV. | +| Command | Who | Use | +| --- | --- | --- | +| `/attendance me` | Member | View your own attendance. | +| `/attendance member` | Officer | View one member's attendance. | +| `/attendance overview` | Officer | View server attendance overview. | +| `/attendance export` | Officer | Export attendance to CSV. | ## Members @@ -81,14 +93,16 @@ Guild / Alliance, Community, and Trial Server mode do not share the exact same c /member view member:@Member /member list sorting:gearscore /member missing +/stats classes ``` -| Command | Use | -| --- | --- | -| `/member update` | Update your own member details. | -| `/member view` | View one member's gear/profile information. | -| `/member list` | List members sorted by gearscore, class, or guild. | -| `/member missing` | Mention or list members who have not registered yet. | +| Command | Who | Use | +| --- | --- | --- | +| `/member update` | Member | Update your own member details. | +| `/member view` | Member | View one member's gear/profile information. | +| `/member list` | Officer | List members sorted by gearscore, class, or guild. | +| `/member missing` | Officer | Mention or list members who have not registered yet. | +| `/stats classes` | Member | View your server's class distribution among registered members. | ## Scores @@ -97,10 +111,10 @@ Guild / Alliance, Community, and Trial Server mode do not share the exact same c /scores upload file:score.png ``` -| Command | Use | -| --- | --- | -| `/scores menu` | Open the Discord score menu. | -| `/scores upload` | Upload BDO war score screenshots. | +| Command | Who | Use | +| --- | --- | --- | +| `/scores menu` | Member | Open the Discord score menu. | +| `/scores upload` | Officer | Upload BDO war scores — screenshots or a `.csv` export. | ## Guild Tracker @@ -135,10 +149,10 @@ Guild Tracker commands are available for EU, NA, and SA. /yap ``` -| Command | Use | -| --- | --- | -| `/addyap` | Add a new yap message. | -| `/yap` | Post a random yap. | +| Command | Who | Use | +| --- | --- | --- | +| `/addyap` | Member | Add a new yap message. | +| `/yap` | Member | Post a random yap. | ## Community Commands diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md new file mode 100644 index 0000000..db72307 --- /dev/null +++ b/docs/reference/glossary.md @@ -0,0 +1,37 @@ +--- +description: "Definitions for the GuildYapper and Black Desert terms used across these docs." +--- + +# Glossary + +Definitions for terms as they're used inside GuildYapper. Each entry links to the page that develops it further. + +- **AAP** — One of four gear values (alongside GS, AP, and DP) shown for a member in the [Platoon Builder](/events/platoon-builder)'s member detail panel. +- **AP** — One of four gear values (alongside GS, AAP, and DP) shown for a member in the [Platoon Builder](/events/platoon-builder)'s member detail panel. +- **Ascension** — One of the three specs (with Succession and Awakening) a class entry is placed under on the [Class Tierlist](/public/tierlists). +- **Awakening** — One of the three specs (with Succession and Ascension) a class entry is placed under on the [Class Tierlist](/public/tierlists), and one of the two specs the [Class Popularity](/public/class-statistics) ranking splits classes into. +- **BSR** — A dynamic class type set through `/configure class`. Classes typed BSR share a priority limit and are spread across split platoons rather than clustering together. See [Dynamic Class Types](/events/waitlist-and-priority#dynamic-class-types). +- **Blue Battlefield** — One of GuildYapper's five system [signup profiles](/events/event-types), used for Blue Battlefield events. +- **Capped and Uncapped** — The two attendance contexts on the [NW Tierlist](/public/tierlists), further split into Capped Tier 1 and Capped Tier 2; the same distinction applies to the Nodewar contexts on the Class Tierlist. +- **DP** — One of four gear values (alongside GS, AP, and AAP) shown for a member in the [Platoon Builder](/events/platoon-builder)'s member detail panel. +- **Dynamic class type** — A per-class/spec classification (`DEFAULT`, `PA`, `BSR`, or `SHAI`) set in `/configure class` that gives a class a share limit of attending members before its priority is temporarily reduced. See [Dynamic Class Types](/events/waitlist-and-priority#dynamic-class-types). +- **Effective priority** — In Custom Priority waitlist mode, a member's combined priority for waitlist move-ins: class priority, platoon priority, function role priority, and personal priority added together. See [The Priority Stack](/events/waitlist-and-priority#the-priority-stack). +- **Fair mode** — A waitlist setting that gives members extra priority for previous Node Wars they were waitlisted on, helping members who repeatedly miss the final roster. See [Fair Mode](/events/waitlist-and-priority#fair-mode). +- **Family name** — A member's in-game family name, used to identify them across signups, roster, attendance, and scores. See [Member Profile Updates](/bot/members-and-roster#member-profile-updates). +- **Function role** — A signup label (not a Discord role) such as Elephant Rider or Flag, with its own emoji, optional priority, limit, and class exclusion. See [Function Roles](/events/platoons#function-roles). +- **Garmoth** — The external gear-planning site members link from their GuildYapper profile so officers and the member have a quick route to detailed gear. See [Member Profile Updates](/bot/members-and-roster#member-profile-updates). +- **Gearscore (GS)** — A single number summarizing a member's gear, tracked on their roster profile and used for sorting, roster context, and distribution charts. See [Member Profile Updates](/bot/members-and-roster#member-profile-updates). +- **Guild League** — A signup type with its own command, auto-generated time slots, a public match browser, and standings. See [Guild League](/events/guild-league). +- **Ikusa** — An external logger whose exported log data GuildYapper can ingest as a score source, and whose captures feed the Guild League match browser and standings. See [Ikusa Scores](/features/scores#ikusa-scores). +- **Node War** — GuildYapper's primary Guild / Alliance event type, created with `/signup nodewar` and covered by its own attendance, waitlist, and platoon logic. See [Create A Node War Signup](/features/signups#create-a-node-war-signup). +- **PA** — A dynamic class type set through `/configure class`. Classes typed PA share a priority limit and are spread across split platoons rather than clustering together. See [Dynamic Class Types](/events/waitlist-and-priority#dynamic-class-types). +- **Platoon** — An in-game party. Both the bot and the website use "platoon" for this concept; the default platoon is always available and cannot be removed. See [Platoons and Function Roles](/events/platoons). +- **PvX** — A guild classification (alongside PVP) used to tag tracked guilds and filter Guild Tracker results. See [Guild Tracker](/features/guild-tracker). +- **RBF** — One of the PvP stream categories on the [Streams](/public/streams-and-tools#pvp-streams) page, alongside Nodewar/Siege, GvG, Guild League, and AOS. +- **Shai** — As a dynamic class type (`SHAI`) set through `/configure class`, distinct from playing the Shai character class itself; classes typed SHAI share a priority limit like PA and BSR. See [Dynamic Class Types](/events/waitlist-and-priority#dynamic-class-types). +- **Siege** — One of GuildYapper's five system [signup profiles](/events/event-types), used for Siege wars. +- **Signup profile** — A layout that decides which platoons and function roles are available on an event; each signup uses one. See [Event Types and Signup Profiles](/events/event-types). +- **Specialist** — In the Platoon Builder's composition summary, a member with a BSR, PA, or Shai dynamic class type. See [Reading The Composition](/events/platoon-builder#reading-the-composition). +- **Succession** — One of the three specs (with Awakening and Ascension) a class entry is placed under on the [Class Tierlist](/public/tierlists), and one of the two specs the [Class Popularity](/public/class-statistics) ranking splits classes into. +- **Visible attendance** — A signup's publicly shown attendance cap, used when it should differ from the internal maximum. See [Create A Node War Signup](/features/signups#create-a-node-war-signup). +- **War of the Roses** — One of GuildYapper's five system [signup profiles](/events/event-types), used for War of the Roses events. diff --git a/docs/scores/vod-reviews.md b/docs/scores/vod-reviews.md new file mode 100644 index 0000000..d969e67 --- /dev/null +++ b/docs/scores/vod-reviews.md @@ -0,0 +1,65 @@ +--- +description: Turn a YouTube or Twitch recording into a shared review workspace with timestamp notes and Ikusa context. +--- + +# VOD Reviews + +Uploading a recording and playing it back are free for everyone. Premium turns that recording into a shared review workspace: timestamped notes attributed to whoever left them, an overall written review, and Ikusa context synced to playback. + +
+ Submit a VOD +
+ +## Who Can Use It + +Any member can upload a VOD. Who can read and write review notes depends on the visibility level chosen, and the review layer itself needs Premium. + +## Uploading + +On the upload page, paste a YouTube, Twitch, or other HTTPS recording link, add an optional note, and choose a destination: + +| Destination | Use it for | +| --- | --- | +| My profile | Practice, GvG, or any recording without an event. Stays on your profile only. | +| A server | A recording the whole server should see. | +| This event | Ties the recording to one signup. | + +The upload page also shows counters for your uploaded VODs, when you last uploaded, and server VODs. + +### Where To Start + +- The upload page itself: [guildyapper.com/vod/submit](https://guildyapper.com/vod/submit). +- The **VODs** button on an event in the signups management view. +- **Submit VOD** on individual Guild League and Guild Wars matches. + +## Premium Review + +Premium adds a review layer on top of any uploaded VOD: + +- Notes anchored to an exact timestamp, attributed to the commenter's Discord name and avatar. +- An overall written review for the recording. +- Ikusa context synchronised with playback, bringing kills, deaths, classes, and map position into line with the video. + +
+ Screenshot placeholder + Add a screenshot of a VOD review in progress. + Suggested path: `/screenshots/premium/vod-review.webp` +
+ +## Who Can See What + +Each note or review sits at one of three visibility levels: + +- Officer-only. +- Visible to the uploader. +- Shared feedback on a public VOD link. + +## Common Issues + +### The VOD will not load + +The recording needs to be publicly accessible at its source (YouTube, Twitch, or wherever it's hosted), and the link must be HTTPS. + +### No note controls appear + +Without Premium, the review layer (timestamp notes, overall review, Ikusa alignment) does not appear. Upload and playback still work. diff --git a/docs/website/overview.md b/docs/website/overview.md deleted file mode 100644 index 43f74ab..0000000 --- a/docs/website/overview.md +++ /dev/null @@ -1,76 +0,0 @@ -# Website Overview - -The website is the larger dashboard side of GuildYapper. Discord is best for quick actions. The website is best when you need tables, filters, charts, score detail pages, or roster editing. - -
- Home - Profile - Signups - Roster - Scores Management - Personal Scores -
- -::: info Login -Pages that show your server, roster, profile, or management data require Discord login. Public pages such as tierlists, Guild Tracker, class stats, streams, and guild wars can be browsed without managing a server. -::: - -## Main Website Areas - -| Area | Link | What it is for | -| --- | --- | --- | -| Profile | [Open](https://guildyapper.com/profile) | Update your own family name, gear, class/spec, Garmoth link, and profile details. | -| Signups | [Open](https://guildyapper.com/management/signups) | Browse signups, open an event, manage attendance, assign parties, and review member details. | -| Roster | [Open](https://guildyapper.com/management/roster) | View and manage members, priorities, classes, parties, attendance summaries, and score snapshots. | -| Scores Management | [Open](https://guildyapper.com/management/scores) | Upload and manage Ikusa or BDO OCR score sessions for your server. | -| Personal Scores | [Open](https://guildyapper.com/scores) | Browse your own uploads, bookmarks, sessions, and personal stats. | -| Guild Tracker | [Open](https://guildyapper.com/guild-tracker/dashboard) | Browse tracked guilds, players, movement, and dashboard views. | -| Guild Wars | [Open](https://guildyapper.com/guildwars) | Browse upcoming and past ranked GvGs plus ranking views. | -| AOS Browser | [Open](https://guildyapper.com/wars/solare) | Browse Arena of Solare match scores and class/player stats. | -| Streams | [Open](https://guildyapper.com/wars/streams) | Find war-related streams. | -| Tierlists | [Open](https://guildyapper.com/tierlist) | Browse guild/alliance tierlists and update history. | -| Class Tierlist | [Open](https://guildyapper.com/class-tierlist) | Browse class/spec tierlist entries. | -| Class Popularity | [Open](https://guildyapper.com/class-statistics) | View class population and signup trends. | -| Class Performance | [Open](https://guildyapper.com/class-performance) | Compare class performance from score and combat data. | - -
- Screenshot placeholder - Add a screenshot of the website navigation. - Suggested path: `/screenshots/website/navigation.webp` -
- -## What Officers Usually Use - -1. [Signups](https://guildyapper.com/management/signups) to manage event attendance. -2. [Roster](https://guildyapper.com/management/roster) to review and edit member data. -3. [Scores Management](https://guildyapper.com/management/scores) to upload and correct war score sessions. -4. [Guild Tracker Dashboard](https://guildyapper.com/guild-tracker/dashboard) to watch tracked guild activity. -5. [Class Performance](https://guildyapper.com/class-performance) to compare class results across data sources. - -## What Members Usually Use - -1. [Profile](https://guildyapper.com/profile) to keep their own info current. -2. [Personal Scores](https://guildyapper.com/scores) to review uploads, bookmarks, and stats. -3. [Signups](https://guildyapper.com/management/signups) when officers want members to inspect event details on the website. - -::: tip Discord And Website Stay Connected -Signups created in Discord appear on the website. Website attendance and party edits can update the same signup data used by the bot. -::: - -## Common Issues - -### I cannot see my server - -Make sure you are logged in with the Discord account that is in the server and has the configured member role. - -### I can view but not edit - -Editing requires officer/admin privileges for that GuildYapper server. - -### My member data is outdated - -Update your profile on the website or use: - -```text -/member update -```