Skip to content

Commit

Permalink
restores the /images and /sounds folders to the three related config …
Browse files Browse the repository at this point in the history
…folders for title screen, title music, and jukeboxes. (tgstation#43836)

Updates readme files as needed.
Updates file reading mechanisms as needed.
  • Loading branch information
Incoming5643 authored and optimumtact committed May 11, 2019
1 parent 3a3b036 commit bf6206d
Show file tree
Hide file tree
Showing 9 changed files with 54 additions and 53 deletions.
2 changes: 2 additions & 0 deletions code/controllers/subsystem/ticker.dm
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ SUBSYSTEM_DEF(ticker)
if((use_rare_music && L[1] == "rare") || (L[1] == SSmapping.config.map_name))
music += S
if(1) //sound.ogg -- common sound
if(L[1] == "exclude")
continue
music += S

var/old_login_music = trim(file2text("data/last_round_lobby_music.txt"))
Expand Down
2 changes: 1 addition & 1 deletion code/controllers/subsystem/title.dm
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ SUBSYSTEM_DEF(title)
SSmapping.HACK_LoadMapConfig()
for(var/S in provisional_title_screens)
var/list/L = splittext(S,"+")
if((L.len == 1 && L[1] != "blank.png")|| (L.len > 1 && ((use_rare_screens && lowertext(L[1]) == "rare") || (lowertext(L[1]) == lowertext(SSmapping.config.map_name)))))
if((L.len > 1 && ((use_rare_screens && lowertext(L[1]) == "rare") || (lowertext(L[1]) == lowertext(SSmapping.config.map_name)))))
title_screens += S

if(length(title_screens))
Expand Down
2 changes: 2 additions & 0 deletions code/game/machinery/dance_machine.dm
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@
var/datum/track/T = new()
T.song_path = file("config/jukebox_music/sounds/[S]")
var/list/L = splittext(S,"+")
if(L.len != 3)
continue
T.song_name = L[1]
T.song_length = text2num(L[2])
T.song_beat = text2num(L[3])
Expand Down
4 changes: 2 additions & 2 deletions config/jukebox_music/README.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
The enclosed sounds folder holds the sound files used as player selectable songs for an ingame jukebox. OGG and WAV are supported.
The enclosed /sounds folder holds the sound files used for player selectable songs for an ingame jukebox. OGG and WAV are supported.

Using unnecessarily huge sounds can cause client side lag and should be avoided.

You my add as many sounds as you would like.
You may add as many sounds as you would like.

---

Expand Down
Empty file.
2 changes: 1 addition & 1 deletion config/title_music/README.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The enclosed sounds folder holds the sound files used as the title music for the game. OGG and WAV are supported.
The enclosed /sounds folder holds the sound files used as the title music for the game. OGG and WAV are supported.

Using unnecessarily huge sounds can cause client side lag and should be avoided.

Expand Down
Empty file.
95 changes: 46 additions & 49 deletions config/title_screens/README.txt
Original file line number Diff line number Diff line change
@@ -1,50 +1,47 @@
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.

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. 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.


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"
Empty file.

0 comments on commit bf6206d

Please sign in to comment.