diff --git a/example_asymmetrical/properties.txt b/example_asymmetrical/properties.txt index 29982dc64b93d767e0404b3330c545105174164b..4d203e456ef8f10ef1c281c6c693abaac32509b4 100644 --- a/example_asymmetrical/properties.txt +++ b/example_asymmetrical/properties.txt @@ -3,50 +3,50 @@ 115, 115, 255, 82, 82, 255 ], - "transparent_colors_description": "The above colors will be made transparent upon processing the template image for sprite conversion. You can add up to 4 colors to be set to transparent.", + "transparent_colors_explanation": "The above colors will be made transparent upon processing the template image for sprite conversion. You can add up to 4 colors to be set to transparent.", "name": "example", - "name_description": "The name of your follower. The names of followers appear on the main menu, upon toggling \"extrainfo mode\" with the drift button.", + "name_explanation": "The name of your follower. The names of followers appear on the main menu, upon toggling \"extrainfo mode\" with the drift button.", "prefix": "EXMP", - "prefix_description": "A set of 4 characters used to internally identify your follower, mainly used for its files.", + "prefix_explanation": "A set of 4 characters used to internally identify your follower, mainly used for its files.", "category": "Fanworks", - "category_description": "The category your follower will appear under. Followermaker doesn't allow for the creation of custom categories, though you can still enter one.", + "category_explanation": "The category your follower will appear under. Followermaker doesn't allow for the creation of custom categories, though you can still enter one.", "prefcolor": "red", - "prefcolor_description": "Default follower color. Must use the name of a spray can, as seen on the main menu in extrainfo mode.", + "prefcolor_explanation": "Default follower color. Must use the name of a spray can, as seen on the main menu in extrainfo mode.", "mode": 0, - "mode_description": "If floating (0) or on the ground (1).", + "mode_explanation": "If floating (0) or on the ground (1).", "scale": 1, - "scale_description": "(in Fracunits) Scale relative to the player's.", + "scale_explanation": "(in Fracunits) Scale relative to the player's.", "bubblescale": 0, - "bubblescale_description": "(in Fracunits) Bubble scale relative to the player scale. If not set, no bubble will spawn.", + "bubblescale_explanation": "(in Fracunits) Bubble scale relative to the player scale. If not set, no bubble will spawn.", "atangle": 230, - "atangle_description": "Angle the follower will be at around the player. The follower will always face the same direction as the player.", + "atangle_explanation": "Angle the follower will be at around the player. The follower will always face the same direction as the player.", "distance": 40, - "distance_description": "(in Fracunits) Distance relative to the player (in a circle).", + "distance_explanation": "(in Fracunits) Distance relative to the player (in a circle).", "height": 32, - "height_description": "(in Fracunits) Height of the follower, this is mostly important for Z-flipping.", + "height_explanation": "(in Fracunits) Height of the follower, this is mostly important for Z-flipping.", "zoffs": 32, - "zoffs_description": "(in Fracunits) Z-offset relative to the player's height. Cannot be negative.", + "zoffs_explanation": "(in Fracunits) Z-offset relative to the player's height. Cannot be negative.", "horzlag": 3, - "horzlag_description": "(in Fracunits) Lag for X/Y displacement. Must be > 0 because we divide by this number.", + "horzlag_explanation": "(in Fracunits) Lag for X/Y displacement. Must be > 0 because we divide by this number.", "vertlag": 6, - "verlag_description": "(in Fracunits) Lag for Z displacement. Must be > 0 because we divide by this number.", + "verlag_explanation": "(in Fracunits) Lag for Z displacement. Must be > 0 because we divide by this number.", "anglelag": 8, - "anglelag_description": "(in Fracunits) Angle rotation lag. Must be > 0 because we divide by this number.", + "anglelag_explanation": "(in Fracunits) Angle rotation lag. Must be > 0 because we divide by this number.", "bobamp": 4, - "bobamp_description": "(in Fracunits) Bob amplitude.", + "bobamp_explanation": "(in Fracunits) Bob amplitude.", "bobspeed": 70, - "bobspeed_description": "(in Tics) Arbitrary modifier for bobbing speed. Default is TICRATE*2 (70 Fracunits)", + "bobspeed_explanation": "(in Tics) Arbitrary modifier for bobbing speed. Default is TICRATE*2 (70 Fracunits)", "hitconfirmtime": 1, - "hitconfirmtime_description": "(in Tics) Time to keep the hit confirm state playing for.", + "hitconfirmtime_explanation": "(in Tics) Time to keep the hit confirm state playing for.", - "follower_states_help": "As you may know, followers have several animations for things that can occur during the race; these are described as \"states\". Followers can have up to 6 states, in order: an idle state, a following state (as in, following the player), a hurt state (when you get hit by an item), a lose state (when you lose the race), a win state (win the race), and a \"hit confirm\" state (occurs when you hit another racer with an item). Of these, the idle state is obligatory in all followers. Additionally, the duration of the hit confirm state is controlled by a variable which can be edited above.", + "follower_states_help": "As you may know, followers have several animations for things that can occur during the race; these are described as \"states\". Followers can have up to 6 states, in order: an idle state, a following state (as in, following the player), a hurt state (when you get hit by an item), a lose state (when you lose the race), a win state (win the race), and a \"hit confirm\" state (occurs when you hit another racer with an item). Of these, the idle state is obligatory in all followers. Additionally, the duration of the hit confirm state is controlled by a variable which can be edited above. You can add or remove follower states, though they all must follow the same hierarchy mentioned beforehand.", "sprite_help": "The template is divided into several regions, each for a unique sprite, described by the below values. These sprite regions are each categorized according to the follower state in which they belong, and are further split into frames detailing both the rotation angle (indicated by numbers) and animation index (indicated by letters) of the follower. The \"sprite_size\" field determines the general size for each sprite region. \"Layers\" refers to the exact location of each sprite, with \"layer_step_size\" indicating how many pixels are stepped over for the position of the layer; layers also allow for literal layer functionality, allowing you to insert up to four sets of sprite locations, with the first sprite location being applied on top of following locations. You can also edit the offset of sprites, with the default templates providing automatic X axis centering for sprites, offset 16 pixels down on the Y axis.", - "template_description": "This specific template is designed for a follower of asymmetrical appearance, allowing for 8 unique degrees of rotation, with a 2-frame animation.", + "template_explanation": "This specific template is designed for a follower of asymmetrical appearance, allowing for 8 unique degrees of rotation, with a 2-frame animation.", "sprite_size": [128, 128], "layer_step_size": [128, 128], diff --git a/example_symmetrical_2states/properties.txt b/example_symmetrical_2states/properties.txt index 9839d74172e213c3b48a9991fa02065fcfd4863f..d8794f9e1a68afd224747bf86b727d01302f2ca8 100644 --- a/example_symmetrical_2states/properties.txt +++ b/example_symmetrical_2states/properties.txt @@ -3,50 +3,50 @@ 115, 115, 255, 82, 82, 255 ], - "transparent_colors_description": "The above colors will be made transparent upon processing the template image for sprite conversion. You can add up to 4 colors to be set to transparent.", + "transparent_colors_explanation": "The above colors will be made transparent upon processing the template image for sprite conversion. You can add up to 4 colors to be set to transparent.", "name": "example", - "name_description": "The name of your follower. The names of followers appear on the main menu, upon toggling \"extrainfo mode\" with the drift button.", + "name_explanation": "The name of your follower. The names of followers appear on the main menu, upon toggling \"extrainfo mode\" with the drift button.", "prefix": "EXMP", - "prefix_description": "A set of 4 characters used to internally identify your follower, mainly used for its files.", + "prefix_explanation": "A set of 4 characters used to internally identify your follower, mainly used for its files.", "category": "Fanworks", - "category_description": "The category your follower will appear under. Followermaker doesn't allow for the creation of custom categories, though you can still enter one.", + "category_explanation": "The category your follower will appear under. Followermaker doesn't allow for the creation of custom categories, though you can still enter one.", "prefcolor": "red", - "prefcolor_description": "Default follower color. Must use the name of a spray can, as seen on the main menu in extrainfo mode.", + "prefcolor_explanation": "Default follower color. Must use the name of a spray can, as seen on the main menu in extrainfo mode.", "mode": 0, - "mode_description": "If floating (0) or on the ground (1).", + "mode_explanation": "If floating (0) or on the ground (1).", "scale": 1, - "scale_description": "(in Fracunits) Scale relative to the player's.", + "scale_explanation": "(in Fracunits) Scale relative to the player's.", "bubblescale": 0, - "bubblescale_description": "(in Fracunits) Bubble scale relative to the player scale. If not set, no bubble will spawn.", + "bubblescale_explanation": "(in Fracunits) Bubble scale relative to the player scale. If not set, no bubble will spawn.", "atangle": 230, - "atangle_description": "Angle the follower will be at around the player. The follower will always face the same direction as the player.", + "atangle_explanation": "Angle the follower will be at around the player. The follower will always face the same direction as the player.", "distance": 40, - "distance_description": "(in Fracunits) Distance relative to the player (in a circle).", + "distance_explanation": "(in Fracunits) Distance relative to the player (in a circle).", "height": 32, - "height_description": "(in Fracunits) Height of the follower, this is mostly important for Z-flipping.", + "height_explanation": "(in Fracunits) Height of the follower, this is mostly important for Z-flipping.", "zoffs": 32, - "zoffs_description": "(in Fracunits) Z-offset relative to the player's height. Cannot be negative.", + "zoffs_explanation": "(in Fracunits) Z-offset relative to the player's height. Cannot be negative.", "horzlag": 3, - "horzlag_description": "(in Fracunits) Lag for X/Y displacement. Must be > 0 because we divide by this number.", + "horzlag_explanation": "(in Fracunits) Lag for X/Y displacement. Must be > 0 because we divide by this number.", "vertlag": 6, - "verlag_description": "(in Fracunits) Lag for Z displacement. Must be > 0 because we divide by this number.", + "verlag_explanation": "(in Fracunits) Lag for Z displacement. Must be > 0 because we divide by this number.", "anglelag": 8, - "anglelag_description": "(in Fracunits) Angle rotation lag. Must be > 0 because we divide by this number.", + "anglelag_explanation": "(in Fracunits) Angle rotation lag. Must be > 0 because we divide by this number.", "bobamp": 4, - "bobamp_description": "(in Fracunits) Bob amplitude.", + "bobamp_explanation": "(in Fracunits) Bob amplitude.", "bobspeed": 70, - "bobspeed_description": "(in Tics) Arbitrary modifier for bobbing speed. Default is TICRATE*2 (70 Fracunits)", + "bobspeed_explanation": "(in Tics) Arbitrary modifier for bobbing speed. Default is TICRATE*2 (70 Fracunits)", "hitconfirmtime": 1, - "hitconfirmtime_description": "(in Tics) Time to keep the hit confirm state playing for.", + "hitconfirmtime_explanation": "(in Tics) Time to keep the hit confirm state playing for.", - "follower_states_help": "As you may know, followers have several animations for things that can occur during the race; these are described as \"states\". Followers can have up to 6 states, in order: an idle state, a following state (as in, following the player), a hurt state (when you get hit by an item), a lose state (when you lose the race), a win state (win the race), and a \"hit confirm\" state (occurs when you hit another racer with an item). Of these, the idle state is obligatory in all followers. Additionally, the duration of the hit confirm state is controlled by a variable which can be edited above.", + "follower_states_help": "As you may know, followers have several animations for things that can occur during the race; these are described as \"states\". Followers can have up to 6 states, in order: an idle state, a following state (as in, following the player), a hurt state (when you get hit by an item), a lose state (when you lose the race), a win state (win the race), and a \"hit confirm\" state (occurs when you hit another racer with an item). Of these, the idle state is obligatory in all followers. Additionally, the duration of the hit confirm state is controlled by a variable which can be edited above. You can add or remove follower states, though they all must follow the same hierarchy mentioned beforehand.", "sprite_help": "The template is divided into several regions, each for a unique sprite, described by the below values. These sprite regions are each categorized according to the follower state in which they belong, and are further split into frames detailing both the rotation angle (indicated by numbers) and animation index (indicated by letters) of the follower. The \"sprite_size\" field determines the general size for each sprite region. \"Layers\" refers to the exact location of each sprite, with \"layer_step_size\" indicating how many pixels are stepped over for the position of the layer; layers also allow for literal layer functionality, allowing you to insert up to four sets of sprite locations, with the first sprite location being applied on top of following locations. You can also edit the offset of sprites, with the default templates providing automatic X axis centering for sprites, offset 16 pixels down on the Y axis.", - "template_description": "This specific template is designed for followers with an idle and following state, with 2-frame animations for each state and 5 unique degrees of rotation. The second, third, and fourth rotation sprites are duplicated and mirrored, thus this template assumes a follower of symmetrical appearance.", + "template_explanation": "This specific template is designed for followers with an idle and following state, with 2-frame animations for each state and 5 unique degrees of rotation. The second, third, and fourth rotation sprites are duplicated and mirrored, thus this template assumes a follower of symmetrical appearance.", "sprite_size": [128, 128], "layer_step_size": [128, 128], diff --git a/example_symmetrical_6states/properties.txt b/example_symmetrical_6states/properties.txt index b91ffc414e3f78a0d58b163ab1d4ca1bd176ee7b..672f44e2ee49ac304aee5f4e12643fe1c21560a6 100644 --- a/example_symmetrical_6states/properties.txt +++ b/example_symmetrical_6states/properties.txt @@ -3,50 +3,50 @@ 115, 115, 255, 82, 82, 255 ], - "transparent_colors_description": "The above colors will be made transparent upon processing the template image for sprite conversion. You can add up to 4 colors to be set to transparent.", + "transparent_colors_explanation": "The above colors will be made transparent upon processing the template image for sprite conversion. You can add up to 4 colors to be set to transparent.", "name": "example", - "name_description": "The name of your follower. The names of followers appear on the main menu, upon toggling \"extrainfo mode\" with the drift button.", + "name_explanation": "The name of your follower. The names of followers appear on the main menu, upon toggling \"extrainfo mode\" with the drift button.", "prefix": "EXMP", - "prefix_description": "A set of 4 characters used to internally identify your follower, mainly used for its files.", + "prefix_explanation": "A set of 4 characters used to internally identify your follower, mainly used for its files.", "category": "Fanworks", - "category_description": "The category your follower will appear under. Followermaker doesn't allow for the creation of custom categories, though you can still enter one.", + "category_explanation": "The category your follower will appear under. Followermaker doesn't allow for the creation of custom categories, though you can still enter one.", "prefcolor": "red", - "prefcolor_description": "Default follower color. Must use the name of a spray can, as seen on the main menu in extrainfo mode.", + "prefcolor_explanation": "Default follower color. Must use the name of a spray can, as seen on the main menu in extrainfo mode.", "mode": 0, - "mode_description": "If floating (0) or on the ground (1).", + "mode_explanation": "If floating (0) or on the ground (1).", "scale": 1, - "scale_description": "(in Fracunits) Scale relative to the player's.", + "scale_explanation": "(in Fracunits) Scale relative to the player's.", "bubblescale": 0, - "bubblescale_description": "(in Fracunits) Bubble scale relative to the player scale. If not set, no bubble will spawn.", + "bubblescale_explanation": "(in Fracunits) Bubble scale relative to the player scale. If not set, no bubble will spawn.", "atangle": 230, - "atangle_description": "Angle the follower will be at around the player. The follower will always face the same direction as the player.", + "atangle_explanation": "Angle the follower will be at around the player. The follower will always face the same direction as the player.", "distance": 40, - "distance_description": "(in Fracunits) Distance relative to the player (in a circle).", + "distance_explanation": "(in Fracunits) Distance relative to the player (in a circle).", "height": 32, - "height_description": "(in Fracunits) Height of the follower, this is mostly important for Z-flipping.", + "height_explanation": "(in Fracunits) Height of the follower, this is mostly important for Z-flipping.", "zoffs": 32, - "zoffs_description": "(in Fracunits) Z-offset relative to the player's height. Cannot be negative.", + "zoffs_explanation": "(in Fracunits) Z-offset relative to the player's height. Cannot be negative.", "horzlag": 3, - "horzlag_description": "(in Fracunits) Lag for X/Y displacement. Must be > 0 because we divide by this number.", + "horzlag_explanation": "(in Fracunits) Lag for X/Y displacement. Must be > 0 because we divide by this number.", "vertlag": 6, - "verlag_description": "(in Fracunits) Lag for Z displacement. Must be > 0 because we divide by this number.", + "verlag_explanation": "(in Fracunits) Lag for Z displacement. Must be > 0 because we divide by this number.", "anglelag": 8, - "anglelag_description": "(in Fracunits) Angle rotation lag. Must be > 0 because we divide by this number.", + "anglelag_explanation": "(in Fracunits) Angle rotation lag. Must be > 0 because we divide by this number.", "bobamp": 4, - "bobamp_description": "(in Fracunits) Bob amplitude.", + "bobamp_explanation": "(in Fracunits) Bob amplitude.", "bobspeed": 70, - "bobspeed_description": "(in Tics) Arbitrary modifier for bobbing speed. Default is TICRATE*2 (70 Fracunits)", + "bobspeed_explanation": "(in Tics) Arbitrary modifier for bobbing speed. Default is TICRATE*2 (70 Fracunits)", "hitconfirmtime": 1, - "hitconfirmtime_description": "(in Tics) Time to keep the hit confirm state playing for.", + "hitconfirmtime_explanation": "(in Tics) Time to keep the hit confirm state playing for.", - "follower_states_help": "As you may know, followers have several animations for things that can occur during the race; these are described as \"states\". Followers can have up to 6 states, in order: an idle state, a following state (as in, following the player), a hurt state (when you get hit by an item), a lose state (when you lose the race), a win state (win the race), and a \"hit confirm\" state (occurs when you hit another racer with an item). Of these, the idle state is obligatory in all followers. Additionally, the duration of the hit confirm state is controlled by a variable which can be edited above.", + "follower_states_help": "As you may know, followers have several animations for things that can occur during the race; these are described as \"states\". Followers can have up to 6 states, in order: an idle state, a following state (as in, following the player), a hurt state (when you get hit by an item), a lose state (when you lose the race), a win state (win the race), and a \"hit confirm\" state (occurs when you hit another racer with an item). Of these, the idle state is obligatory in all followers. Additionally, the duration of the hit confirm state is controlled by a variable which can be edited above. You can add or remove follower states, though they all must follow the same hierarchy mentioned beforehand.", "sprite_help": "The template is divided into several regions, each for a unique sprite, described by the below values. These sprite regions are each categorized according to the follower state in which they belong, and are further split into frames detailing both the rotation angle (indicated by numbers) and animation index (indicated by letters) of the follower. The \"sprite_size\" field determines the general size for each sprite region. \"Layers\" refers to the exact location of each sprite, with \"layer_step_size\" indicating how many pixels are stepped over for the position of the layer; layers also allow for literal layer functionality, allowing you to insert up to four sets of sprite locations, with the first sprite location being applied on top of following locations. You can also edit the offset of sprites, with the default templates providing automatic X axis centering for sprites, offset 16 pixels down on the Y axis.", - "template_description": "This specific template is designed for followers with all six states a follower can have, each having 2-frame animations and 5 unique degrees of rotation. The second, third, and fourth rotation sprites are duplicated and mirrored, thus this template assumes a follower of symmetrical appearance.", + "template_explanation": "This specific template is designed for followers with all six states a follower can have, each having 2-frame animations and 5 unique degrees of rotation. The second, third, and fourth rotation sprites are duplicated and mirrored, thus this template assumes a follower of symmetrical appearance.", "sprite_size": [128, 128], "layer_step_size": [128, 128], diff --git a/readme.txt b/readme.txt index 245fabcc64701160229ef8b5f22aa039afb7e42c..7ac4c8e80339c9670da3508b94d6a9b8229fee54 100644 --- a/readme.txt +++ b/readme.txt @@ -4,6 +4,7 @@ HOW TO USE: - Copy one of the example/ folders and rename it (your WAD will be named after this folder) - Edit values in "properties.txt" to set various properties for your follower, and adjust the RGB colors that the converter considers transparent pixels if you want + - Each editable field in properties.txt comes with additional information on its use - Create or paste your follower's sprites into the template provided - Replace the OGG sound file in the folder with the sound that you want your follower to have (this program does not convert or add echo for you)