From ebd3c4e89ce369ccf9214ea97a82b4788a4d77f3 Mon Sep 17 00:00:00 2001 From: ELJAY <169303895+EL-JAYY@users.noreply.github.com> Date: Sat, 30 May 2026 23:02:30 +0200 Subject: [PATCH] Document signup profiles --- docs/bot/schedulers.md | 9 ++++--- docs/features/parties-and-waitlist.md | 36 ++++++++++++++++++++++++--- docs/features/signups.md | 22 ++++++++++++++++ docs/website/overview.md | 11 +++++--- 4 files changed, 68 insertions(+), 10 deletions(-) diff --git a/docs/bot/schedulers.md b/docs/bot/schedulers.md index 7b924fb..efc1e55 100644 --- a/docs/bot/schedulers.md +++ b/docs/bot/schedulers.md @@ -51,13 +51,16 @@ The automatic signup scheduler lets you pick: 2. Node War days. 3. Default attendance caps. 4. Optional visible caps. -5. Lead time before Node War. -6. Posting mode: per day or all at once. +5. Optional signup profiles for the posted signups. +6. Lead time before Node War. +7. Posting mode: per day or all at once. ::: tip Visible Caps Visible caps let the signup show a different public cap than the internal max attendance. Use this when officers want a cleaner number shown to members while still allowing controlled overflow. ::: +Signup profiles let scheduled Node War posts pick the party/function-role template for each day. Select one profile to reuse it for every configured day, or select profiles in the same order as your Node War days. + ## Closing Signups The close scheduler can: @@ -87,7 +90,7 @@ That scheduler requires Premium. Check: ### A scheduler did not post -Check the selected channels, selected days, server region/time zone, and whether the signup channel still exists. +Check the selected channels, selected days, selected signup profile, server region/time zone, and whether the signup channel still exists. ### Members did not get DMs diff --git a/docs/features/parties-and-waitlist.md b/docs/features/parties-and-waitlist.md index 271a96e..14bcff6 100644 --- a/docs/features/parties-and-waitlist.md +++ b/docs/features/parties-and-waitlist.md @@ -12,9 +12,10 @@ Parties and waitlists decide how a full signup becomes an actual plan. GuildYapp ## What It Does - Creates and configures Node War parties such as Main, Defense, Flex, or custom groups. -- Assigns members to configured parties. +- Assigns members to configured parties globally or per signup profile. +- Adds function roles such as Elephant rider, Shotcaller, or BSR Target to signup displays and priority logic. - Splits oversized parties into sub-parties. -- Uses class, party, individual, and waitlist-streak priority when configured. +- Uses class, party, function-role, 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. @@ -26,7 +27,7 @@ Officers/admins configure parties and waitlist behavior. Members see the resulti - Guild / Alliance server type. - Officer/admin role. -- Node War parties configured through `/configure nwparty`. +- Node War parties configured through `/configure nwparty` or Website Signup Profiles. - Optional class priorities through `/configure class`. - Optional member overrides through `/configure member`. @@ -55,6 +56,34 @@ Every signup has a Main/default party. Guild / Alliance setup also creates start A member's effective priority can include personal priority, class priority, party priority, and waitlist-streak priority. ::: +## Signup Profiles + +Signup profiles are templates for which parties and function roles are active on a signup. New servers receive default profiles for Construction Nodewar, Occupation Nodewar, Siege, Blue Battlefield, and War of the Roses. Existing parties are enabled on every default profile during migration, so older signup behavior continues until officers customize profiles. + +Profiles can be selected when creating Node War signups and automatic scheduled Node War signups. Custom signups can also use profiles when parties are enabled for that custom event. GvG and Guild League signups do not use signup profiles. + +Use [Website Signup Profiles](https://guildyapper.com/management/signup-profiles) to: + +- Enable or disable profiles. +- Choose which parties/platoons are active per profile. +- Choose which function roles are active per profile. +- Assign a member to different parties per profile, such as Flex for Construction and Main for Occupation. +- Assign profile-specific function roles to members. + +## Function Roles + +Function roles are signup planning labels, not Discord roles. They can show an emoji beside a member in signup views and can add priority in custom-priority waitlist mode. + +Default function roles are: + +| Role | Default emoji | +| --- | --- | +| Elephant rider | Elephant | +| Shotcaller | Announcement | +| BSR Target | Red circle | + +Each function role can have priority, priority limit rate, and reduced priority on limit. Use these the same way you use party priority limits when too many members with the same role are already attending. + ## Overflow Types | Overflow type | Behavior | @@ -91,6 +120,7 @@ The website party builder and Discord management actions can handle two kinds of | --- | --- | | 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. | +| Profile assignment | You want this member's default party changed only for one signup profile. |
Screenshot placeholder diff --git a/docs/features/signups.md b/docs/features/signups.md index cc20b87..4c447e7 100644 --- a/docs/features/signups.md +++ b/docs/features/signups.md @@ -15,6 +15,7 @@ Signups are the core event flow for Guild / Alliance servers. They let officers - Tracks attendance states such as Can, Waiting, Undecided, Can't, Vacation, and No Show. - Lets officers update caps, details, participants, results, and charts. - Supports waitlists and automatic move-ins based on server rules. +- Supports signup profiles for Node War and custom events with parties enabled. - Connects event attendance to website management and score sessions. ## Who Can Use It @@ -47,6 +48,7 @@ Node War signup options include: | `info` | No | Extra details shown on the signup. | | `skip-streak` | No | Excludes this signup from waitlist-streak/fair-mode logic. | | `role` | No | Role to mention when posting. | +| `profile` | No | Signup profile used for party and function-role templates. | ::: tip Visible Attendance Use visible attendance when your internal cap and public-facing target are different. For example, you may internally allow overflow while showing a cleaner target to members. @@ -89,6 +91,24 @@ Use custom signups for practice, training, meetings, or other events that still Custom and GvG signups can use a custom party size. If no custom size is set, GuildYapper uses normal signup behavior. ::: +Custom signups can use a signup profile when parties are enabled for that custom event. GvG and Guild League signups ignore signup profiles. + +## Signup Profiles + +Signup profiles decide which parties/platoons and function roles apply to a signup. They also let officers give members different default assignments per event type. + +Default profiles are created automatically: + +- Construction Nodewar +- Occupation Nodewar +- Siege +- Blue Battlefield +- War of the Roses + +Profiles are optional. Existing Node War signups keep working with the default profile, and existing parties are enabled on all default profiles after migration. + +Officers can manage profiles on [Website Signup Profiles](https://guildyapper.com/management/signup-profiles). The page controls active parties, function roles, profile-specific member party assignments, and profile-specific member function roles. + ## Attendance States | State | Meaning | @@ -136,6 +156,8 @@ Common management actions include: 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. +Use [Website Signup Profiles](https://guildyapper.com/management/signup-profiles) when you want to change the templates that future signups use. +
Screenshot placeholder Add a screenshot of the website signup detail view. diff --git a/docs/website/overview.md b/docs/website/overview.md index 43f74ab..e3e313e 100644 --- a/docs/website/overview.md +++ b/docs/website/overview.md @@ -6,6 +6,7 @@ The website is the larger dashboard side of GuildYapper. Discord is best for qui Home Profile Signups + Signup Profiles Roster Scores Management Personal Scores @@ -21,6 +22,7 @@ Pages that show your server, roster, profile, or management data require Discord | --- | --- | --- | | 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. | +| Signup Profiles | [Open](https://guildyapper.com/management/signup-profiles) | Configure signup profile templates, active parties, function roles, and per-profile member assignments. | | 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. | @@ -42,10 +44,11 @@ Pages that show your server, roster, profile, or management data require Discord ## 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. +2. [Signup Profiles](https://guildyapper.com/management/signup-profiles) to manage party and function-role templates. +3. [Roster](https://guildyapper.com/management/roster) to review and edit member data. +4. [Scores Management](https://guildyapper.com/management/scores) to upload and correct war score sessions. +5. [Guild Tracker Dashboard](https://guildyapper.com/guild-tracker/dashboard) to watch tracked guild activity. +6. [Class Performance](https://guildyapper.com/class-performance) to compare class results across data sources. ## What Members Usually Use