Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

register persistent entities #5

Open
6 tasks
juliarosechin opened this issue Oct 26, 2023 · 0 comments
Open
6 tasks

register persistent entities #5

juliarosechin opened this issue Oct 26, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@juliarosechin
Copy link
Contributor

Once we've determined a good data structure to store information relating to submarines, we need to implement the following:

Tasks

  • A command to register submarines (and airships?)
  • A command to get and set relevant info once the submarine is registered
  • Keep track of persistent timers for each submarine
    • We could let the user set individual timers as well to get pinged whenever they want, perhaps?
  • A command to set defaults for the register command (and other admin stuff)
  • A command to get an abbreviated status message of all subscribed submarines (how long until they return)
  • Add documentation for all new commands

Planning

When initially brainstorming, we came up with this idea for a JSON data structure for submarines. This way, any user can register an unlimited number of vehicles, if they own more than one FC, with having the notifications tied to the submarine role itself.

  • key: int (required)
    • Only create this if necessary? For the sake of a DB
    • This should be hidden from users by default, automatically generated
  • name: string (required)
  • return from voyage: unsigned int (required)
    • This will be the Unix timestamp), zero if not on a voyage
  • notes: string (optional)
  • subscribers: [int], unless it's too long -- then [string]
    • These are the people(s) to ping -- defaulting to just the person who sends the slash command
  • roles: [int], unless it's too long -- then [string]
    • These are the role(s) to ping, defaulting to none
  • channel: same as role, to bind submarine notification messages to a certain channel

For the future, we could also implement the following, once we try to integrate route finding and such.

  • parts: [string]
    • Each part can be stored as 2 chars, and there are 4 parts total -- maybe something else would be more optimal for this?
  • rank: int
  • rank progress: int
  • rank final exp (i guess?): int

New command names to implement:
TODO

@juliarosechin juliarosechin added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 26, 2023
@juliarosechin juliarosechin added this to the 1.0 Release milestone Oct 30, 2023
@juliarosechin juliarosechin self-assigned this Oct 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant