Whiteout Survival Module

[TobiasGoetz]

Overview

This module extends the functionality of the Discord bot for the mobile game Whiteout Survival. It aims to enhance user experience by adding commands and features that allow for better management of game-related data and interactions within the Discord community. The module will include commands for managing city aliases, resource registration, verification processes, data linkage, and optional features for gift code redemption and event reminders. A new database will be designed to support these features, along with robust data structures to represent cities and players.

Functional Requirements

1. addAlias Command

• Description: Adds a new alias for a specific city.
• Command: !addAlias <city_id> <alias>
• Acceptance Criteria:
  • The command stores the alias in the database associated with the given city ID.
  • If the alias already exists, it should notify the user.

2. alias Command

• Description: Shows all aliases for a specific city.
• Command: !alias <city_id>
• Acceptance Criteria:
  • The command retrieves and displays all aliases for the specified city ID from the database.

3. svsResourceRegister Command

• Description: Registers resources for SVS.
• Command: !svsResourceRegister <city_id> <resource_type> <amount>
• Acceptance Criteria:
  • The command stores the resource information in the database associated with the given city ID.

4. verify Command

• Description: Allows R4 role to assign R1 role. The command verifies a city by linking it to a player.
• Command: !verify <city_id> <proprietary_player_id>
• Acceptance Criteria:
  • The command verifies the city by linking it with the proprietary player ID in the database.
  • The command assigns the R1 role to the verified city.

5. saveDiscordId Command

• Description: Links a Discord ID to a city ID.
• Command: !saveDiscordId <discord_id> <city_id>
• Acceptance Criteria:
  • The command stores the mapping of the Discord ID to the city ID in the database.

Optional Features

• Auto Redeemer for Gift Codes

  • Description: Automatically redeems gift codes.
  • Command: !autoRedeem <code>
  • Acceptance Criteria: The command redeems the code and notifies the user of the result.

• Event Reminder

  • Description: Sends reminders for events.
  • Command: !eventReminder <event_name> <time>
  • Acceptance Criteria: The command schedules a reminder for the specified event and notifies the user when the event is near.

6. createAlliance Command

• Description: Creates an alliance with mirrored ranks R1-R5. The creator is assigned R5.
• Command: !createAlliance <alliance_name>
• Acceptance Criteria:
  • The command creates a new alliance in the database.
  • The creator is assigned the R5 role.

7. verifyMember Command

• Description: Allows R4 in an alliance to verify members linking their Discord to the alliance.
• Command: !verifyMember <discord_id> <alliance_id>
• Acceptance Criteria:
  • The command links the specified Discord ID to the alliance in the database.

8. wosCopypastaSave Command

• Description: Saves a copypasta.
• Command: !wosCopypastaSave <copypasta_text>
• Acceptance Criteria:
  • The command stores the copypasta text in the database.

9. wosCopypastaGet Command

• Description: Retrieves a copypasta.
• Command: !wosCopypastaGet <copypasta_id>
• Acceptance Criteria:
  • The command retrieves and displays the specified copypasta from the database.

Data Structures

1. City Class

• Attributes:
  • city_id: Unique identifier for the city.
  • resource_report: Dictionary containing resource types and amounts.
  • alias_history: List of alias names.
  • player_id: ID of the player who runs the city.
  • additional_attributes: Other relevant attributes.

2. Player Class

• Attributes:
  • player_id: Unique identifier for the player.
  • city_ids: List of cities the player runs.
  • discord_id: Discord ID of the player.

Database Schema

Collections

• Cities

  • city_id: String
  • resource_report: Dictionary
  • alias_history: List
  • player_id: String
  • additional_attributes: Dictionary

• Players

  • player_id: String
  • city_ids: List of strings
  • discord_id: String

• Alliances

  • alliance_id: String
  • name: String
  • members: List of player IDs
  • ranks: Dictionary of roles and associated player IDs

• Copypastas

  • copypasta_id: String
  • text: String
  • created_by: Discord ID

[TobiasGoetz]

Ideas

• addAlias command storing new alias for a specific city
• alias command showing all alias for specific city
• svs resource register command
• verify command for R4 to assign R1 role, the command should take the city id of the city we want to verify and our proprietary player id which links all cities a player runs to the player
• save which discord id links to which city id
• (Optional) auto redeemer for gift codes
• (Optional) event reminder
• new database wos with collections for e.g. svs, general etc for alliances, also make alliances creatable with mirroring alliance ranks R1-R5 and creator being assigned R5. After that if you are R4 in an alliance you can verify members linking their discord to alliance
• Saving copy pastas via wos copypasta save xxx and getting them via a command too
• the data structure should include a city class which has the reported resources, alias name history, unique city ID, and maybe a few more relevant ones
• ability link multiple cities to show they are run by the same person
• a data structure player that includes which cities a player runs and also links the discord user to them
• [ ] promote, demote and kick command that takes targetrank and playerid if necesary
• [ ] log for each player with changes like date, event (promoted to rank x)