User:Matrethewey!9776/Sprite Management System: Difference between revisions

From ALttPR Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
= Create Account =
= Create Account =
* {{checkbox}}Discord Username (<code>exampleusername#1234</code>)
* {{checkbox}} Discord Username (<code>exampleusername#1234</code>) ''- possible API with Discord at a later date''
* {{checkbox}}Password
* {{checkbox}} Password
* {{checkbox}}Email address
* {{checkbox}} Email address
** Account verification
** Account verification
** Admin communication if necessary
** Admin communication if necessary
* {{checkbox|no}}Role requested
* {{checkbox|no}} Role requested
** Testers Guild
** Testers Guild
** Sprite Submitter
** Sprite Submitter
** Sprite Tester
** Sprite Tester
* Default to Non-Approved
* {{checkbox|no}} Default to Non-Approved
* Non-Approved: Can't do shit
* {{checkbox}} Non-Approved: Can't access any part of the site
* Approved: Can perform authorized tasks
* {{checkbox}} Approved: Can perform authorized tasks


= Roles Hierarchy =
= Roles Hierarchy =
* {{checkbox}}<code>sprite-manager</code> ("Delegator", "Core Development Team") <code>-&gt;</code> Implemented as "Manager" role
* {{checkbox}} <code>sprite-manager</code> ("Delegator", "Core Development Team") ''- Implemented as "Manager" role ''
** {{checkbox|no}}<code>sprite-tester-guild</code> ("Guild Member", "Community Development Team")
** {{checkbox|no}} <code>sprite-tester-guild</code> ("Guild Member", "Community Development Team")
*** {{checkbox}}<code>sprite-tester</code> ("Tester") <code>-&gt;</code> Implemented as "Tester" role
*** {{checkbox}} <code>sprite-tester</code> ("Tester") ''- Implemented as "Tester" role''
*** {{checkbox}}<code>sprite-submitter</code> ("Artist") <code>-&gt;</code> Implemented as "Artist" role
*** {{checkbox}} <code>sprite-submitter</code> ("Artist") ''- Implemented as "Artist" role''
*** "Visitor" role: Can't do shit?
*** {{checkbox}} <code>visitor</code> ("Visitor") ''Can see sprites list/progress and submit requests.''  


<code>sprite-tester</code> & <code>sprite-submitter</code> are on the same level and a single user may have both roles.
<code>sprite-tester</code> & <code>sprite-submitter</code> are on the same level and a single user may have both roles. ''- Implemented as Tester higher than Artist''


A higher role assumes the rights of all lower roles.
A higher role assumes the rights of all lower roles.
Line 34: Line 34:
** {{checkbox}}Adjust account enabledness
** {{checkbox}}Adjust account enabledness
* Sprite Submission Management
* Sprite Submission Management
** Edit unique sprite filenames
** {{checkbox}}Edit unique sprite filenames
** Edit sprite submission
** {{checkbox}}Edit sprite submission
** Delete submission (mark as invalid in db but keep info for history purposes)
** Delete submission (mark as invalid in db but keep info for history purposes)
* Sprite Feedback Management
* Sprite Feedback Management
Line 42: Line 42:


= Sprite Submissions =
= Sprite Submissions =
* Log in, <code>sprite-submitter</code> role
* Log in, <code>sprite-submitter</code> role  
=== Submission Form ===
=== Submission Form ===
==== New Sprite Submission ====
==== New Sprite Submission ====
Line 50: Line 50:
** Sprite Author's Discord Username (<code>exampleusername#1234</code>) (auto-detect from user profile)
** Sprite Author's Discord Username (<code>exampleusername#1234</code>) (auto-detect from user profile)
==== Not-New Sprite Submission ====
==== Not-New Sprite Submission ====
# Select Sprite from existing list
# {{checkbox}} Select Sprite from existing list - ''Currently only available to author''
# Increment submission number
# {{checkbox}} Increment submission number - ''executed after submission''
# Display current sprite information
# {{checkbox}} Display current sprite information
#* Sprite Name
#* Sprite Name
#* Sprite Author
#* Sprite Author
Line 61: Line 61:
** Sprite Modifier's Discord Username (auto-detect from user profile)
** Sprite Modifier's Discord Username (auto-detect from user profile)
==== All Submissions ====
==== All Submissions ====
* Upload Form (only accepting <code>[https://docs.google.com/spreadsheets/d/1oNx8IvLcugva0lCqP_VfdalsUppuMiVyFjwBrSGCTiE .zspr]</code>)
* {{checkbox}} File Upload (only accepting <code>[https://docs.google.com/spreadsheets/d/1oNx8IvLcugva0lCqP_VfdalsUppuMiVyFjwBrSGCTiE .zspr]</code>)
* Source material URL/upload, if necessary
* {{checkbox|no}} Source material URL (optional) ''- Implemented as "Sprite References"''
* Category list (needs more brainstorming on how to do this)
* Category list (needs more brainstorming on how to do this)
* Generate filename; <code>sprite-name.vt-version.submission-version.zspr</code>
* {{checkbox}} Generate filename; <code>sprite-name.vt-version.submission-version.zspr</code> ''Implemented as URL safe filename, VT/Sub is appended on download''
** Where <code>sprite-name</code> is unique
** Where <code>sprite-name</code> is unique
*** If there's a collision, flag it for <code>sprite-manager</code> and slap a timestamp on the end for now to force it to be unique
*** If there's a collision, flag it for <code>sprite-manager</code> and slap a timestamp on the end for now to force it to be unique
** Where <code>vt-version</code> is the version currently on the site, <code>0</code> if brand new
** {{checkbox}} Where <code>vt-version</code> is the version currently on the site, <code>0</code> if brand new
** Where <code>submission-version</code> is the number of times this sprite has been submitted for this VT version
** {{checkbox}} Where <code>submission-version</code> is the number of times this sprite has been submitted for this VT version
==== Example ====
==== Example ====
* Cucco (as of VT Generator Version 29) is a brand new sprite
* Cucco (as of VT Generator Version 29) is a brand new sprite
Line 91: Line 91:
Would consist of: All-in-one Mighty, Ferelheart, Jighart, Nakuri, OrangeNova, Seraphin Eveles, SirCzah
Would consist of: All-in-one Mighty, Ferelheart, Jighart, Nakuri, OrangeNova, Seraphin Eveles, SirCzah


Sprite Checkout System
Sprite Checkout System - ''Implemented as "Evaluations"''
* Log in, <code>sprite-tester</code> role
* Log in, <code>sprite-tester</code> role
* Can see current list of sprites to be tested
* Can see current list of sprites to be tested

Revision as of 12:30, 26 June 2018

Create Account

  • Checkbox yes.gif Discord Username (exampleusername#1234) - possible API with Discord at a later date
  • Checkbox yes.gif Password
  • Checkbox yes.gif Email address
    • Account verification
    • Admin communication if necessary
  • Checkbox no.gif Role requested
    • Testers Guild
    • Sprite Submitter
    • Sprite Tester
  • Checkbox no.gif Default to Non-Approved
  • Checkbox yes.gif Non-Approved: Can't access any part of the site
  • Checkbox yes.gif Approved: Can perform authorized tasks

Roles Hierarchy

  • Checkbox yes.gif sprite-manager ("Delegator", "Core Development Team") - Implemented as "Manager" role
    • Checkbox no.gif sprite-tester-guild ("Guild Member", "Community Development Team")
      • Checkbox yes.gif sprite-tester ("Tester") - Implemented as "Tester" role
      • Checkbox yes.gif sprite-submitter ("Artist") - Implemented as "Artist" role
      • Checkbox yes.gif visitor ("Visitor") Can see sprites list/progress and submit requests.

sprite-tester & sprite-submitter are on the same level and a single user may have both roles. - Implemented as Tester higher than Artist

A higher role assumes the rights of all lower roles.

Blue & Green Names on ALttPR's Discord will probably be auto-added as sprite-tester-guild

Sprite Management Team

Consists of miketrethewey#9776R/C/SC/SM, ibazly#6484R/C/SC/SM, fish#2396R/C/SC/SM

  • Checkbox yes.gifLog in, sprite-manager role
  • Checkbox yes.gifUser Management
    • Approve accounts
    • Checkbox yes.gifAdjust roles
    • Checkbox yes.gifAdjust account enabledness
  • Sprite Submission Management
    • Checkbox yes.gifEdit unique sprite filenames
    • Checkbox yes.gifEdit sprite submission
    • Delete submission (mark as invalid in db but keep info for history purposes)
  • Sprite Feedback Management
    • Edit feedback
    • Delete feedback

Sprite Submissions

  • Log in, sprite-submitter role

Submission Form

New Sprite Submission

  • Submission #1
  • Sprite Name
  • Sprite Author (original creator of sprite file) (auto-detect from login)
    • Sprite Author's Discord Username (exampleusername#1234) (auto-detect from user profile)

Not-New Sprite Submission

  1. Checkbox yes.gif Select Sprite from existing list - Currently only available to author
  2. Checkbox yes.gif Increment submission number - executed after submission
  3. Checkbox yes.gif Display current sprite information
    • Sprite Name
    • Sprite Author
      • Sprite Author's Discord Username
    • VT Version
    • Submission Version
  • Sprite Modifier (if someone else is making a bugfix) (auto-detect from login)
    • Sprite Modifier's Discord Username (auto-detect from user profile)

All Submissions

  • Checkbox yes.gif File Upload (only accepting .zspr)
  • Checkbox no.gif Source material URL (optional) - Implemented as "Sprite References"
  • Category list (needs more brainstorming on how to do this)
  • Checkbox yes.gif Generate filename; sprite-name.vt-version.submission-version.zspr Implemented as URL safe filename, VT/Sub is appended on download
    • Where sprite-name is unique
      • If there's a collision, flag it for sprite-manager and slap a timestamp on the end for now to force it to be unique
    • Checkbox yes.gif Where vt-version is the version currently on the site, 0 if brand new
    • Checkbox yes.gif Where submission-version is the number of times this sprite has been submitted for this VT version

Example

  • Cucco (as of VT Generator Version 29) is a brand new sprite
    • The current Live filename doesn't exist
    • A submission for testing would result in a filename of cucco.0.1.zspr
    • A new one being cucco.1.zspr when submitted to VT
  • Mike Jones (as of VT Generator Version 29) has had two versions submitted to VT's site
    • The current Live filename is mikejones.2.zspr
    • A submission for testing would result in a filename of mikejones.2.1.zspr
    • A new one being mikejones.3.zspr when submitted to VT

Sprite Testers Guild

Would consist of: Achy, Beef-chan, EmoSaru, Espeon, Glan, PlaguedOne, TWRoxas

  • Log in, sprite-tester-guild role
  • Can manage Sprite Feedback
  • Can elevate to Sprite Management Team for preparation to send to VT
  • Can escalate issues to Sprite Management Team
  • View feedback history for each sprite

Sprite Testing

Would consist of: All-in-one Mighty, Ferelheart, Jighart, Nakuri, OrangeNova, Seraphin Eveles, SirCzah

Sprite Checkout System - Implemented as "Evaluations"

  • Log in, sprite-tester role
  • Can see current list of sprites to be tested
  • Can see how many tests have been submitted
  • Can download most up-to-date sprite version for testing following the file format above from submissions

Sprite Feedback

  • Log in, sprite-tester role

Feedback Form

  1. Select Sprite from existing list
  2. Display current sprite information
    • Sprite Name
    • Sprite Author
      • Sprite Author's Discord Username
    • Sprite Modifier
      • Sprite Modifier's Discord Username
    • VT Version
  3. Select Submission version number
  4. Provide Feedback
    • Tester Name (auto-detect from login)
      • Tester Discord Username (auto-detect from user profile)
    • Ok?
      • Y: Yes, I approve this sprite for submission to Sprite Management Team
      • N: No, I don't approve this sprite for submission to Sprite Management Team and will provide feedback to author/modifier
    • VOD Link, if provided
    • Feedback text

My Sprites

  • Checkbox yes.gifLog in, all users
  • Checkbox yes.gifShow list of sprites with viewer as author or modifier
  • Can access feedback for each of these sprites