mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-16 16:47:32 +01:00
Tigercat2000
756de5a716
This adjusts our titlescreen system to allow for hosting title screens seperately from the codebase, for licensing reasons and other. It supports both per-map title screens and "rare" screens, which are both done by parsing in the form of naming the file. Usage is covered in config/title_screens/README.txt, to summarize: - All title screens must have unique names. These can be anything, so long as they do not use the + or . characters. Example: NewLobby.png, DeadCats.jpg. - Any format BYOND can read is supported, the file extension doesn't really matter; Only exception is that .dmi files must only have *one* state, and it must not have a name. - Map-specific title screens are parsed by adding the MAP_NAME to the start of the image. Example: MetaStation+NewLobby.png, Cyberiad+NewLobby.png - I changed the MAP_NAME of the NSS Cyberiad from NSS Cyberiad to Cyberiad for this reason, to avoid any compatibility issues between filesystems. - Rare title screens can be made by using the format rare+name.ext. Example: rare+NyanCat.gif, rare+Mrowl.dmi - You cannot use both map-specific and rare modifiers at the same time to reduce parsing complexity.
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). 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. Placing non-image files in the images folder can cause errors. You may add as many title screens as you like, if there is more than one a random screen is chosen (see name conventions for specifics). --- Naming Conventions: Every title screen you add must have a unique name. It is allowed to name two things the same if they have different file types, but this should be discouraged. Avoid using the plus sign "+" and the period "." in names, as these are used internally to classify images. Common Titles: Common titles are in the rotation to be displayed all the time. Any name that does not include the character "+" is considered a common title. 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. You can overwrite "default" safely, but you should have a title named "default" somewhere in your DMI file if you don't have any other common titles. Because default only runs in the absence of other titles, if you want it to also appear in the general rotation you must rename it. The common title screen named "blank.png" is also special. It is only used to fill space while the real title screen loads. You should leave this file alone. 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 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. An example of a map title name is "Omegastation+splash". 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"