cyberpresidentvanellope/Bubberstation
1
0
Fork 0
mirror of https://github.com/Bubberstation/Bubberstation.git synced 2026-08-28 15:47:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

[MIRROR] Updates Title Screen Instructions [MDB IGNORE] (#12107)

Browse Source 
* Updates Title Screen Instructions (#65233)

About The Pull Request

The instructions Found in the readme file for config directory loaded title screens has become out of date. The move to wide screen title cards invalidated the specification outlined in the readme. Also a section of the readme mentioned loading map names from .DM files. Those map names names were migrated to JSON files long ago and the documentation in the readme was never updated to reflect it.
Why It's Good For The Game

Correct documentation on title card specifications leads to more efficient work flows as les time is pent on correction.
Changelog

cl
qol: Updated Title Card Specifications
/cl

* Updates Title Screen Instructions

Co-authored-by: ORCACommander <orcacommander1@gmail.com>
This commit is contained in:
SkyratBot
2022-03-15 16:15:40 -07:00
committed by GitHub
co-authored by ORCACommander
parent 2d06bbaa97
commit f09f4e5771
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
config/title_screens/README.txt
+9 -6
View File
@@ -1,7 +1,10 @@
The enclosed /images folder holds the image files used as the title screen for the game. All common formats such as PNG, JPG, and GIF are supported.
Byond's DMI format is also supported, but if you use a DMI only include one image per file and do not give it an icon_state (the text label below the image).
The enclosed /images folder holds the image files used as the title screen for the game.
Specification:
Formats: PNG, JPG, GIF, DMI*
Dimensions: 608x480
*Byond's DMI format is also supported, but if you use a DMI only include one image per file and do not give it an icon_state (the text label below the image).
Keep in mind that the area a title screen fills is a 480px square so you should scale/crop source images to these dimensions first.
The game won't scale these images for you, so smaller images will not fill the screen and larger ones will be cut off.
Using unnecessarily huge images can cause client side lag and should be avoided. Extremely large GIFs should preferentially be converted to DMIs.
@@ -23,7 +26,7 @@ Common titles are in the rotation to be displayed all the time. Any name that do
An example of a common title name is "clown".
The common title screen named "default" is special. It is only used if no other titles are available. Because default only runs in the
The common title screen named "default" is special. It is only used if no other titles are available. Because default only runs in the
absence of other titles, if you want it to also appear in the general rotation you must name it something else.
@@ -31,7 +34,7 @@ Map Titles:
Map titles are tied to a specific in game map. To make a map title you format the name like this "(name of a map)+(name of your title)"
The spelling of the map name is important. It must match exactly the define MAP_NAME found in the relevant .DM file in the /_maps folder in
The spelling of the map name is important. It must match exactly the define MAP_NAME found in the relevant .JSON file in the /_maps folder in
the root directory. It can also be seen in game in the status menu. Note that there are no spaces between the two names.
It is absolutely fine to have more than one title tied to the same map.
@@ -44,4 +47,4 @@ Rare Titles:
Rare titles are a just for fun feature where they will only have a 1% chance of appear in in the title screen pool of a given round.
Add the phrase "rare+" to the beginning of the name. Again note there are no spaces. A title cannot be rare title and a map title at the same time.
An example of a rare title name is "rare+explosion"
An example of a rare title name is "rare+explosion"