Leahnaya/sendou.ink
1
0
Fork 0
mirror of https://github.com/Sendouc/sendou.ink.git synced 2026-03-21 18:04:39 -05:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
7f9c9f25fb
sendou.ink/docs/badges.md
Kalle 7f9c9f25fb
Homemade badges (#1894) 
* Initial

* Author info

* Add docs
2024-09-29 13:49:27 +03:00

2.8 KiB
Raw Blame History

Badge guide

What are badges?

Badges are a virtual prize that users can win from tournaments and then display on their profile.

Current list of them can be seen here https://sendou.ink/badges

Rules

Any badge to be added has to follow these rules. Badges that do not follow the rules will not be added to the site or can be removed at any time:

Quality and consistency has to be matching those already on the site.

Uniqueness i.e. the added badge has to be different enough from those already on the site.

Variations for a maximum of 3 per unique design (e.g. 1st, 2nd & 3rd place variations). For further additions it has be a completely different and unique design and not just recolor or small design changes.

No AI every badge has to be made by a human.

Made for sendou.ink/approved usage badges have to be commissioned for this exact purpose or otherwise agreed with the person who made them so that they fully understand what they are used for.

As tournament prizes the badge are meant to be given out as tournament prizes (awarded for reaching certain placement). If you have any other idea in mind then you need to check that with Sendou separately.

Adding a new badge

  1. First badge needs to be made
  • 3D artists can use picoCAD
  • Others can use the "badges" Discord channel to inquire about a commission
  • Read rules from above carefully at this point and ask if you do not understand something
  1. Create needed files
  • .gif file, black solid background. Create via picoCAD Web Viewer
  • .png file. TODO: info on how to ceate
  • .avif file. Create via e.g. Squoosh from the .png file
  • All files should be squares. 512x512 is a good size for example
  1. Make a pull request to the project
  • You can request someone to help you on the "development" Discord channel
  • In the PR add the 3 needed files to public/static-assets/badges folder:

alt text

  • Also update app/features/badges/homemade.ts file (read the comments to understand each value):

alt text

  1. Wait for Sendou to look into the pull request
  • Sometimes this can take a while if Sendou is busy
  • Changes might be requested
  1. Wait for the site to be updated
  • After the pull request is merged it does not automatically go to the site yet
  • Normally the site updates a couple times a week, but this can vary
  1. Request permissions
  • After you see your badge on the /badges page you can request manager permissions to it on from the staff on the helpdesk channel
  1. Give out the badges to tournament winners
  • Badge can be given out via the /badges page

Updating a badge

Make a new pull request making the changes you need. The fileName should always remain the same.