https://wiki.wesnoth.org/api.php?action=feedcontributions&feedformat=atom&user=LfernandoThe Battle for Wesnoth Wiki - User contributions [en]2026-05-03T10:06:35ZUser contributionsMediaWiki 1.31.16https://wiki.wesnoth.org/index.php?title=InterfaceActionsWML&diff=36729InterfaceActionsWML2010-06-03T13:51:25Z<p>Lfernando: </p>
<hr />
<div>{{WML Tags}}<br />
== Interface actions ==<br />
<br />
Interface actions are actions that do not have an effect on gameplay;<br />
instead, they show something to the player. The main interface tags<br />
are '''[message]''' and '''[objectives]''', but several other tags affect<br />
the interface also.<br />
<br />
== [inspect] ==<br />
This user interface action only works in debug mode. It displays the gamestate inspector dialog (the same one which can be brought up with '':inspect'' ), which can be used to inspect the values of WML variables, AI configuration, recall lists, and more.<br />
<br />
* '''name''': optional attribute to specify the name of this gamestate inspector dialog. It is just a label to help differentiate between different invocations of gamestate inspector dialog.<br />
<br />
== [message] ==<br />
The most commonly used interface action is [message], which displays a message to the user in a dialog box. It can also be used to take input from the user.<br />
<br />
The following key/tags are accepted for [message]:<br />
* [[StandardUnitFilter]]: The unit whose profile and name are displayed. Do not use a [filter] tag. If no unit matching this filter is found, the message is not displayed (The unit has probably been killed).<br>'''[message]''' elements should be constructed so that it is either guaranteed that a certain unit is alive, or so that dialog flows smoothly even if the message isn't displayed.<br />
<br />
* '''speaker''': an alternative to standard unit filter. You may specify as the value of the speaker attribute a unit id or any of the following special values:<br />
** '''narrator''': the dialog box is displayed without a caption for the unit speaking or a unit image<br />
** '''unit''': the primary unit for the event is speaking<br />
** '''second_unit''': the secondary unit for the event is speaking<br />
<br />
* '''message''': (translatable) the text to display to the right of the image. ''message'' is sometimes multiple lines; if it is, be sure to use quotes(''' ' ''' or ''' " ''')<br />
* '''[show_if]''': if present then this message will only be displayed if the conditional statement in this tag is passed (see [[ConditionalActionsWML#Condition_Tags|ConditionalActionsWML]])<br />
* '''side_for''': (default: all sides) comma-separated list of sides for who message is shown.<br />
* '''image''': (default: profile image of speaker) the image to display next to the message.<br />
* '''caption''': (default: name of speaker) the caption to display beside the image. Name to be displayed.<br />
* '''duration''': (default: 10) the minimum number of frames for this message to be displayed. (A frame lasts about 30 milliseconds.) During this time any dialog decisions will be disregarded.<br />
* '''sound''': a sound effect (wav file) to play as the message is displayed. This can be a comma-separated list, from which one will be randomly chosen.<br />
* '''[option]''': zero or more '''[option]''' elements may be present. If '''[option]''' elements are present, then each option will be displayed in a menu for the user to select one option.<br />
** '''message''': (translatable) the text displayed for the option (see [[DescriptionWML]])<br />
** '''[show_if]''': if present then this option will only be displayed if the conditional statement in this tag is passed (see [[InternalActionsWML]])<br />
** '''[command]''': an element containing actions which are executed if the option is selected.<br />
* '''[text_input]''': there can be only one [text_input] tag. this adds a text input field to the message.<br />
** '''variable''': the variable that the user's input will be written to<br />
** '''label''': a text label to the left of the input field<br />
** '''max_chars''': the maximum number of characters that may be typed into the field<br />
** '''text''': text that is written into the field in the beginning<br />
* Check [[EventWML#Multiplayer_safety]] to find out in which events you can safely use '''[option]''' and '''[text_input]''' without causing OOS.<br />
<br />
=== Formatting ===<br />
In 1.8, [http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html Pango markup formatting codes] have been adopted for '''[message]'''. These can also be used in unit names (user_description), objectives, and such. Note that you'll probably want to use a single quote ' instead of a double quote " as double quotes cannot be escaped, otherwise the string will appear fragmented and you may also encounter errors. Running wmllint on your campaign will up-convert it, warning you about unusual cases you must fix by hand.<br />
<br />
For example, if you wanted to write "You are victorious!" in large, italic, gold letters, you might write it this way:<br />
<br />
<nowiki><span color='#BCB088' size='large' font-style='italic'>You are victorious!</span></nowiki><br />
<br />
<br />
These are the codes taken from the Pango markup formatting guide:<br />
<br />
*'''font''', '''font_desc''': A font description string, such as "Sans Italic 12".<br />
*'''font_family''', '''face''': A font family name.<br />
*'''font_size''', '''size''': Font size in 1024ths of a point, or one of the absolute sizes 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large', or one of the relative sizes 'smaller' or 'larger'.<br />
*'''font_style''', '''style''': One of 'normal', 'oblique', 'italic'.<br />
*'''font_weight''', '''weight''': One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold', 'heavy', or a numeric weight.<br />
*'''font_variant''', '''variant''': One of 'normal' or 'smallcaps'.<br />
*'''font_stretch''', '''stretch''': One of 'ultracondensed', 'extracondensed', 'condensed', 'semicondensed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded', 'ultraexpanded'.<br />
*'''foreground''', '''fgcolor''', '''color''': An RGB color specification such as '#00FF00' or a color name such as 'red'.<br />
*'''background, bgcolor''': An RGB color specification such as '#00FF00' or a color name such as 'red'.<br />
*'''underline''': One of 'none', 'single', 'double', 'low', 'error'.<br />
*'''underline_color''': The color of underlines; an RGB color specification such as '#00FF00' or a color name such as 'red'.<br />
*'''rise''': Vertical displacement, in 10000ths of an em. Can be negative for subscript, positive for superscript.<br />
*'''strikethrough''': 'true' or 'false' whether to strike through the text.<br />
*'''strikethrough_color''': The color of strikethrough lines; an RGB color specification such as '#00FF00' or a color name such as 'red'<br />
*'''fallback''': 'true' or 'false' whether to enable fallback. If disabled, then characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text. Fallback is enabled by default. Most applications should not disable fallback.<br />
*'''letter_spacing''': Inter-letter spacing in 1024ths of a point.<br />
*'''gravity''': One of 'south', 'east', 'north', 'west', 'auto'.<br />
*'''gravity_hint''': One of 'natural', 'strong', 'line'.<br />
<br />
<br />
In 1.6, Wesnoth uses older text formatting options<br />
* A tilde (~) as the first character causes the line to be boldfaced.<br />
* An at symbol (@) as the first character causes the line to be green, as done with victory conditions.<br />
* A pound symbol (#) as the first character causes the line to be red, as done with defeat conditions.<br />
* An asterisk (*) as the first character causes the line to be bigger.<br />
* A backquote (`) as the first character causes the line to be smaller.<br />
* If used, the caption key text is boldfaced.<br />
* An RGB colour code in the beginning causes the line to be the given colour. This can still be preceded by the above characters. Example: ''message=_"<255,0,0>Red!"''<br />
<br />
== [objectives] ==<br />
The other tag used for plot development is '''[objectives]'''.<br />
The '''[objectives]''' tag overwrites any previously set objectives,<br />
and displays text which should describe the objectives of the scenario.<br />
Scenario objectives are displayed on the player's first turn after the tag is used,<br />
or as part of the event if it triggers during that player's turn.<br />
Objectives can also be accessed at any time in a scenario using the<br />
"Scenario Objectives" game menu option, making this tag useful for<br />
scenario-specific information that the player may need to refer to during play.<br />
<br />
This tag renders the ''objectives'' attribute of [scenario] obsolete (see ''objectives'', [[ScenarioWML]]).<br />
Instead of using ''objectives'', use '''[objectives]''' to set scenario objectives inside a prestart event.<br />
It can also be used to overwrite the starting objectives mid-scenario.<br />
<br />
Attributes of '''[objectives]''':<br />
* '''side''': Default '0'. The side to set the objectives for. A value of 0 sets objectives for all sides.<br />
* '''summary''': Displayed first in the objectives text, this should describe the basic objective for the overall scenario. Can be omitted.<br />
* '''note''': Displayed last in the objectives text, this is sometimes used for hints or additional information. Can be omitted.<br />
* '''victory_string''': Default ' _ "Victory:"', this text precedes the victory objectives.<br />
* '''defeat_string''': Default ' _ "Defeat:"', this text precedes the defeat objectives.<br />
* '''silent''': Default: not present. If set to "yes", the objectives are silently changed. Else, they will be shown to the user when appropriate.<br />
<br />
Tags of '''[objectives]''':<br />
* '''[objective]''': describes a win or loss condition. Most scenarios have multiple win or loss conditions, so use a separate [objective] subtag for each line; this helps with translations.<br />
** '''description''': text for the specific win or loss condition.<br />
** '''condition''': The color and placement of the text. Values are 'win'(colored green, placed after ''victory_string'') and 'lose'(colored red, placed after ''defeat_string'')<br />
** '''[show_if]''': A condition that disables the objective if it doesn't hold. Conditional objectives are refreshed at '''[show_objectives]''' time only. {{DevFeature}}<br />
<br />
=== Macros ===<br />
There are a few predefined macros for Objectives that you can use to shorten the code: [http://www.wesnoth.org/macro-reference.xhtml#SET_OBJECTIVES SET_OBJECTIVES], [http://www.wesnoth.org/macro-reference.xhtml#VICTORY_CONDITION VICTORY_CONDITION], and [http://www.wesnoth.org/macro-reference.xhtml#DEFEAT_CONDITION DEFEAT_CONDITION]. Follow the links for each one to see complete syntax and example usage.<br />
<br />
== [set_menu_item] ==<br />
This tag is used to add a custom option in the right-click context menu which can then be used to trigger arbitrary WML commands.<br />
<br />
'''Note:''' Due to limitations in portable devices where there are no scroll bars for context menus, there is a hard-coded limit of 7 custom WML menu items. If you really need to have more than 7 menu items, try combining some of them in a submenu.<br />
<br />
* '''id''': the unique id for this menu item. If a menu item with this id already exists, it allows you to set specific changes to that item.<br />
* '''description''': the in-game text that will appear for this item in the menu.<br />
* '''image''': the image to display next to this item.<br />
* '''needs_select''': if ''yes'' (default ''no''), then the latest select event (see [[EventWML]]) that triggered before this menu item was chosen will be transmitted over the network before this menu item action will be. This only has any effect in networked multiplayer, and is intended to allow more elaborate menu item behaviour there without causing out of sync errors. If you don't know what this means, just leave it false.<br />
* '''[show_if]''': If present, the menu item will only be available if the conditional statement (see [[InternalActionsWML]]) within evaluates to true. When this is evaluated, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked, so it's possible to for example only enable the option on empty hexes or on a particular unit.<br />
* '''[filter_location]''': contains a location filter similar to the one found inside Single Unit Filters (see [[FilterWML]]). The menu item will only be available on matching locations.<br />
* '''[command]''': contains the WML actions to be executed when the menu item is selected. Again, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked on.<br />
<br />
== Other interface tags ==<br />
<br />
The following tags are also action tags:<br />
* '''[item]''': makes a graphical item appear on a certain hex. Note this only places the graphics for an item. It does not make the item do anything. Use a moveto event to make moving onto the item do something. <tt>''('''Hint:''' There are a number of predefined items that are used in various campaigns that you can make use of. You can find [http://www.wesnoth.org/macro-reference.xhtml#file:items.cfg a list of them] if you look into the items.cfg file in the wesnoth install directory (under /data/core/macros))''</tt><br />
** '''x''', '''y''': the location to place the item.<br />
** '''image''': the image (in ''images/'' as .png) to place on the hex.<br />
** '''halo''': an image to place centered on the hex. Use this instead of ''image'' if the image is bigger than the hex or if you want to animate an image. ''Example (where the integer after the colon is the duration of each frame): halo=scenery/fire1.png:100,scenery/fire2.png:100,scenery/fire3.png:100,scenery/fire4.png:100,scenery/fire5.png:100,scenery/fire6.png:100,scenery/fire7.png:100,scenery/fire8.png:100''<br />
** '''team_name''': name of the team for which the item is to be displayed (hidden for others). For multiple teams just put all the names in one string, for example separated by commas.<br />
** '''visible_in_fog''': whether the item should be visible through fog or not. Default yes.<br />
* '''[removeitem]''': removes any graphical items on a given hex<br />
** '''x''', '''y''': the hex to remove items off<br />
** '''image''' if specified, only removes the given image item (This image name must include any [[ImagePathFunctionWML|image path functions]] appended to the original image name.)<br />
* '''[print]''': displays a message across the screen. The message will disappear after a certain time.<br />
** '''text''': (translatable) the text to display.<br />
** '''size''': (default=12) the pointsize of the font to use<br />
** '''duration''': (default=50) the length of time to display the text for. This is measured in the number of 'frames'. A frame in Wesnoth is usually displayed for around 30ms.<br />
** '''red''', '''green''', '''blue''': (default=0,0,0) the color to display the text in. Values vary from 0-255.<br />
* '''[move_unit_fake]''': moves an image of a unit along a certain path on the map. The path does not need to be a continuous list of adjacent hexes, so for example only the start and end points can be given, in which case the straightest line between those points will be calculated and used.<br />
** '''type''': the type of the unit whose image to use<br />
** '''x''': a comma-separated list of x locations to move along<br />
** '''y''': a comma-separated list of y locations to move along (x and y values are matched pairs)<br />
** '''side''': the side of the fake unit, used for team-coloring the fake unit<br />
* '''[move_units_fake]''': {{DevFeature1.9}} moves multiple images of units along paths on the map. These units are moved in lockstep.<br />
** '''[fake_unit]''': A fake unit to move<br />
*** '''type''': the type of unit whose image to use<br />
*** '''x''': a comma-separated list of x locations to move along<br />
*** '''y''': a comma-separated list of y locations to move along (x and y values are matched pairs)<br />
*** '''side''': the side of the fake unit, used for team-coloring the fake unit<br />
*** '''skip_steps''': the number of steps to skip before this unit starts moving<br />
* '''[hide_unit]''': makes the given unit become invisible. Useful in conjunction with '''[move_unit_fake]''': to move a leader unit into position on-screen. Each '''[hide_unit]''' tag only hides one unit.<br />
** '''x''', '''y''': location of the unit to be hidden. (NOT a standard unit filter! Just x and y.)<br />
* '''[unhide_unit]''': stops the currently hidden units from being hidden.<br />
* '''[scroll]''': Scroll a certain number of pixels in a given direction. Useful for earthquake/shaking effects.<br />
** '''x''', '''y''': the number of pixels to scroll along the x and y axis<br />
* '''[scroll_to]''': Scroll to a given hex<br />
** '''x''', '''y''': the hex to scroll to<br />
** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br />
* '''[scroll_to_unit]''' Scroll to a given unit<br />
** [[StandardUnitFilter]]<br />
** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br />
* '''[sound]''': Plays a sound<br />
** '''name''': the filename of the sound to play (in ''sounds/'' as .wav or .ogg)<br />
** '''repeat''': repeats the sound for a specified additional number of times (default=0)<br />
* '''[sound_source]''': Creates a sound source. "Sound sources" is a general name for a mechanism which makes possible for map elements to emit sounds according to some rules, where "map elements" can be specific locations or terrain types. For now, only sound sources tied to locations are supported.<br />
** '''id''': a unique identification key of the sound source<br />
** '''sounds''': a list of comma separated, randomly played sounds associated with the sound source<br />
** '''delay''': a numerical value (in milliseconds) of the minimal delay between two playbacks of the source's sound if the source remains visible on the screen; if one scrolls out and back in, the source will be considered as ready to play<br />
** '''chance''': a percentage (a value from 0 to 100) describing the chance of the source being activated every second after the delay has passed or when the source's location appears on the screen (note that it cannot play more than one file at the same time)<br />
** '''check_fogged''': possible values "true" and "false" - if true the source will not play if its locations are fogged<br />
** '''check_shrouded''': {{DevFeature}} possible values "true" and "false" - if true the source will not play if its locations are shrouded<br />
** '''x,y''': a [[StandardLocationFilter]] for the locations associated with the sound source<br />
** '''fade_range''' (default = 3): distance in hexes that determines a "circular" area around the one specified by '''full_range''' where sound volume fades out linearly<br />
** '''full_range''' (default = 14): distance in hexes that determines a "circular" area where source plays with full volume, relative to screen center<br />
** '''loop''': number of times a sound sample should be looped if it stays visible. -1 means infinite (~65000)<br />
* '''[remove_sound_source]''': Removes a previously defined sound source.<br />
** '''id''': the identification key of the sound source to remove<br />
* '''[music]''': Switches to playing different music<br />
** '''name''': the filename of the music to play (in ''music/'' as .ogg)<br />
** see [[MusicListWML]] for the correct syntax<br />
* '''[volume]''': {{DevFeature1.9}} Changes the game volume to a percent of the preferences volume for the game being played. Values can go from 0 to 100: <br />
** '''music''': Changes the music volume.<br />
** '''sound''': Changes the sound volume.<br />
* '''[colour_adjust]''': tints the colour of the screen.<br />
** '''red''', '''green''', '''blue''': values from -255 to 255, the amount to tint by for each colour<br />
* '''[delay]''': pauses the game<br />
** '''time''': the time to pause in milliseconds<br />
* '''[redraw]''': redraws the screen (this normally isn't done during events, although some of the other interface actions cause the screen or parts of it to be redrawn).<br />
** '''side''': if used, recalculates fog and shroud for that side. Useful if you for example spawn friendly units in the middle of an event and want the shroud to update accordingly (otherwise units that spawn inside fog would remain invisible for the duration of the event, since the fog would not automatically get cleared around them).<br />
* '''[unit_overlay]''': sets an image that will be drawn over a particular unit, and follow it around<br />
** '''x''', '''y''': the location of the unit to overlay on<br />
** '''image''': the image to place on the unit<br />
* '''[remove_unit_overlay]''': removes a particular overlayed image from a unit<br />
** '''x''', '''y''': the location of the unit to remove an overlay from<br />
** '''image''': the image to remove from the unit<br />
* '''[animate_unit]''': Uses an animation of a unit to animate it on screen (if the unit has the corresponding animation).<br />
** '''flag''': The key to find the custom animation in the unit description (see the '''[extra_anim]''' description in [[AnimationWML]]). Standard animations can be triggered with the following keywords: ''leading recruited standing idling levelin levelout healing healed poisoned movement defend attack death victory pre_teleport post_teleport''<br />
** '''[filter]''' with a [[StandardUnitFilter]] as argument, see [[FilterWML]]. By default, the unit at the event location will be animated. You can use this tag to choose any other unit to animate.<br />
** '''[primary_attack]''': If this tag is not present, the filter for animation will be triggered with no attack. If it is here, all attacks from the unit will be filtered, and a matching one will be used to filter the animation. Takes a weapon filter as argument, see [[FilterWML]].<br />
** '''[secondary_attack]''': Similar to '''[primary_attack]'''. May be needed to trigger a defense animation correctly, if there are more than one animations available for the defending unit.<br />
** '''hits''': yes/no: which according variation of a attack/defense animation shall be chosen (required)<br />
** '''text''': a text to hover during the animation <br />
** '''red''': red value for the text color (0-255)<br />
** '''green''': green value for the text color<br />
** '''blue''': blue value for the text color<br />
** '''with_bars''': yes/no: whether to display the status bars during the animation (e.g. the hitpoint bar)<br />
** '''[animate]''': a sub block with the same syntax as '''[animate_unit]''' except that the '''[filter]''' block is mandatory to find the unit. This block will find and animate another unit simultaneously.<br />
** '''[facing]''': a [[StandardLocationFilter]] specifying what direction the unit should be facing when animated<br />
* '''[label]''' places a label on the map.<br />
** '''x''', '''y''': the location of the label<br />
** '''text''': what the label should say<br />
** '''team_name''': if specified, the label will only be visible to the given team.<br />
** '''colour''': color of the label. The format is r,g,b; r, g and b are numbers between 0 and 255. <br />
** '''visible_in_fog''': whether the label should be visible through fog or not. Default yes.<br />
** '''visible_in_shroud''': whether the label should be visible through shroud or not. Default no.<br />
** '''immutable''': whether this label is protected from being removed or changed by players. Default yes. {{DevFeature1.9}}<br />
* '''[deprecated_message]''' shows a deprecated message in the message area, this feature is only intended to be used to warn about deprecated macros in mainline. The message is not translatable.<br />
** '''message''': the message to show.<br />
* '''[wml_message]''' outputs a message to Wesnoth's console output. Intended for campaign designers to output silent text to the console, without annoying the player; then, that text might contain information useful for later bug-reporting. The log domain for it is '''wml''', and the '''debug/dbg''' log level is available for use with the '''logger''' attribute. Depending on the current log level ('''error''' by default), which may be changed with the in-game :log command, or the --log-<level>=wml command line switch, the messages are echoed to the in-game chat.<br />
** '''message''': the message to show.<br />
** '''logger''': the Wesnoth engine output logger that should catch the text; this might be 'err' (the errors log level), 'warn'/'wrn' (the warnings log level) or anything else (the information log level). Not all information will be displayed depending on the log level chosen when starting Wesnoth.<br />
* '''[open_help]''' opens the in-game help.<br />
** '''topic''': the id of the topic to open<br />
* '''[show_objectives]''': {{DevFeature}} refreshes the objectives defined by [objectives] and its [show_if] tags, and displays them. (It is also called whenever the user explicitly asks for the objectives; this matters only if the tag was overridden by a [[LuaWML#register_wml_action|Lua]] script.)<br />
** '''side''': the side to show the objectives. If not set, all sides are used.<br />
<br />
== Useful Macros ==<br />
There are some predefined macros that you find useful for interface actions. You can find a complete list along with a detailed explanation of how they work [http://www.wesnoth.org/macro-reference.xhtml here].<br />
* '''{FLOATING_TEXT}''' Float some text over a unit similar to the damage numbers.<br />
* '''{HIGHLIGHT_UNIT}''' Highlight a unit on the map. Use this to show important units<br />
* '''{HIGHLIGHT_IMAGE}''' Places and highlights an image on the map. Use this to show important items or locations<br />
* '''{SET_IMAGE}''' Places an image on the map which has no other function.<br />
* '''{QUAKE <soundfile>}''' Creates a tremor like screenshake and plays <soundfile>. ('''{TREMOR}''' is a deprecated version, equivalent to '''{QUAKE (rumble.ogg)}''')<br />
* '''{FLASH_WHITE}''' Flash the screen white momentarily. You can also replace WHITE with RED, BLUE or GREEN for a different colour.<br />
<br />
== See Also ==<br />
* [[DirectActionsWML]]<br />
* [[InternalActionsWML]]<br />
* [[EventWML]]<br />
* [[ReferenceWML]]<br />
<br />
<br />
[[Category: WML Reference]]<br />
[[Category: ActionsWML]]</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=InterfaceActionsWML&diff=36488InterfaceActionsWML2010-05-11T21:47:37Z<p>Lfernando: </p>
<hr />
<div>{{WML Tags}}<br />
== Interface actions ==<br />
<br />
Interface actions are actions that do not have an effect on gameplay;<br />
instead, they show something to the player. The main interface tags<br />
are '''[message]''' and '''[objectives]''', but several other tags affect<br />
the interface also.<br />
<br />
== [inspect] ==<br />
This user interface action only works in debug mode. It displays the gamestate inspector dialog (the same one which can be brought up with '':inspect'' ), which can be used to inspect the values of WML variables, AI configuration, recall lists, and more.<br />
<br />
* '''name''': optional attribute to specify the name of this gamestate inspector dialog. It is just a label to help differentiate between different invocations of gamestate inspector dialog.<br />
<br />
== [message] ==<br />
The most commonly used interface action is [message], which displays a message to the user in a dialog box. It can also be used to take input from the user.<br />
<br />
The following key/tags are accepted for [message]:<br />
* [[StandardUnitFilter]]: The unit whose profile and name are displayed. Do not use a [filter] tag. If no unit matching this filter is found, the message is not displayed (The unit has probably been killed).<br>'''[message]''' elements should be constructed so that it is either guaranteed that a certain unit is alive, or so that dialog flows smoothly even if the message isn't displayed.<br />
<br />
* '''speaker''': an alternative to standard unit filter. You may specify as the value of the speaker attribute a unit id or any of the following special values:<br />
** '''narrator''': the dialog box is displayed without a caption for the unit speaking or a unit image<br />
** '''unit''': the primary unit for the event is speaking<br />
** '''second_unit''': the secondary unit for the event is speaking<br />
<br />
* '''message''': (translatable) the text to display to the right of the image. ''message'' is sometimes multiple lines; if it is, be sure to use quotes(''' ' ''' or ''' " ''')<br />
* '''[show_if]''': if present then this message will only be displayed if the conditional statement in this tag is passed (see [[ConditionalActionsWML#Condition_Tags|ConditionalActionsWML]])<br />
* '''side_for''': (default: all sides) comma-separated list of sides for who message is shown.<br />
* '''image''': (default: profile image of speaker) the image to display next to the message.<br />
* '''caption''': (default: name of speaker) the caption to display beside the image. Name to be displayed.<br />
* '''duration''': (default: 10) the minimum number of frames for this message to be displayed. (A frame lasts about 30 milliseconds.) During this time any dialog decisions will be disregarded.<br />
* '''sound''': a sound effect (wav file) to play as the message is displayed. This can be a comma-separated list, from which one will be randomly chosen.<br />
* '''[option]''': zero or more '''[option]''' elements may be present. If '''[option]''' elements are present, then each option will be displayed in a menu for the user to select one option.<br />
** '''message''': (translatable) the text displayed for the option (see [[DescriptionWML]])<br />
** '''[show_if]''': if present then this option will only be displayed if the conditional statement in this tag is passed (see [[InternalActionsWML]])<br />
** '''[command]''': an element containing actions which are executed if the option is selected.<br />
* '''[text_input]''': there can be only one [text_input] tag. this adds a text input field to the message.<br />
** '''variable''': the variable that the user's input will be written to<br />
** '''label''': a text label to the left of the input field<br />
** '''max_chars''': the maximum number of characters that may be typed into the field<br />
** '''text''': text that is written into the field in the beginning<br />
* Check [[EventWML#Multiplayer_safety]] to find out in which events you can safely use '''[option]''' and '''[text_input]''' without causing OOS.<br />
<br />
=== Formatting ===<br />
In 1.8, [http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html Pango markup formatting codes] have been adopted for '''[message]'''. These can also be used in unit names (user_description), objectives, and such. Note that you'll probably want to use a single quote ' instead of a double quote " as double quotes cannot be escaped, otherwise the string will appear fragmented and you may also encounter errors. Running wmllint on your campaign will up-convert it, warning you about unusual cases you must fix by hand.<br />
<br />
For example, if you wanted to write "You are victorious!" in large, italic, gold letters, you might write it this way:<br />
<br />
<nowiki><span color='#BCB088' size='large' font-style='italic'>You are victorious!</span></nowiki><br />
<br />
<br />
These are the codes taken from the Pango markup formatting guide:<br />
<br />
*'''font''', '''font_desc''': A font description string, such as "Sans Italic 12".<br />
*'''font_family''', '''face''': A font family name.<br />
*'''font_size''', '''size''': Font size in 1024ths of a point, or one of the absolute sizes 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large', or one of the relative sizes 'smaller' or 'larger'.<br />
*'''font_style''', '''style''': One of 'normal', 'oblique', 'italic'.<br />
*'''font_weight''', '''weight''': One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold', 'heavy', or a numeric weight.<br />
*'''font_variant''', '''variant''': One of 'normal' or 'smallcaps'.<br />
*'''font_stretch''', '''stretch''': One of 'ultracondensed', 'extracondensed', 'condensed', 'semicondensed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded', 'ultraexpanded'.<br />
*'''foreground''', '''fgcolor''', '''color''': An RGB color specification such as '#00FF00' or a color name such as 'red'.<br />
*'''background, bgcolor''': An RGB color specification such as '#00FF00' or a color name such as 'red'.<br />
*'''underline''': One of 'none', 'single', 'double', 'low', 'error'.<br />
*'''underline_color''': The color of underlines; an RGB color specification such as '#00FF00' or a color name such as 'red'.<br />
*'''rise''': Vertical displacement, in 10000ths of an em. Can be negative for subscript, positive for superscript.<br />
*'''strikethrough''': 'true' or 'false' whether to strike through the text.<br />
*'''strikethrough_color''': The color of strikethrough lines; an RGB color specification such as '#00FF00' or a color name such as 'red'<br />
*'''fallback''': 'true' or 'false' whether to enable fallback. If disabled, then characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text. Fallback is enabled by default. Most applications should not disable fallback.<br />
*'''letter_spacing''': Inter-letter spacing in 1024ths of a point.<br />
*'''gravity''': One of 'south', 'east', 'north', 'west', 'auto'.<br />
*'''gravity_hint''': One of 'natural', 'strong', 'line'.<br />
<br />
<br />
In 1.6, Wesnoth uses older text formatting options<br />
* A tilde (~) as the first character causes the line to be boldfaced.<br />
* An at symbol (@) as the first character causes the line to be green, as done with victory conditions.<br />
* A pound symbol (#) as the first character causes the line to be red, as done with defeat conditions.<br />
* An asterisk (*) as the first character causes the line to be bigger.<br />
* A backquote (`) as the first character causes the line to be smaller.<br />
* If used, the caption key text is boldfaced.<br />
* An RGB colour code in the beginning causes the line to be the given colour. This can still be preceded by the above characters. Example: ''message=_"<255,0,0>Red!"''<br />
<br />
== [objectives] ==<br />
The other tag used for plot development is '''[objectives]'''.<br />
The '''[objectives]''' tag overwrites any previously set objectives,<br />
and displays text which should describe the objectives of the scenario.<br />
Scenario objectives are displayed on the player's first turn after the tag is used,<br />
or as part of the event if it triggers during that player's turn.<br />
Objectives can also be accessed at any time in a scenario using the<br />
"Scenario Objectives" game menu option, making this tag useful for<br />
scenario-specific information that the player may need to refer to during play.<br />
<br />
This tag renders the ''objectives'' attribute of [scenario] obsolete (see ''objectives'', [[ScenarioWML]]).<br />
Instead of using ''objectives'', use '''[objectives]''' to set scenario objectives inside a prestart event.<br />
It can also be used to overwrite the starting objectives mid-scenario.<br />
<br />
Attributes of '''[objectives]''':<br />
* '''side''': Default '0'. The side to set the objectives for. A value of 0 sets objectives for all sides.<br />
* '''summary''': Displayed first in the objectives text, this should describe the basic objective for the overall scenario. Can be omitted.<br />
* '''note''': Displayed last in the objectives text, this is sometimes used for hints or additional information. Can be omitted.<br />
* '''victory_string''': Default ' _ "Victory:"', this text precedes the victory objectives.<br />
* '''defeat_string''': Default ' _ "Defeat:"', this text precedes the defeat objectives.<br />
* '''silent''': Default: not present. If set to "yes", the objectives are silently changed. Else, they will be shown to the user when appropriate.<br />
<br />
Tags of '''[objectives]''':<br />
* '''[objective]''': describes a win or loss condition. Most scenarios have multiple win or loss conditions, so use a separate [objective] subtag for each line; this helps with translations.<br />
** '''description''': text for the specific win or loss condition.<br />
** '''condition''': The color and placement of the text. Values are 'win'(colored green, placed after ''victory_string'') and 'lose'(colored red, placed after ''defeat_string'')<br />
** '''[show_if]''': A condition that disables the objective if it doesn't hold. Conditional objectives are refreshed at '''[show_objectives]''' time only. {{DevFeature}}<br />
<br />
=== Macros ===<br />
There are a few predefined macros for Objectives that you can use to shorten the code: [http://www.wesnoth.org/macro-reference.xhtml#SET_OBJECTIVES SET_OBJECTIVES], [http://www.wesnoth.org/macro-reference.xhtml#VICTORY_CONDITION VICTORY_CONDITION], and [http://www.wesnoth.org/macro-reference.xhtml#DEFEAT_CONDITION DEFEAT_CONDITION]. Follow the links for each one to see complete syntax and example usage.<br />
<br />
== [set_menu_item] ==<br />
This tag is used to add a custom option in the right-click context menu which can then be used to trigger arbitrary WML commands.<br />
<br />
'''Note:''' Due to limitations in portable devices where there are no scroll bars for context menus, there is a hard-coded limit of 7 custom WML menu items. If you really need to have more than 7 menu items, try combining some of them in a submenu.<br />
<br />
* '''id''': the unique id for this menu item. If a menu item with this id already exists, it allows you to set specific changes to that item.<br />
* '''description''': the in-game text that will appear for this item in the menu.<br />
* '''image''': the image to display next to this item.<br />
* '''needs_select''': if ''yes'' (default ''no''), then the latest select event (see [[EventWML]]) that triggered before this menu item was chosen will be transmitted over the network before this menu item action will be. This only has any effect in networked multiplayer, and is intended to allow more elaborate menu item behaviour there without causing out of sync errors. If you don't know what this means, just leave it false.<br />
* '''[show_if]''': If present, the menu item will only be available if the conditional statement (see [[InternalActionsWML]]) within evaluates to true. When this is evaluated, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked, so it's possible to for example only enable the option on empty hexes or on a particular unit.<br />
* '''[filter_location]''': contains a location filter similar to the one found inside Single Unit Filters (see [[FilterWML]]). The menu item will only be available on matching locations.<br />
* '''[command]''': contains the WML actions to be executed when the menu item is selected. Again, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked on.<br />
<br />
== Other interface tags ==<br />
<br />
The following tags are also action tags:<br />
* '''[item]''': makes a graphical item appear on a certain hex. Note this only places the graphics for an item. It does not make the item do anything. Use a moveto event to make moving onto the item do something. <tt>''('''Hint:''' There are a number of predefined items that are used in various campaigns that you can make use of. You can find [http://www.wesnoth.org/macro-reference.xhtml#file:items.cfg a list of them] if you look into the items.cfg file in the wesnoth install directory (under /data/core/macros))''</tt><br />
** '''x''', '''y''': the location to place the item.<br />
** '''image''': the image (in ''images/'' as .png) to place on the hex.<br />
** '''halo''': an image to place centered on the hex. Use this instead of ''image'' if the image is bigger than the hex or if you want to animate an image. ''Example (where the integer after the colon is the duration of each frame): halo=scenery/fire1.png:100,scenery/fire2.png:100,scenery/fire3.png:100,scenery/fire4.png:100,scenery/fire5.png:100,scenery/fire6.png:100,scenery/fire7.png:100,scenery/fire8.png:100''<br />
** '''team_name''': name of the team for which the item is to be displayed (hidden for others). For multiple teams just put all the names in one string, for example separated by commas.<br />
** '''visible_in_fog''': whether the item should be visible through fog or not. Default yes.<br />
* '''[removeitem]''': removes any graphical items on a given hex<br />
** '''x''', '''y''': the hex to remove items off<br />
** '''image''' if specified, only removes the given image item (This image name must include any [[ImagePathFunctionWML|image path functions]] appended to the original image name.)<br />
* '''[print]''': displays a message across the screen. The message will disappear after a certain time.<br />
** '''text''': (translatable) the text to display.<br />
** '''size''': (default=12) the pointsize of the font to use<br />
** '''duration''': (default=50) the length of time to display the text for. This is measured in the number of 'frames'. A frame in Wesnoth is usually displayed for around 30ms.<br />
** '''red''', '''green''', '''blue''': (default=0,0,0) the color to display the text in. Values vary from 0-255.<br />
* '''[move_unit_fake]''': moves an image of a unit along a certain path on the map. The path does not need to be a continuous list of adjacent hexes, so for example only the start and end points can be given, in which case the straightest line between those points will be calculated and used.<br />
** '''type''': the type of the unit whose image to use<br />
** '''x''': a comma-separated list of x locations to move along<br />
** '''y''': a comma-separated list of y locations to move along (x and y values are matched pairs)<br />
** '''side''': the side of the fake unit, used for team-coloring the fake unit<br />
* '''[hide_unit]''': makes the given unit become invisible. Useful in conjunction with '''[move_unit_fake]''': to move a leader unit into position on-screen. Each '''[hide_unit]''' tag only hides one unit.<br />
** '''x''', '''y''': location of the unit to be hidden. (NOT a standard unit filter! Just x and y.)<br />
* '''[unhide_unit]''': stops the currently hidden units from being hidden.<br />
* '''[scroll]''': Scroll a certain number of pixels in a given direction. Useful for earthquake/shaking effects.<br />
** '''x''', '''y''': the number of pixels to scroll along the x and y axis<br />
* '''[scroll_to]''': Scroll to a given hex<br />
** '''x''', '''y''': the hex to scroll to<br />
** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br />
* '''[scroll_to_unit]''' Scroll to a given unit<br />
** [[StandardUnitFilter]]<br />
** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br />
* '''[sound]''': Plays a sound<br />
** '''name''': the filename of the sound to play (in ''sounds/'' as .wav or .ogg)<br />
** '''repeat''': repeats the sound for a specified additional number of times (default=0)<br />
* '''[sound_source]''': Creates a sound source. "Sound sources" is a general name for a mechanism which makes possible for map elements to emit sounds according to some rules, where "map elements" can be specific locations or terrain types. For now, only sound sources tied to locations are supported.<br />
** '''id''': a unique identification key of the sound source<br />
** '''sounds''': a list of comma separated, randomly played sounds associated with the sound source<br />
** '''delay''': a numerical value (in milliseconds) of the minimal delay between two playbacks of the source's sound if the source remains visible on the screen; if one scrolls out and back in, the source will be considered as ready to play<br />
** '''chance''': a percentage (a value from 0 to 100) describing the chance of the source being activated every second after the delay has passed or when the source's location appears on the screen (note that it cannot play more than one file at the same time)<br />
** '''check_fogged''': possible values "true" and "false" - if true the source will not play if its locations are fogged<br />
** '''check_shrouded''': {{DevFeature}} possible values "true" and "false" - if true the source will not play if its locations are shrouded<br />
** '''x,y''': a [[StandardLocationFilter]] for the locations associated with the sound source<br />
** '''fade_range''' (default = 3): distance in hexes that determines a "circular" area around the one specified by '''full_range''' where sound volume fades out linearly<br />
** '''full_range''' (default = 14): distance in hexes that determines a "circular" area where source plays with full volume, relative to screen center<br />
** '''loop''': number of times a sound sample should be looped if it stays visible. -1 means infinite (~65000)<br />
* '''[remove_sound_source]''': Removes a previously defined sound source.<br />
** '''id''': the identification key of the sound source to remove<br />
* '''[music]''': Switches to playing different music<br />
** '''name''': the filename of the music to play (in ''music/'' as .ogg)<br />
** see [[MusicListWML]] for the correct syntax<br />
* '''[volume]''': {{DevFeature}} Changes the game volume to a percent of the preferences volume for the game being played. Values can go from 0 to 100: <br />
** '''music''': Changes the music volume.<br />
** '''sound''': Changes the sound volume.<br />
* '''[colour_adjust]''': tints the colour of the screen.<br />
** '''red''', '''green''', '''blue''': values from -255 to 255, the amount to tint by for each colour<br />
* '''[delay]''': pauses the game<br />
** '''time''': the time to pause in milliseconds<br />
* '''[redraw]''': redraws the screen (this normally isn't done during events, although some of the other interface actions cause the screen or parts of it to be redrawn).<br />
** '''side''': if used, recalculates fog and shroud for that side. Useful if you for example spawn friendly units in the middle of an event and want the shroud to update accordingly (otherwise units that spawn inside fog would remain invisible for the duration of the event, since the fog would not automatically get cleared around them).<br />
* '''[unit_overlay]''': sets an image that will be drawn over a particular unit, and follow it around<br />
** '''x''', '''y''': the location of the unit to overlay on<br />
** '''image''': the image to place on the unit<br />
* '''[remove_unit_overlay]''': removes a particular overlayed image from a unit<br />
** '''x''', '''y''': the location of the unit to remove an overlay from<br />
** '''image''': the image to remove from the unit<br />
* '''[animate_unit]''': Uses an animation of a unit to animate it on screen (if the unit has the corresponding animation).<br />
** '''flag''': The key to find the custom animation in the unit description (see the '''[extra_anim]''' description in [[AnimationWML]]). Standard animations can be triggered with the following keywords: ''leading recruited standing idling levelin levelout healing healed poisoned movement defend attack death victory pre_teleport post_teleport''<br />
** '''[filter]''' with a [[StandardUnitFilter]] as argument, see [[FilterWML]]. By default, the unit at the event location will be animated. You can use this tag to choose any other unit to animate.<br />
** '''[primary_attack]''': If this tag is not present, the filter for animation will be triggered with no attack. If it is here, all attacks from the unit will be filtered, and a matching one will be used to filter the animation. Takes a weapon filter as argument, see [[FilterWML]].<br />
** '''[secondary_attack]''': Similar to '''[primary_attack]'''. May be needed to trigger a defense animation correctly, if there are more than one animations available for the defending unit.<br />
** '''hits''': yes/no: whether the being-hit or being-not-hit variants of attack/defense animations are chosen<br />
** '''text''': a text to hover during the animation<br />
** '''red''': red value for the text color (0-255)<br />
** '''green''': green value for the text color<br />
** '''blue''': blue value for the text color<br />
** '''with_bars''': yes/no: whether to display the status bars during the animation (e.g. the hitpoint bar)<br />
** '''[animate]''': a sub block with the same syntax as '''[animate_unit]''' except that the '''[filter]''' block is mandatory to find the unit. This block will find and animate another unit simultaneously.<br />
** '''[facing]''': a [[StandardLocationFilter]] specifying what direction the unit should be facing when animated<br />
* '''[label]''' places a label on the map.<br />
** '''x''', '''y''': the location of the label<br />
** '''text''': what the label should say<br />
** '''team_name''': if specified, the label will only be visible to the given team.<br />
** '''colour''': color of the label. The format is r,g,b; r, g and b are numbers between 0 and 255. <br />
** '''visible_in_fog''': whether the label should be visible through fog or not. Default yes.<br />
** '''visible_in_shroud''': whether the label should be visible through shroud or not. Default no.<br />
* '''[deprecated_message]''' shows a deprecated message in the message area, this feature is only intended to be used to warn about deprecated macros in mainline. The message is not translatable.<br />
** '''message''': the message to show.<br />
* '''[wml_message]''' outputs a message to Wesnoth's console output. Intended for campaign designers to output silent text to the console, without annoying the player; then, that text might contain information useful for later bug-reporting. The log domain for it is '''wml''', and the '''debug/dbg''' log level is available for use with the '''logger''' attribute. Depending on the current log level ('''error''' by default), which may be changed with the in-game :log command, or the --log-<level>=wml command line switch, the messages are echoed to the in-game chat.<br />
** '''message''': the message to show.<br />
** '''logger''': the Wesnoth engine output logger that should catch the text; this might be 'err' (the errors log level), 'warn'/'wrn' (the warnings log level) or anything else (the information log level). Not all information will be displayed depending on the log level chosen when starting Wesnoth.<br />
* '''[open_help]''' opens the in-game help.<br />
** '''topic''': the id of the topic to open<br />
* '''[show_objectives]''': {{DevFeature}} refreshes the objectives defined by [objectives] and its [show_if] tags, and displays them. (It is also called whenever the user explicitly asks for the objectives; this matters only if the tag was overridden by a [[LuaWML#register_wml_action|Lua]] script.)<br />
** '''side''': the side to show the objectives. If not set, all sides are used.<br />
<br />
== Useful Macros ==<br />
There are some predefined macros that you find useful for interface actions. You can find a complete list along with a detailed explanation of how they work [http://www.wesnoth.org/macro-reference.xhtml here].<br />
* '''{FLOATING_TEXT}''' Float some text over a unit similar to the damage numbers.<br />
* '''{HIGHLIGHT_UNIT}''' Highlight a unit on the map. Use this to show important units<br />
* '''{HIGHLIGHT_IMAGE}''' Places and highlights an image on the map. Use this to show important items or locations<br />
* '''{SET_IMAGE}''' Places an image on the map which has no other function.<br />
* '''{QUAKE <soundfile>}''' Creates a tremor like screenshake and plays <soundfile>. ('''{TREMOR}''' is a deprecated version, equivalent to '''{QUAKE (rumble.ogg)}''')<br />
* '''{FLASH_WHITE}''' Flash the screen white momentarily. You can also replace WHITE with RED, BLUE or GREEN for a different colour.<br />
<br />
== See Also ==<br />
* [[DirectActionsWML]]<br />
* [[InternalActionsWML]]<br />
* [[EventWML]]<br />
* [[ReferenceWML]]<br />
<br />
<br />
[[Category: WML Reference]]<br />
[[Category: ActionsWML]]</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=InterfaceActionsWML&diff=36288InterfaceActionsWML2010-04-24T13:34:54Z<p>Lfernando: </p>
<hr />
<div>{{WML Tags}}<br />
== Interface actions ==<br />
<br />
Interface actions are actions that do not have an effect on gameplay;<br />
instead, they show something to the player. The main interface tags<br />
are '''[message]''' and '''[objectives]''', but several other tags affect<br />
the interface also.<br />
<br />
== [inspect] ==<br />
This user interface action only works in debug mode. It displays the gamestate inspector dialog (the same one which can be brought up with '':inspect'' ), which can be used to inspect the values of WML variables, AI configuration, recall lists, and more.<br />
<br />
* '''name''': optional attribute to specify the name of this gamestate inspector dialog. It is just a label to help differentiate between different invocations of gamestate inspector dialog.<br />
<br />
== [message] ==<br />
The most commonly used interface action is [message], which displays a message to the user in a dialog box. It can also be used to take input from the user.<br />
<br />
The following key/tags are accepted for [message]:<br />
* [[StandardUnitFilter]]: The unit whose profile and name are displayed. Do not use a [filter] tag. If no unit matching this filter is found, the message is not displayed (The unit has probably been killed).<br>'''[message]''' elements should be constructed so that it is either guaranteed that a certain unit is alive, or so that dialog flows smoothly even if the message isn't displayed.<br />
<br />
* '''speaker''': an alternative to standard unit filter. You may specify as the value of the speaker attribute a unit id or any of the following special values:<br />
** '''narrator''': the dialog box is displayed without a caption for the unit speaking or a unit image<br />
** '''unit''': the primary unit for the event is speaking<br />
** '''second_unit''': the secondary unit for the event is speaking<br />
<br />
* '''message''': (translatable) the text to display to the right of the image. ''message'' is sometimes multiple lines; if it is, be sure to use quotes(''' ' ''' or ''' " ''')<br />
* '''[show_if]''': if present then this message will only be displayed if the conditional statement in this tag is passed (see [[ConditionalActionsWML#Condition_Tags|ConditionalActionsWML]])<br />
* '''side_for''': (default: all sides) comma-separated list of sides for who message is shown.<br />
* '''image''': (default: profile image of speaker) the image to display next to the message.<br />
* '''caption''': (default: name of speaker) the caption to display beside the image. Name to be displayed.<br />
* '''duration''': (default: 10) the minimum number of frames for this message to be displayed. (A frame lasts about 30 milliseconds.) During this time any dialog decisions will be disregarded.<br />
* '''sound''': a sound effect (wav file) to play as the message is displayed. This can be a comma-separated list, from which one will be randomly chosen.<br />
* '''[option]''': zero or more '''[option]''' elements may be present. If '''[option]''' elements are present, then each option will be displayed in a menu for the user to select one option.<br />
** '''message''': (translatable) the text displayed for the option (see [[DescriptionWML]])<br />
** '''[show_if]''': if present then this option will only be displayed if the conditional statement in this tag is passed (see [[InternalActionsWML]])<br />
** '''[command]''': an element containing actions which are executed if the option is selected.<br />
* '''[text_input]''': there can be only one [text_input] tag. this adds a text input field to the message.<br />
** '''variable''': the variable that the user's input will be written to<br />
** '''label''': a text label to the left of the input field<br />
** '''max_chars''': the maximum number of characters that may be typed into the field<br />
** '''text''': text that is written into the field in the beginning<br />
* Check [[EventWML#Multiplayer_safety]] to find out in which events you can safely use '''[option]''' and '''[text_input]''' without causing OOS.<br />
<br />
=== Formatting ===<br />
In 1.8, [http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html Pango markup formatting codes] have been adopted for '''[message]'''. These can also be used in unit names (user_description), objectives, and such. Note that you'll probably want to use a single quote ' instead of a double quote " as double quotes cannot be escaped, otherwise the string will appear fragmented and you may also encounter errors. Running wmllint on your campaign will up-convert it, warning you about unusual cases you must fix by hand.<br />
<br />
For example, if you wanted to write "You are victorious!" in large, italic, gold letters, you might write it this way:<br />
<br />
<nowiki><span color='#BCB088' size='large' font-style='italic'>You are victorious!</span></nowiki><br />
<br />
<br />
These are the codes taken from the Pango markup formatting guide:<br />
<br />
*'''font''', '''font_desc''': A font description string, such as "Sans Italic 12".<br />
*'''font_family''', '''face''': A font family name.<br />
*'''font_size''', '''size''': Font size in 1024ths of a point, or one of the absolute sizes 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large', or one of the relative sizes 'smaller' or 'larger'.<br />
*'''font_style''', '''style''': One of 'normal', 'oblique', 'italic'.<br />
*'''font_weight''', '''weight''': One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold', 'heavy', or a numeric weight.<br />
*'''font_variant''', '''variant''': One of 'normal' or 'smallcaps'.<br />
*'''font_stretch''', '''stretch''': One of 'ultracondensed', 'extracondensed', 'condensed', 'semicondensed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded', 'ultraexpanded'.<br />
*'''foreground''', '''fgcolor''', '''color''': An RGB color specification such as '#00FF00' or a color name such as 'red'.<br />
*'''background, bgcolor''': An RGB color specification such as '#00FF00' or a color name such as 'red'.<br />
*'''underline''': One of 'none', 'single', 'double', 'low', 'error'.<br />
*'''underline_color''': The color of underlines; an RGB color specification such as '#00FF00' or a color name such as 'red'.<br />
*'''rise''': Vertical displacement, in 10000ths of an em. Can be negative for subscript, positive for superscript.<br />
*'''strikethrough''': 'true' or 'false' whether to strike through the text.<br />
*'''strikethrough_color''': The color of strikethrough lines; an RGB color specification such as '#00FF00' or a color name such as 'red'<br />
*'''fallback''': 'true' or 'false' whether to enable fallback. If disabled, then characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text. Fallback is enabled by default. Most applications should not disable fallback.<br />
*'''letter_spacing''': Inter-letter spacing in 1024ths of a point.<br />
*'''gravity''': One of 'south', 'east', 'north', 'west', 'auto'.<br />
*'''gravity_hint''': One of 'natural', 'strong', 'line'.<br />
<br />
<br />
In 1.6, Wesnoth uses older text formatting options<br />
* A tilde (~) as the first character causes the line to be boldfaced.<br />
* An at symbol (@) as the first character causes the line to be green, as done with victory conditions.<br />
* A pound symbol (#) as the first character causes the line to be red, as done with defeat conditions.<br />
* An asterisk (*) as the first character causes the line to be bigger.<br />
* A backquote (`) as the first character causes the line to be smaller.<br />
* If used, the caption key text is boldfaced.<br />
* An RGB colour code in the beginning causes the line to be the given colour. This can still be preceded by the above characters. Example: ''message=_"<255,0,0>Red!"''<br />
<br />
== [objectives] ==<br />
The other tag used for plot development is '''[objectives]'''.<br />
The '''[objectives]''' tag overwrites any previously set objectives,<br />
and displays text which should describe the objectives of the scenario.<br />
Scenario objectives are displayed on the player's first turn after the tag is used,<br />
or as part of the event if it triggers during that player's turn.<br />
Objectives can also be accessed at any time in a scenario using the<br />
"Scenario Objectives" game menu option, making this tag useful for<br />
scenario-specific information that the player may need to refer to during play.<br />
<br />
This tag renders the ''objectives'' attribute of [scenario] obsolete (see ''objectives'', [[ScenarioWML]]).<br />
Instead of using ''objectives'', use '''[objectives]''' to set scenario objectives inside a prestart event.<br />
It can also be used to overwrite the starting objectives mid-scenario.<br />
<br />
Attributes of '''[objectives]''':<br />
* '''side''': Default '0'. The side to set the objectives for. A value of 0 sets objectives for all sides.<br />
* '''summary''': Displayed first in the objectives text, this should describe the basic objective for the overall scenario. Can be omitted.<br />
* '''note''': Displayed last in the objectives text, this is sometimes used for hints or additional information. Can be omitted.<br />
* '''victory_string''': Default ' _ "Victory:"', this text precedes the victory objectives.<br />
* '''defeat_string''': Default ' _ "Defeat:"', this text precedes the defeat objectives.<br />
* '''silent''': Default: not present. If set to "yes", the objectives are silently changed. Else, they will be shown to the user when appropriate.<br />
<br />
Tags of '''[objectives]''':<br />
* '''[objective]''': describes a win or loss condition. Most scenarios have multiple win or loss conditions, so use a separate [objective] subtag for each line; this helps with translations.<br />
** '''description''': text for the specific win or loss condition.<br />
** '''condition''': The color and placement of the text. Values are 'win'(colored green, placed after ''victory_string'') and 'lose'(colored red, placed after ''defeat_string'')<br />
** '''[show_if]''': A condition that disables the objective if it doesn't hold. Conditional objectives are refreshed at '''[show_objectives]''' time only. {{DevFeature}}<br />
<br />
=== Macros ===<br />
There are a few predefined macros for Objectives that you can use to shorten the code: [http://www.wesnoth.org/macro-reference.xhtml#SET_OBJECTIVES SET_OBJECTIVES], [http://www.wesnoth.org/macro-reference.xhtml#VICTORY_CONDITION VICTORY_CONDITION], and [http://www.wesnoth.org/macro-reference.xhtml#DEFEAT_CONDITION DEFEAT_CONDITION]. Follow the links for each one to see complete syntax and example usage.<br />
<br />
== [set_menu_item] ==<br />
This tag is used to add a custom option in the right-click context menu which can then be used to trigger arbitrary WML commands.<br />
<br />
'''Note:''' Due to limitations in portable devices where there are no scroll bars for context menus, there is a hard-coded limit of 7 custom WML menu items. If you really need to have more than 7 menu items, try combining some of them in a submenu.<br />
<br />
* '''id''': the unique id for this menu item. If a menu item with this id already exists, it allows you to set specific changes to that item.<br />
* '''description''': the in-game text that will appear for this item in the menu.<br />
* '''image''': the image to display next to this item.<br />
* '''needs_select''': if ''yes'' (default ''no''), then the latest select event (see [[EventWML]]) that triggered before this menu item was chosen will be transmitted over the network before this menu item action will be. This only has any effect in networked multiplayer, and is intended to allow more elaborate menu item behaviour there without causing out of sync errors. If you don't know what this means, just leave it false.<br />
* '''[show_if]''': If present, the menu item will only be available if the conditional statement (see [[InternalActionsWML]]) within evaluates to true. When this is evaluated, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked, so it's possible to for example only enable the option on empty hexes or on a particular unit.<br />
* '''[filter_location]''': contains a location filter similar to the one found inside Single Unit Filters (see [[FilterWML]]). The menu item will only be available on matching locations.<br />
* '''[command]''': contains the WML actions to be executed when the menu item is selected. Again, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked on.<br />
<br />
== Other interface tags ==<br />
<br />
The following tags are also action tags:<br />
* '''[item]''': makes a graphical item appear on a certain hex. Note this only places the graphics for an item. It does not make the item do anything. Use a moveto event to make moving onto the item do something. <tt>''('''Hint:''' There are a number of predefined items that are used in various campaigns that you can make use of. You can find [http://www.wesnoth.org/macro-reference.xhtml#file:items.cfg a list of them] if you look into the items.cfg file in the wesnoth install directory (under /data/core/macros))''</tt><br />
** '''x''', '''y''': the location to place the item.<br />
** '''image''': the image (in ''images/'' as .png) to place on the hex.<br />
** '''halo''': an image to place centered on the hex. Use this instead of ''image'' if the image is bigger than the hex or if you want to animate an image. ''Example (where the integer after the colon is the duration of each frame): halo=scenery/fire1.png:100,scenery/fire2.png:100,scenery/fire3.png:100,scenery/fire4.png:100,scenery/fire5.png:100,scenery/fire6.png:100,scenery/fire7.png:100,scenery/fire8.png:100''<br />
** '''team_name''': name of the team for which the item is to be displayed (hidden for others). For multiple teams just put all the names in one string, for example separated by commas.<br />
** '''visible_in_fog''': whether the item should be visible through fog or not. Default yes.<br />
* '''[removeitem]''': removes any graphical items on a given hex<br />
** '''x''', '''y''': the hex to remove items off<br />
** '''image''' if specified, only removes the given image item (This image name must include any [[ImagePathFunctionWML|image path functions]] appended to the original image name.)<br />
* '''[print]''': displays a message across the screen. The message will disappear after a certain time.<br />
** '''text''': (translatable) the text to display.<br />
** '''size''': (default=12) the pointsize of the font to use<br />
** '''duration''': (default=50) the length of time to display the text for. This is measured in the number of 'frames'. A frame in Wesnoth is usually displayed for around 30ms.<br />
** '''red''', '''green''', '''blue''': (default=0,0,0) the color to display the text in. Values vary from 0-255.<br />
* '''[move_unit_fake]''': moves an image of a unit along a certain path on the map. The path does not need to be a continuous list of adjacent hexes, so for example only the start and end points can be given, in which case the straightest line between those points will be calculated and used.<br />
** '''type''': the type of the unit whose image to use<br />
** '''x''': a comma-separated list of x locations to move along<br />
** '''y''': a comma-separated list of y locations to move along (x and y values are matched pairs)<br />
** '''side''': the side of the fake unit, used for team-coloring the fake unit<br />
* '''[hide_unit]''': makes the given unit become invisible. Useful in conjunction with '''[move_unit_fake]''': to move a leader unit into position on-screen. Each '''[hide_unit]''' tag only hides one unit.<br />
** '''x''', '''y''': location of the unit to be hidden. (NOT a standard unit filter! Just x and y.)<br />
* '''[unhide_unit]''': stops the currently hidden units from being hidden.<br />
* '''[scroll]''': Scroll a certain number of pixels in a given direction. Useful for earthquake/shaking effects.<br />
** '''x''', '''y''': the number of pixels to scroll along the x and y axis<br />
* '''[scroll_to]''': Scroll to a given hex<br />
** '''x''', '''y''': the hex to scroll to<br />
** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br />
* '''[scroll_to_unit]''' Scroll to a given unit<br />
** [[StandardUnitFilter]]<br />
** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br />
* '''[sound]''': Plays a sound<br />
** '''name''': the filename of the sound to play (in ''sounds/'' as .wav or .ogg)<br />
** '''repeat''': repeats the sound for a specified additional number of times (default=0)<br />
* '''[sound_source]''': Creates a sound source. "Sound sources" is a general name for a mechanism which makes possible for map elements to emit sounds according to some rules, where "map elements" can be specific locations or terrain types. For now, only sound sources tied to locations are supported.<br />
** '''id''': a unique identification key of the sound source<br />
** '''sounds''': a list of comma separated, randomly played sounds associated with the sound source<br />
** '''delay''': a numerical value (in milliseconds) of the minimal delay between two playbacks of the source's sound if the source remains visible on the screen; if one scrolls out and back in, the source will be considered as ready to play<br />
** '''chance''': a percentage (a value from 0 to 100) describing the chance of the source being activated every second after the delay has passed or when the source's location appears on the screen (note that it cannot play more than one file at the same time)<br />
** '''check_fogged''': possible values "true" and "false" - if true the source will not play if its locations are fogged<br />
** '''check_shrouded''': {{DevFeature}} possible values "true" and "false" - if true the source will not play if its locations are shrouded<br />
** '''x,y''': a [[StandardLocationFilter]] for the locations associated with the sound source<br />
** '''fade_range''' (default = 3): distance in hexes that determines a "circular" area around the one specified by '''full_range''' where sound volume fades out linearly<br />
** '''full_range''' (default = 14): distance in hexes that determines a "circular" area where source plays with full volume, relative to screen center<br />
** '''loop''': number of times a sound sample should be looped if it stays visible. -1 means infinite (~65000)<br />
* '''[remove_sound_source]''': Removes a previously defined sound source.<br />
** '''id''': the identification key of the sound source to remove<br />
* '''[music]''': Switches to playing different music<br />
** '''name''': the filename of the music to play (in ''music/'' as .ogg)<br />
** see [[MusicListWML]] for the correct syntax<br />
* '''[music_volume]''': {{DevFeature}} Changes the music volume.<br />
** '''value''': Changes the volume to this. Goes from 0 to 128.<br />
** '''relative''': Changes volume based on a percentage of the current value. For example, relative = 50 changes music volume to 50% of its value, while relative = 200 makes it double the volume.<br />
* '''[colour_adjust]''': tints the colour of the screen.<br />
** '''red''', '''green''', '''blue''': values from -255 to 255, the amount to tint by for each colour<br />
* '''[delay]''': pauses the game<br />
** '''time''': the time to pause in milliseconds<br />
* '''[redraw]''': redraws the screen (this normally isn't done during events, although some of the other interface actions cause the screen or parts of it to be redrawn).<br />
** '''side''': if used, recalculates fog and shroud for that side. Useful if you for example spawn friendly units in the middle of an event and want the shroud to update accordingly (otherwise units that spawn inside fog would remain invisible for the duration of the event, since the fog would not automatically get cleared around them).<br />
* '''[unit_overlay]''': sets an image that will be drawn over a particular unit, and follow it around<br />
** '''x''', '''y''': the location of the unit to overlay on<br />
** '''image''': the image to place on the unit<br />
* '''[remove_unit_overlay]''': removes a particular overlayed image from a unit<br />
** '''x''', '''y''': the location of the unit to remove an overlay from<br />
** '''image''': the image to remove from the unit<br />
* '''[animate_unit]''': Uses an animation of a unit to animate it on screen (if the unit has the corresponding animation).<br />
** '''flag''': The key to find the custom animation in the unit description (see the '''[extra_anim]''' description in [[AnimationWML]]). Standard animations can be triggered with the following keywords: ''leading recruited standing idling levelin levelout healing healed poisoned movement defend attack death victory pre_teleport post_teleport''<br />
** '''[filter]''' with a [[StandardUnitFilter]] as argument, see [[FilterWML]]. By default, the unit at the event location will be animated. You can use this tag to choose any other unit to animate.<br />
** '''[primary_attack]''': If this tag is not present, the filter for animation will be triggered with no attack. If it is here, all attacks from the unit will be filtered, and a matching one will be used to filter the animation. Takes a weapon filter as argument, see [[FilterWML]].<br />
** '''[secondary_attack]''': Similar to '''[primary_attack]'''. May be needed to trigger a defense animation correctly, if there are more than one animations available for the defending unit.<br />
** '''hits''': yes/no: whether the being-hit or being-not-hit variants of attack/defense animations are chosen<br />
** '''text''': a text to hover during the animation<br />
** '''red''': red value for the text color (0-255)<br />
** '''green''': green value for the text color<br />
** '''blue''': blue value for the text color<br />
** '''with_bars''': yes/no: whether to display the status bars during the animation (e.g. the hitpoint bar)<br />
** '''[animate]''': a sub block with the same syntax as '''[animate_unit]''' except that the '''[filter]''' block is mandatory to find the unit. This block will find and animate another unit simultaneously.<br />
** '''[facing]''': a [[StandardLocationFilter]] specifying what direction the unit should be facing when animated<br />
* '''[label]''' places a label on the map.<br />
** '''x''', '''y''': the location of the label<br />
** '''text''': what the label should say<br />
** '''team_name''': if specified, the label will only be visible to the given team.<br />
** '''colour''': color of the label. The format is r,g,b; r, g and b are numbers between 0 and 255. <br />
** '''visible_in_fog''': whether the label should be visible through fog or not. Default yes.<br />
** '''visible_in_shroud''': whether the label should be visible through shroud or not. Default no.<br />
* '''[deprecated_message]''' shows a deprecated message in the message area, this feature is only intended to be used to warn about deprecated macros in mainline. The message is not translatable.<br />
** '''message''': the message to show.<br />
* '''[wml_message]''' outputs a message to Wesnoth's console output. Intended for campaign designers to output silent text to the console, without annoying the player; then, that text might contain information useful for later bug-reporting. The log domain for it is '''wml''', and the '''debug/dbg''' log level is available for use with the '''logger''' attribute. Depending on the current log level ('''error''' by default), which may be changed with the in-game :log command, or the --log-<level>=wml command line switch, the messages are echoed to the in-game chat.<br />
** '''message''': the message to show.<br />
** '''logger''': the Wesnoth engine output logger that should catch the text; this might be 'err' (the errors log level), 'warn'/'wrn' (the warnings log level) or anything else (the information log level). Not all information will be displayed depending on the log level chosen when starting Wesnoth.<br />
* '''[open_help]''' opens the in-game help.<br />
** '''topic''': the id of the topic to open<br />
* '''[show_objectives]''': {{DevFeature}} refreshes the objectives defined by [objectives] and its [show_if] tags, and displays them. (It is also called whenever the user explicitly asks for the objectives; this matters only if the tag was overridden by a [[LuaWML#register_wml_action|Lua]] script.)<br />
** '''side''': the side to show the objectives. If not set, all sides are used.<br />
<br />
== Useful Macros ==<br />
There are some predefined macros that you find useful for interface actions. You can find a complete list along with a detailed explanation of how they work [http://www.wesnoth.org/macro-reference.xhtml here].<br />
* '''{FLOATING_TEXT}''' Float some text over a unit similar to the damage numbers.<br />
* '''{HIGHLIGHT_UNIT}''' Highlight a unit on the map. Use this to show important units<br />
* '''{HIGHLIGHT_IMAGE}''' Places and highlights an image on the map. Use this to show important items or locations<br />
* '''{SET_IMAGE}''' Places an image on the map which has no other function.<br />
* '''{QUAKE <soundfile>}''' Creates a tremor like screenshake and plays <soundfile>. ('''{TREMOR}''' is a deprecated version, equivalent to '''{QUAKE (rumble.ogg)}''')<br />
* '''{FLASH_WHITE}''' Flash the screen white momentarily. You can also replace WHITE with RED, BLUE or GREEN for a different colour.<br />
<br />
== See Also ==<br />
* [[DirectActionsWML]]<br />
* [[InternalActionsWML]]<br />
* [[EventWML]]<br />
* [[ReferenceWML]]<br />
<br />
<br />
[[Category: WML Reference]]<br />
[[Category: ActionsWML]]</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=36040SummerOfCodeProposal lfernando2010-04-12T19:56:28Z<p>Lfernando: </p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Posted a prototype implementation of SP persistency at https://gna.org/patch/?1620. A previous small example of that is on http://wesnoth.pastebin.com/sHSrCPqW.<br />
<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For example, you could use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there, along with any items he had and quests he did. And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous games.<br />
<br />
Conceptually, MP player persistency is very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be fairly straightforward.<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage. This kind of MP persistency involves data being with the "map", instead of with the "players". We will call it MP playerless persistency, and it should allow a kind of scenario that "changes" as different users play it.<br />
<br />
Here is an example of this kind of application by Crab_: <br />
<br />
"Imagine a game where there's a 'game master' - who creates a scenario, where you, for example, as a captain of a royal army, play for loyalists vs orcs. and then, if you win, the 'game master' changes the 'geopolitical map' to represent the fact that the border was defended, and orcs were defeated. Or imagine several games played in parallel, where you can transition from one game to another 'right-in-the-middle' (e..g, the gamemaster can store your units in one game and spawn them in another). and, it will not be hardcoded in c++ code. Every rule, every fantasy, can be achieved in wml, if we give a 'language' for it and implement engine support. "<br />
<br />
So, my project would be to:<br />
<br />
# Implement SP persistency. <br />
# Implement MP player persistency.<br />
# Implement MP playerless persistency.<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
<br />
On default, the player is the one who's playing the turn. There should be a special side value for storing data on the server/gamemaster.<br />
<br />
<br />
*'''namespace''': Used for determining from which file this variable should be loaded.<br />
<br />
As for now, we want to use different namespaces for different add-ons, and different files for different namespaces. On default it should write to the file of the add-on being played. But we want to maintain flexibility, especially regarding the "default" namespace, which should store the "real global" variables.<br />
<br />
It still can support things like "On add-on A, load this variable from add-on B and save it on add-on C." But it should be some kind of "unholy" operation and not be encouraged unless you really know what you're doing. =) <br />
<br />
<br />
*'''from_global''': Determines the name of the global variable that is loaded.<br />
<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo. <br />
<br />
===Sample File===<br />
Global variable files should have very simple wml syntax. Here goes an example:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Playerless Persistency and the Gamemaster==<br />
<br />
Implementing SP and MP player persistency is just a matter of recording game values somewhere. Implementing MP playerless persistency, however, is trickier, since we need another place to store our data which is not on user data.<br />
<br />
We plan to make a MP bot called a gamemaster. It can create games on demand, and watch their status. So, we want to make the GM able to launch several "headless" wesnoth instances on MP.<br />
<br />
Storing the data in simple WML files as we want to do on SP and player MP persistency can lead to some problems. Most of them are related to concurrent operations. If more than one game writes to a same file, it could lead to possible mismatches if it is not handled properly. So one solution would be handling concurrent operations in a ad-hoc way, making special code to deal with it.<br />
<br />
A better one would be using a database to store the variables. So, on GM mode launch, we would simultaneously launch a database, and all data operations that concern the gamemaster player would be done on this database. A relational or key-value database would do the trick here. <br />
<br />
So, this "gamemaster" here is less of a guy who interferes with the gameworld ("Behold! All goblins were turned to frogs by the Gamemaster!") and more like a special observer that can record game values. The interefering gamemaster is already supported and made possible by the events engine.<br />
<br />
===Example===<br />
So, suppose we want to host that world war add-on. We have 3 scenarios:<br />
<br />
*RebelsxDrakes.cfg<br />
*LoyalistsxNortherners.cfg<br />
*KnalganxUndead.cfg <br />
<br />
First I launch wesnoth on gamemaster mode.<br />
<br />
*./wesnoth --gm<br />
<br />
That launches the database too. And once I connect on the MP server, my GM will connect as well.<br />
<br />
*lfernando joins the lobby.<br />
*lfernando-GM joins the lobby.<br />
<br />
So, I ask my GM to create a couple of games.<br />
<br />
*lfernando: /w lfernando-GM create KnalganxUndead.cfg <br />
*lfernando: /w lfernando-GM create RebelsxDrakes.cfg<br />
<br />
Players can join the games, and all data collected goes to the database.<br />
<br />
This idea is still subject to further changes, and we want to fine-tune the details as we discuss it more.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=36005SummerOfCodeProposal lfernando2010-04-11T17:18:12Z<p>Lfernando: /* Questionnaire */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/sHSrCPqW.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For example, you could use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there, along with any items he had and quests he did. And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous games.<br />
<br />
Conceptually, MP player persistency is very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be fairly straightforward.<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage. This kind of MP persistency involves data being with the "map", instead of with the "players". We will call it MP playerless persistency, and it should allow a kind of scenario that "changes" as different users play it.<br />
<br />
Here is an example of this kind of application by Crab_: <br />
<br />
"Imagine a game where there's a 'game master' - who creates a scenario, where you, for example, as a captain of a royal army, play for loyalists vs orcs. and then, if you win, the 'game master' changes the 'geopolitical map' to represent the fact that the border was defended, and orcs were defeated. Or imagine several games played in parallel, where you can transition from one game to another 'right-in-the-middle' (e..g, the gamemaster can store your units in one game and spawn them in another). and, it will not be hardcoded in c++ code. Every rule, every fantasy, can be achieved in wml, if we give a 'language' for it and implement engine support. "<br />
<br />
So, my project would be to:<br />
<br />
# Implement SP persistency. <br />
# Implement MP player persistency.<br />
# Implement MP playerless persistency.<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
<br />
On default, the player is the one who's playing the turn. There should be a special side value for storing data on the server/gamemaster.<br />
<br />
<br />
*'''namespace''': Used for determining from which file this variable should be loaded.<br />
<br />
As for now, we want to use different namespaces for different add-ons, and different files for different namespaces. On default it should write to the file of the add-on being played. But we want to maintain flexibility, especially regarding the "default" namespace, which should store the "real global" variables.<br />
<br />
It still can support things like "On add-on A, load this variable from add-on B and save it on add-on C." But it should be some kind of "unholy" operation and not be encouraged unless you really know what you're doing. =) <br />
<br />
<br />
*'''from_global''': Determines the name of the global variable that is loaded.<br />
<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo. <br />
<br />
===Sample File===<br />
Global variable files should have very simple wml syntax. Here goes an example:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Playerless Persistency and the Gamemaster==<br />
<br />
Implementing SP and MP player persistency is just a matter of recording game values somewhere. Implementing MP playerless persistency, however, is trickier, since we need another place to store our data which is not on user data.<br />
<br />
We plan to make a MP bot called a gamemaster. It can create games on demand, and watch their status. So, we want to make the GM able to launch several "headless" wesnoth instances on MP.<br />
<br />
Storing the data in simple WML files as we want to do on SP and player MP persistency can lead to some problems. Most of them are related to concurrent operations. If more than one game writes to a same file, it could lead to possible mismatches if it is not handled properly. So one solution would be handling concurrent operations in a ad-hoc way, making special code to deal with it.<br />
<br />
A better one would be using a database to store the variables. So, on GM mode launch, we would simultaneously launch a database, and all data operations that concern the gamemaster player would be done on this database. A relational or key-value database would do the trick here. <br />
<br />
So, this "gamemaster" here is less of a guy who interferes with the gameworld ("Behold! All goblins were turned to frogs by the Gamemaster!") and more like a special observer that can record game values. The interefering gamemaster is already supported and made possible by the events engine.<br />
<br />
===Example===<br />
So, suppose we want to host that world war add-on. We have 3 scenarios:<br />
<br />
*RebelsxDrakes.cfg<br />
*LoyalistsxNortherners.cfg<br />
*KnalganxUndead.cfg <br />
<br />
First I launch wesnoth on gamemaster mode.<br />
<br />
*./wesnoth --gm<br />
<br />
That launches the database too. And once I connect on the MP server, my GM will connect as well.<br />
<br />
*lfernando joins the lobby.<br />
*lfernando-GM joins the lobby.<br />
<br />
So, I ask my GM to create a couple of games.<br />
<br />
*lfernando: /w lfernando-GM create KnalganxUndead.cfg <br />
*lfernando: /w lfernando-GM create RebelsxDrakes.cfg<br />
<br />
Players can join the games, and all data collected goes to the database.<br />
<br />
This idea is still subject to further changes, and we want to fine-tune the details as we discuss it more.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=36003SummerOfCodeProposal lfernando2010-04-11T16:30:20Z<p>Lfernando: /* Example */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For example, you could use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there, along with any items he had and quests he did. And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous games.<br />
<br />
Conceptually, MP player persistency is very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be fairly straightforward.<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage. This kind of MP persistency involves data being with the "map", instead of with the "players". We will call it MP playerless persistency, and it should allow a kind of scenario that "changes" as different users play it.<br />
<br />
Here is an example of this kind of application by Crab_: <br />
<br />
"Imagine a game where there's a 'game master' - who creates a scenario, where you, for example, as a captain of a royal army, play for loyalists vs orcs. and then, if you win, the 'game master' changes the 'geopolitical map' to represent the fact that the border was defended, and orcs were defeated. Or imagine several games played in parallel, where you can transition from one game to another 'right-in-the-middle' (e..g, the gamemaster can store your units in one game and spawn them in another). and, it will not be hardcoded in c++ code. Every rule, every fantasy, can be achieved in wml, if we give a 'language' for it and implement engine support. "<br />
<br />
So, my project would be to:<br />
<br />
# Implement SP persistency. <br />
# Implement MP player persistency.<br />
# Implement MP playerless persistency.<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
<br />
On default, the player is the one who's playing the turn. There should be a special side value for storing data on the server/gamemaster.<br />
<br />
<br />
*'''namespace''': Used for determining from which file this variable should be loaded.<br />
<br />
As for now, we want to use different namespaces for different add-ons, and different files for different namespaces. On default it should write to the file of the add-on being played. But we want to maintain flexibility, especially regarding the "default" namespace, which should store the "real global" variables.<br />
<br />
It still can support things like "On add-on A, load this variable from add-on B and save it on add-on C." But it should be some kind of "unholy" operation and not be encouraged unless you really know what you're doing. =) <br />
<br />
<br />
*'''from_global''': Determines the name of the global variable that is loaded.<br />
<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo. <br />
<br />
===Sample File===<br />
Global variable files should have very simple wml syntax. Here goes an example:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Playerless Persistency and the Gamemaster==<br />
<br />
Implementing SP and MP player persistency is just a matter of recording game values somewhere. Implementing MP playerless persistency, however, is trickier, since we need another place to store our data which is not on user data.<br />
<br />
We plan to make a MP bot called a gamemaster. It can create games on demand, and watch their status. So, we want to make the GM able to launch several "headless" wesnoth instances on MP.<br />
<br />
Storing the data in simple WML files as we want to do on SP and player MP persistency can lead to some problems. Most of them are related to concurrent operations. If more than one game writes to a same file, it could lead to possible mismatches if it is not handled properly. So one solution would be handling concurrent operations in a ad-hoc way, making special code to deal with it.<br />
<br />
A better one would be using a database to store the variables. So, on GM mode launch, we would simultaneously launch a database, and all data operations that concern the gamemaster player would be done on this database. A relational or key-value database would do the trick here. <br />
<br />
So, this "gamemaster" here is less of a guy who interferes with the gameworld ("Behold! All goblins were turned to frogs by the Gamemaster!") and more like a special observer that can record game values. The interefering gamemaster is already supported and made possible by the events engine.<br />
<br />
===Example===<br />
So, suppose we want to host that world war add-on. We have 3 scenarios:<br />
<br />
*RebelsxDrakes.cfg<br />
*LoyalistsxNortherners.cfg<br />
*KnalganxUndead.cfg <br />
<br />
First I launch wesnoth on gamemaster mode.<br />
<br />
*./wesnoth --gm<br />
<br />
That launches the database too. And once I connect on the MP server, my GM will connect as well.<br />
<br />
*lfernando joins the lobby.<br />
*lfernando-GM joins the lobby.<br />
<br />
So, I ask my GM to create a couple of games.<br />
<br />
*lfernando: /w lfernando-GM create KnalganxUndead.cfg <br />
*lfernando: /w lfernando-GM create RebelsxDrakes.cfg<br />
<br />
Players can join the games, and all data collected goes to the database.<br />
<br />
This idea is still subject to further changes, and we want to fine-tune the details as we discuss it more.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=36002SummerOfCodeProposal lfernando2010-04-11T16:29:03Z<p>Lfernando: /* Example */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For example, you could use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there, along with any items he had and quests he did. And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous games.<br />
<br />
Conceptually, MP player persistency is very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be fairly straightforward.<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage. This kind of MP persistency involves data being with the "map", instead of with the "players". We will call it MP playerless persistency, and it should allow a kind of scenario that "changes" as different users play it.<br />
<br />
Here is an example of this kind of application by Crab_: <br />
<br />
"Imagine a game where there's a 'game master' - who creates a scenario, where you, for example, as a captain of a royal army, play for loyalists vs orcs. and then, if you win, the 'game master' changes the 'geopolitical map' to represent the fact that the border was defended, and orcs were defeated. Or imagine several games played in parallel, where you can transition from one game to another 'right-in-the-middle' (e..g, the gamemaster can store your units in one game and spawn them in another). and, it will not be hardcoded in c++ code. Every rule, every fantasy, can be achieved in wml, if we give a 'language' for it and implement engine support. "<br />
<br />
So, my project would be to:<br />
<br />
# Implement SP persistency. <br />
# Implement MP player persistency.<br />
# Implement MP playerless persistency.<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
<br />
On default, the player is the one who's playing the turn. There should be a special side value for storing data on the server/gamemaster.<br />
<br />
<br />
*'''namespace''': Used for determining from which file this variable should be loaded.<br />
<br />
As for now, we want to use different namespaces for different add-ons, and different files for different namespaces. On default it should write to the file of the add-on being played. But we want to maintain flexibility, especially regarding the "default" namespace, which should store the "real global" variables.<br />
<br />
It still can support things like "On add-on A, load this variable from add-on B and save it on add-on C." But it should be some kind of "unholy" operation and not be encouraged unless you really know what you're doing. =) <br />
<br />
<br />
*'''from_global''': Determines the name of the global variable that is loaded.<br />
<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo. <br />
<br />
===Sample File===<br />
Global variable files should have very simple wml syntax. Here goes an example:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Playerless Persistency and the Gamemaster==<br />
<br />
Implementing SP and MP player persistency is just a matter of recording game values somewhere. Implementing MP playerless persistency, however, is trickier, since we need another place to store our data which is not on user data.<br />
<br />
We plan to make a MP bot called a gamemaster. It can create games on demand, and watch their status. So, we want to make the GM able to launch several "headless" wesnoth instances on MP.<br />
<br />
Storing the data in simple WML files as we want to do on SP and player MP persistency can lead to some problems. Most of them are related to concurrent operations. If more than one game writes to a same file, it could lead to possible mismatches if it is not handled properly. So one solution would be handling concurrent operations in a ad-hoc way, making special code to deal with it.<br />
<br />
A better one would be using a database to store the variables. So, on GM mode launch, we would simultaneously launch a database, and all data operations that concern the gamemaster player would be done on this database. A relational or key-value database would do the trick here. <br />
<br />
So, this "gamemaster" here is less of a guy who interferes with the gameworld ("Behold! All goblins were turned to frogs by the Gamemaster!") and more like a special observer that can record game values. The interefering gamemaster is already supported and made possible by the events engine.<br />
<br />
===Example===<br />
So, suppose we want to host that world war add-on. We have 3 scenarios:<br />
<br />
*RebelsxDrakes.cfg<br />
*LoyalistsxNortherners.cfg<br />
*KnalganxUndead.cfg <br />
<br />
First I launch wesnoth on gamemaster mode.<br />
<br />
*./wesnoth --gm<br />
<br />
That launches the database too. And once I connect on the MP server, my GM will connect as well.<br />
<br />
*lfernando joins the lobby.<br />
*lfernando-GM joins the lobby.<br />
<br />
So, I ask my GM to create a couple of games.<br />
<br />
*lfernando: /w lfernando-GM create KnalganxUndead.cfg <br />
*lfernando: /w lfernando-GM create RebelsxDrakes.cfg<br />
<br />
This idea is still subject to further changes, and we want to fine-tune the details as we discuss it more.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=36001SummerOfCodeProposal lfernando2010-04-11T16:28:43Z<p>Lfernando: /* Example */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For example, you could use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there, along with any items he had and quests he did. And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous games.<br />
<br />
Conceptually, MP player persistency is very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be fairly straightforward.<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage. This kind of MP persistency involves data being with the "map", instead of with the "players". We will call it MP playerless persistency, and it should allow a kind of scenario that "changes" as different users play it.<br />
<br />
Here is an example of this kind of application by Crab_: <br />
<br />
"Imagine a game where there's a 'game master' - who creates a scenario, where you, for example, as a captain of a royal army, play for loyalists vs orcs. and then, if you win, the 'game master' changes the 'geopolitical map' to represent the fact that the border was defended, and orcs were defeated. Or imagine several games played in parallel, where you can transition from one game to another 'right-in-the-middle' (e..g, the gamemaster can store your units in one game and spawn them in another). and, it will not be hardcoded in c++ code. Every rule, every fantasy, can be achieved in wml, if we give a 'language' for it and implement engine support. "<br />
<br />
So, my project would be to:<br />
<br />
# Implement SP persistency. <br />
# Implement MP player persistency.<br />
# Implement MP playerless persistency.<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
<br />
On default, the player is the one who's playing the turn. There should be a special side value for storing data on the server/gamemaster.<br />
<br />
<br />
*'''namespace''': Used for determining from which file this variable should be loaded.<br />
<br />
As for now, we want to use different namespaces for different add-ons, and different files for different namespaces. On default it should write to the file of the add-on being played. But we want to maintain flexibility, especially regarding the "default" namespace, which should store the "real global" variables.<br />
<br />
It still can support things like "On add-on A, load this variable from add-on B and save it on add-on C." But it should be some kind of "unholy" operation and not be encouraged unless you really know what you're doing. =) <br />
<br />
<br />
*'''from_global''': Determines the name of the global variable that is loaded.<br />
<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo. <br />
<br />
===Sample File===<br />
Global variable files should have very simple wml syntax. Here goes an example:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Playerless Persistency and the Gamemaster==<br />
<br />
Implementing SP and MP player persistency is just a matter of recording game values somewhere. Implementing MP playerless persistency, however, is trickier, since we need another place to store our data which is not on user data.<br />
<br />
We plan to make a MP bot called a gamemaster. It can create games on demand, and watch their status. So, we want to make the GM able to launch several "headless" wesnoth instances on MP.<br />
<br />
Storing the data in simple WML files as we want to do on SP and player MP persistency can lead to some problems. Most of them are related to concurrent operations. If more than one game writes to a same file, it could lead to possible mismatches if it is not handled properly. So one solution would be handling concurrent operations in a ad-hoc way, making special code to deal with it.<br />
<br />
A better one would be using a database to store the variables. So, on GM mode launch, we would simultaneously launch a database, and all data operations that concern the gamemaster player would be done on this database. A relational or key-value database would do the trick here. <br />
<br />
So, this "gamemaster" here is less of a guy who interferes with the gameworld ("Behold! All goblins were turned to frogs by the Gamemaster!") and more like a special observer that can record game values. The interefering gamemaster is already supported and made possible by the events engine.<br />
<br />
===Example===<br />
So, suppose we want to host that world war add-on. We have 3 scenarios:<br />
<br />
*RebelsxDrakes.cfg<br />
*LoyalistsxNortherners.cfg<br />
*KnalganxUndead.cfg <br />
<br />
First I launch wesnoth on gamemaster mode.<br />
<br />
./wesnoth --gm<br />
<br />
That launches the database too. And once I connect on the MP server, my GM will connect as well.<br />
<br />
*lfernando joins the lobby.<br />
*lfernando-GM joins the lobby.<br />
<br />
So, I ask my GM to create a couple of games.<br />
<br />
*lfernando: /w lfernando-GM create KnalganxUndead.cfg <br />
*lfernando: /w lfernando-GM create RebelsxDrakes.cfg<br />
<br />
This idea is still subject to further changes, and we want to fine-tune the details as we discuss it more.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=36000SummerOfCodeProposal lfernando2010-04-11T16:28:17Z<p>Lfernando: /* Example */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For example, you could use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there, along with any items he had and quests he did. And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous games.<br />
<br />
Conceptually, MP player persistency is very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be fairly straightforward.<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage. This kind of MP persistency involves data being with the "map", instead of with the "players". We will call it MP playerless persistency, and it should allow a kind of scenario that "changes" as different users play it.<br />
<br />
Here is an example of this kind of application by Crab_: <br />
<br />
"Imagine a game where there's a 'game master' - who creates a scenario, where you, for example, as a captain of a royal army, play for loyalists vs orcs. and then, if you win, the 'game master' changes the 'geopolitical map' to represent the fact that the border was defended, and orcs were defeated. Or imagine several games played in parallel, where you can transition from one game to another 'right-in-the-middle' (e..g, the gamemaster can store your units in one game and spawn them in another). and, it will not be hardcoded in c++ code. Every rule, every fantasy, can be achieved in wml, if we give a 'language' for it and implement engine support. "<br />
<br />
So, my project would be to:<br />
<br />
# Implement SP persistency. <br />
# Implement MP player persistency.<br />
# Implement MP playerless persistency.<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
<br />
On default, the player is the one who's playing the turn. There should be a special side value for storing data on the server/gamemaster.<br />
<br />
<br />
*'''namespace''': Used for determining from which file this variable should be loaded.<br />
<br />
As for now, we want to use different namespaces for different add-ons, and different files for different namespaces. On default it should write to the file of the add-on being played. But we want to maintain flexibility, especially regarding the "default" namespace, which should store the "real global" variables.<br />
<br />
It still can support things like "On add-on A, load this variable from add-on B and save it on add-on C." But it should be some kind of "unholy" operation and not be encouraged unless you really know what you're doing. =) <br />
<br />
<br />
*'''from_global''': Determines the name of the global variable that is loaded.<br />
<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo. <br />
<br />
===Sample File===<br />
Global variable files should have very simple wml syntax. Here goes an example:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Playerless Persistency and the Gamemaster==<br />
<br />
Implementing SP and MP player persistency is just a matter of recording game values somewhere. Implementing MP playerless persistency, however, is trickier, since we need another place to store our data which is not on user data.<br />
<br />
We plan to make a MP bot called a gamemaster. It can create games on demand, and watch their status. So, we want to make the GM able to launch several "headless" wesnoth instances on MP.<br />
<br />
Storing the data in simple WML files as we want to do on SP and player MP persistency can lead to some problems. Most of them are related to concurrent operations. If more than one game writes to a same file, it could lead to possible mismatches if it is not handled properly. So one solution would be handling concurrent operations in a ad-hoc way, making special code to deal with it.<br />
<br />
A better one would be using a database to store the variables. So, on GM mode launch, we would simultaneously launch a database, and all data operations that concern the gamemaster player would be done on this database. A relational or key-value database would do the trick here. <br />
<br />
So, this "gamemaster" here is less of a guy who interferes with the gameworld ("Behold! All goblins were turned to frogs by the Gamemaster!") and more like a special observer that can record game values. The interefering gamemaster is already supported and made possible by the events engine.<br />
<br />
===Example===<br />
So, suppose we want to host that world war add-on. We have 3 scenarios:<br />
<br />
*RebelsxDrakes.cfg<br />
*LoyalistsxNortherners.cfg<br />
*KnalganxUndead.cfg <br />
<br />
First I launch wesnoth on gamemaster mode.<br />
<br />
./wesnoth --gm<br />
<br />
That launches the database too. And once I connect on the MP server, my GM will connect as well.<br />
<br />
lfernando joins the lobby.<br />
lfernando-GM joins the lobby.<br />
<br />
So, I ask my GM to create a couple of games.<br />
<br />
lfernando: /w lfernando-GM create KnalganxUndead.cfg <br />
lfernando: /w lfernando-GM create RebelsxDrakes.cfg<br />
<br />
This idea is still subject to further changes, and we want to fine-tune the details as we discuss it more.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35999SummerOfCodeProposal lfernando2010-04-11T16:27:41Z<p>Lfernando: /* Gamemaster */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For example, you could use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there, along with any items he had and quests he did. And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous games.<br />
<br />
Conceptually, MP player persistency is very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be fairly straightforward.<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage. This kind of MP persistency involves data being with the "map", instead of with the "players". We will call it MP playerless persistency, and it should allow a kind of scenario that "changes" as different users play it.<br />
<br />
Here is an example of this kind of application by Crab_: <br />
<br />
"Imagine a game where there's a 'game master' - who creates a scenario, where you, for example, as a captain of a royal army, play for loyalists vs orcs. and then, if you win, the 'game master' changes the 'geopolitical map' to represent the fact that the border was defended, and orcs were defeated. Or imagine several games played in parallel, where you can transition from one game to another 'right-in-the-middle' (e..g, the gamemaster can store your units in one game and spawn them in another). and, it will not be hardcoded in c++ code. Every rule, every fantasy, can be achieved in wml, if we give a 'language' for it and implement engine support. "<br />
<br />
So, my project would be to:<br />
<br />
# Implement SP persistency. <br />
# Implement MP player persistency.<br />
# Implement MP playerless persistency.<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
<br />
On default, the player is the one who's playing the turn. There should be a special side value for storing data on the server/gamemaster.<br />
<br />
<br />
*'''namespace''': Used for determining from which file this variable should be loaded.<br />
<br />
As for now, we want to use different namespaces for different add-ons, and different files for different namespaces. On default it should write to the file of the add-on being played. But we want to maintain flexibility, especially regarding the "default" namespace, which should store the "real global" variables.<br />
<br />
It still can support things like "On add-on A, load this variable from add-on B and save it on add-on C." But it should be some kind of "unholy" operation and not be encouraged unless you really know what you're doing. =) <br />
<br />
<br />
*'''from_global''': Determines the name of the global variable that is loaded.<br />
<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo. <br />
<br />
===Sample File===<br />
Global variable files should have very simple wml syntax. Here goes an example:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Playerless Persistency and the Gamemaster==<br />
<br />
Implementing SP and MP player persistency is just a matter of recording game values somewhere. Implementing MP playerless persistency, however, is trickier, since we need another place to store our data which is not on user data.<br />
<br />
We plan to make a MP bot called a gamemaster. It can create games on demand, and watch their status. So, we want to make the GM able to launch several "headless" wesnoth instances on MP.<br />
<br />
Storing the data in simple WML files as we want to do on SP and player MP persistency can lead to some problems. Most of them are related to concurrent operations. If more than one game writes to a same file, it could lead to possible mismatches if it is not handled properly. So one solution would be handling concurrent operations in a ad-hoc way, making special code to deal with it.<br />
<br />
A better one would be using a database to store the variables. So, on GM mode launch, we would simultaneously launch a database, and all data operations that concern the gamemaster player would be done on this database. A relational or key-value database would do the trick here. <br />
<br />
So, this "gamemaster" here is less of a guy who interferes with the gameworld ("Behold! All goblins were turned to frogs by the Gamemaster!") and more like a special observer that can record game values. The interefering gamemaster is already supported and made possible by the events engine.<br />
<br />
===Example===<br />
So, suppose we want to host that world war add-on. We have 3 scenarios:<br />
<br />
RebelsxDrakes.cfg<br />
LoyalistsxNortherners.cfg<br />
KnalganxUndead.cfg <br />
<br />
First I launch wesnoth on gamemaster mode.<br />
<br />
./wesnoth --gm<br />
<br />
That launches the database too. And once I connect on the MP server, my GM will connect as well.<br />
<br />
lfernando joins the lobby.<br />
lfernando-GM joins the lobby.<br />
<br />
So, I ask my GM to create a couple of games.<br />
<br />
lfernando: /w lfernando-GM create KnalganxUndead.cfg <br />
lfernando: /w lfernando-GM create RebelsxDrakes.cfg<br />
<br />
This idea is still subject to further changes, and we want to fine-tune the details as we discuss it more.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35980SummerOfCodeProposal lfernando2010-04-10T19:37:06Z<p>Lfernando: /* [Sample File] */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For example, you could use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there, along with any items he had and quests he did. And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous games.<br />
<br />
Conceptually, MP player persistency is very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be fairly straightforward.<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage. This kind of MP persistency involves data being with the "map", instead of with the "players". We will call it MP playerless persistency, and it should allow a kind of scenario that "changes" as different users play it.<br />
<br />
Here is an example of this kind of application by Crab_: <br />
<br />
"Imagine a game where there's a 'game master' - who creates a scenario, where you, for example, as a captain of a royal army, play for loyalists vs orcs. and then, if you win, the 'game master' changes the 'geopolitical map' to represent the fact that the border was defended, and orcs were defeated. Or imagine several games played in parallel, where you can transition from one game to another 'right-in-the-middle' (e..g, the gamemaster can store your units in one game and spawn them in another). and, it will not be hardcoded in c++ code. Every rule, every fantasy, can be achieved in wml, if we give a 'language' for it and implement engine support. "<br />
<br />
So, my project would be to:<br />
<br />
# Implement SP persistency. <br />
# Implement MP player persistency.<br />
# Implement MP playerless persistency.<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
<br />
On default, the player is the one who's playing the turn. There should be a special side value for storing data on the server/gamemaster.<br />
<br />
<br />
*'''namespace''': Used for determining from which file this variable should be loaded.<br />
<br />
As for now, we want to use different namespaces for different add-ons, and different files for different namespaces. On default it should write to the file of the add-on being played. But we want to maintain flexibility, especially regarding the "default" namespace, which should store the "real global" variables.<br />
<br />
It still can support things like "On add-on A, load this variable from add-on B and save it on add-on C." But it should be some kind of "unholy" operation and not be encouraged unless you really know what you're doing. =) <br />
<br />
<br />
*'''from_global''': Determines the name of the global variable that is loaded.<br />
<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo. <br />
<br />
===Sample File===<br />
Global variable files should have very simple wml syntax. Here goes an example:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store MP data on a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35979SummerOfCodeProposal lfernando2010-04-10T19:36:55Z<p>Lfernando: /* WML Syntax */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For example, you could use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there, along with any items he had and quests he did. And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous games.<br />
<br />
Conceptually, MP player persistency is very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be fairly straightforward.<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage. This kind of MP persistency involves data being with the "map", instead of with the "players". We will call it MP playerless persistency, and it should allow a kind of scenario that "changes" as different users play it.<br />
<br />
Here is an example of this kind of application by Crab_: <br />
<br />
"Imagine a game where there's a 'game master' - who creates a scenario, where you, for example, as a captain of a royal army, play for loyalists vs orcs. and then, if you win, the 'game master' changes the 'geopolitical map' to represent the fact that the border was defended, and orcs were defeated. Or imagine several games played in parallel, where you can transition from one game to another 'right-in-the-middle' (e..g, the gamemaster can store your units in one game and spawn them in another). and, it will not be hardcoded in c++ code. Every rule, every fantasy, can be achieved in wml, if we give a 'language' for it and implement engine support. "<br />
<br />
So, my project would be to:<br />
<br />
# Implement SP persistency. <br />
# Implement MP player persistency.<br />
# Implement MP playerless persistency.<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
<br />
On default, the player is the one who's playing the turn. There should be a special side value for storing data on the server/gamemaster.<br />
<br />
<br />
*'''namespace''': Used for determining from which file this variable should be loaded.<br />
<br />
As for now, we want to use different namespaces for different add-ons, and different files for different namespaces. On default it should write to the file of the add-on being played. But we want to maintain flexibility, especially regarding the "default" namespace, which should store the "real global" variables.<br />
<br />
It still can support things like "On add-on A, load this variable from add-on B and save it on add-on C." But it should be some kind of "unholy" operation and not be encouraged unless you really know what you're doing. =) <br />
<br />
<br />
*'''from_global''': Determines the name of the global variable that is loaded.<br />
<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo. <br />
<br />
===[Sample File]===<br />
Global variable files should have very simple wml syntax. Here goes an example:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store MP data on a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35978SummerOfCodeProposal lfernando2010-04-10T19:35:27Z<p>Lfernando: /* [clear_global_variable] */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For example, you could use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there, along with any items he had and quests he did. And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous games.<br />
<br />
Conceptually, MP player persistency is very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be fairly straightforward.<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage. This kind of MP persistency involves data being with the "map", instead of with the "players". We will call it MP playerless persistency, and it should allow a kind of scenario that "changes" as different users play it.<br />
<br />
Here is an example of this kind of application by Crab_: <br />
<br />
"Imagine a game where there's a 'game master' - who creates a scenario, where you, for example, as a captain of a royal army, play for loyalists vs orcs. and then, if you win, the 'game master' changes the 'geopolitical map' to represent the fact that the border was defended, and orcs were defeated. Or imagine several games played in parallel, where you can transition from one game to another 'right-in-the-middle' (e..g, the gamemaster can store your units in one game and spawn them in another). and, it will not be hardcoded in c++ code. Every rule, every fantasy, can be achieved in wml, if we give a 'language' for it and implement engine support. "<br />
<br />
So, my project would be to:<br />
<br />
# Implement SP persistency. <br />
# Implement MP player persistency.<br />
# Implement MP playerless persistency.<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
<br />
On default, the player is the one who's playing the turn. There should be a special side value for storing data on the server/gamemaster.<br />
<br />
<br />
*'''namespace''': Used for determining from which file this variable should be loaded.<br />
<br />
As for now, we want to use different namespaces for different add-ons, and different files for different namespaces. On default it should write to the file of the add-on being played. But we want to maintain flexibility, especially regarding the "default" namespace, which should store the "real global" variables.<br />
<br />
It still can support things like "On add-on A, load this variable from add-on B and save it on add-on C." But it should be some kind of "unholy" operation and not be encouraged unless you really know what you're doing. =) <br />
<br />
<br />
*'''from_global''': Determines the name of the global variable that is loaded.<br />
<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo. <br />
<br />
<br />
Global variable files should have very simple wml syntax. Here goes an example:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store MP data on a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35977SummerOfCodeProposal lfernando2010-04-10T19:33:52Z<p>Lfernando: /* [get_global_variable] */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For example, you could use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there, along with any items he had and quests he did. And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous games.<br />
<br />
Conceptually, MP player persistency is very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be fairly straightforward.<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage. This kind of MP persistency involves data being with the "map", instead of with the "players". We will call it MP playerless persistency, and it should allow a kind of scenario that "changes" as different users play it.<br />
<br />
Here is an example of this kind of application by Crab_: <br />
<br />
"Imagine a game where there's a 'game master' - who creates a scenario, where you, for example, as a captain of a royal army, play for loyalists vs orcs. and then, if you win, the 'game master' changes the 'geopolitical map' to represent the fact that the border was defended, and orcs were defeated. Or imagine several games played in parallel, where you can transition from one game to another 'right-in-the-middle' (e..g, the gamemaster can store your units in one game and spawn them in another). and, it will not be hardcoded in c++ code. Every rule, every fantasy, can be achieved in wml, if we give a 'language' for it and implement engine support. "<br />
<br />
So, my project would be to:<br />
<br />
# Implement SP persistency. <br />
# Implement MP player persistency.<br />
# Implement MP playerless persistency.<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
<br />
On default, the player is the one who's playing the turn. There should be a special side value for storing data on the server/gamemaster.<br />
<br />
<br />
*'''namespace''': Used for determining from which file this variable should be loaded.<br />
<br />
As for now, we want to use different namespaces for different add-ons, and different files for different namespaces. On default it should write to the file of the add-on being played. But we want to maintain flexibility, especially regarding the "default" namespace, which should store the "real global" variables.<br />
<br />
It still can support things like "On add-on A, load this variable from add-on B and save it on add-on C." But it should be some kind of "unholy" operation and not be encouraged unless you really know what you're doing. =) <br />
<br />
<br />
*'''from_global''': Determines the name of the global variable that is loaded.<br />
<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store MP data on a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35976SummerOfCodeProposal lfernando2010-04-10T19:14:26Z<p>Lfernando: /* Overview */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For example, you could use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there, along with any items he had and quests he did. And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous games.<br />
<br />
Conceptually, MP player persistency is very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be fairly straightforward.<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage. This kind of MP persistency involves data being with the "map", instead of with the "players". We will call it MP playerless persistency, and it should allow a kind of scenario that "changes" as different users play it.<br />
<br />
Here is an example of this kind of application by Crab_: <br />
<br />
"Imagine a game where there's a 'game master' - who creates a scenario, where you, for example, as a captain of a royal army, play for loyalists vs orcs. and then, if you win, the 'game master' changes the 'geopolitical map' to represent the fact that the border was defended, and orcs were defeated. Or imagine several games played in parallel, where you can transition from one game to another 'right-in-the-middle' (e..g, the gamemaster can store your units in one game and spawn them in another). and, it will not be hardcoded in c++ code. Every rule, every fantasy, can be achieved in wml, if we give a 'language' for it and implement engine support. "<br />
<br />
So, my project would be to:<br />
<br />
# Implement SP persistency. <br />
# Implement MP player persistency.<br />
# Implement MP playerless persistency.<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''namespace''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store MP data on a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35975SummerOfCodeProposal lfernando2010-04-10T18:51:21Z<p>Lfernando: /* Overview */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For example, you could use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there, along with any items he had and quests he did. And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous games.<br />
<br />
Conceptually, MP player persistency would be very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be fairly straightforward.<br />
<br />
The second kind of MP persistency would involve data being with the "map", instead of with the "players". We will call it MP playerless persistency. <br />
<br />
*To be continued...<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''namespace''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store MP data on a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35974SummerOfCodeProposal lfernando2010-04-10T17:16:57Z<p>Lfernando: /* Overview */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For examples, you use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there (along with any items and quests he did, for example). And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous matches.<br />
<br />
Conceptually, MP player persistency would be very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be relatively straightforward.<br />
<br />
The second kind of MP persistency would involve data being with the "map", instead of with the "players". We will call it MP playerless persistency. <br />
<br />
*To be continued...<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''namespace''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store MP data on a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35973SummerOfCodeProposal lfernando2010-04-10T17:16:00Z<p>Lfernando: /* Overview */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For examples, you use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there (along with any items and quests he did, for example). And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you developed from previous matches.<br />
<br />
Conceptually, MP player persistency would be very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be relatively straightforward.<br />
<br />
The second kind of MP persistency would involve data being in the "map", instead of with the "players". We will call it MP playerless persistency. <br />
<br />
*To be continued...<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''namespace''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store MP data on a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35972SummerOfCodeProposal lfernando2010-04-10T17:14:52Z<p>Lfernando: /* Overview */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 Implement persistent storage of gameworld data between semi-related scenarios]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
On multiplayer, we desire to support two different uses for global variables. The first would be player persistency, where you store the desired data in one(or all) of the players user data.<br />
<br />
For examples, you use it to have an RPG-style UMC. You start with a hero, and you make adventures with him/her. The next time you started playing, your hero would be there (along with any items and quests he did, for example). And since this data would be stored in your computer, when you joined games with different players, you could reuse the same hero that you devoloped from previous matches.<br />
<br />
Conceptually, MP player persistency would be very similar to SP persistency. So, other than handling OOS errors and some MP specific problems, implementing MP player persistency from SP persistency would be relatively straightforward.<br />
<br />
The second kind of MP persistency would involve data being in the "map", instead of with the "players". We will call it MP playerless persistency. <br />
<br />
*To be continued...<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''namespace''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store MP data on a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35864SummerOfCodeProposal lfernando2010-04-09T18:10:05Z<p>Lfernando: </p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 t127068199898]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I already knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''namespace''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store MP data on a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35863SummerOfCodeProposal lfernando2010-04-09T18:09:29Z<p>Lfernando: </p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 t127068199898]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java and can be found at www.nics.unicamp.br.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
On Chord Jammer I worked solo for the majority of the time, so I never really participated in a project with more than 10 members on it. Working in a big project, maintained by many people worldwide, that appealed on me greatly when I first thought of applying to SoC and diving in an open source project. <br />
<br />
So, why not that FLOSS game that I knew and enjoyed? ;)<br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''namespace''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store MP data on a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35815SummerOfCodeProposal lfernando2010-04-09T01:37:51Z<p>Lfernando: /* Project Schedule */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 t127068199898]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
No! That's one of my main interests to participating on this project, to know how it is to work on a big project. One of my major regrets from the above mentioned projects is that I didn't had the chance to work as a team, as most of the time I was a lone programmer in a musician's world. It wasn't bad at all, but I missed feedback from my peers and people more experienced than me(at least technically). <br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''namespace''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store MP data on a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the gamemaster for MP. And maybe some MP scenario using the work done if we have the time/help.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35814SummerOfCodeProposal lfernando2010-04-09T01:36:07Z<p>Lfernando: /* Gamemaster */</p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 t127068199898]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
No! That's one of my main interests to participating on this project, to know how it is to work on a big project. One of my major regrets from the above mentioned projects is that I didn't had the chance to work as a team, as most of the time I was a lone programmer in a musician's world. It wasn't bad at all, but I missed feedback from my peers and people more experienced than me(at least technically). <br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''namespace''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store MP data on a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the "gamemaster" for MP. And maybe some showcase MP scenario if we have the help/time.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35810SummerOfCodeProposal lfernando2010-04-09T00:18:21Z<p>Lfernando: </p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 t127068199898]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
No! That's one of my main interests to participating on this project, to know how it is to work on a big project. One of my major regrets from the above mentioned projects is that I didn't had the chance to work as a team, as most of the time I was a lone programmer in a musician's world. It wasn't bad at all, but I missed feedback from my peers and people more experienced than me(at least technically). <br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug [https://gna.org/bugs/?14114 #14114], on patch [https://gna.org/patch/?1538 #1538].<br />
<br />
Reported minor bug [https://gna.org/bugs/?15601 #15601], and fixed it on patch [https://gna.org/patch/?1525 #1525].<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''namespace''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store to store MP data in a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the "gamemaster" for MP. And maybe some showcase MP scenario if we have the help/time.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35797SummerOfCodeProposal lfernando2010-04-08T19:51:39Z<p>Lfernando: </p>
<hr />
<div>{{SoC2010Student_2|lfernando|SoC Ideas Persistent Gameworld}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=SoC Application=<br />
[http://socghop.appspot.com/gsoc/student_proposal/review/google/gsoc2010/lfernando/t127068199898 t127068199898]<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
No! That's one of my main interests to participating on this project, to know how it is to work on a big project. One of my major regrets from the above mentioned projects is that I didn't had the chance to work as a team, as most of the time I was a lone programmer in a musician's world. It wasn't bad at all, but I missed feedback from my peers and people more experienced than me(at least technically). <br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug #14114, on patch #1538.<br />
<br />
Reported minor bug #15601, and fixed it on patch #1525.<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a very simple task I'll do it myself. If it's not the expected result, I'll just redo it the right way.<br />
<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as I can.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
See project description.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
More on that on the project description.<br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is my Master thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. So while I'm on this project, it'll be first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Well, I guess that after you start developing, things just aren't the same again. When you see a bug it's not "Cr**, another bug screwed my game. I hope they fix it on next patch." anymore. Your attitude becomes more hands-on, you know you can try fixing it if you want to.<br />
<br />
As for me, it's too early to say. My first impression of the community was very good, though. Also, the code definitely has some programming depth, and I could say I was having fun while I was fixing the bugs. So, that could convince me to lend some more work here whenever I want to help an open source community. <br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''namespace''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store to store MP data in a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the "gamemaster" for MP. And maybe some showcase MP scenario if we have the help/time.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35658SummerOfCodeProposal lfernando2010-04-07T23:40:49Z<p>Lfernando: </p>
<hr />
<div>{{SoC2010Student}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
No! That's one of my main interests to participating on this project, to know how it is to work on a big project. One of my major regrets from the above mentioned projects is that I didn't had the chance to work as a team, as most of the time I was a lone programmer in a musician's world. It wasn't bad at all, but I missed technical feedback from my peers and more experienced people than me(at least technically). <br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug #14114, on patch #1538.<br />
<br />
Reported minor bug #15601, and fixed it on patch #1525.<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I'm not a native, but I think my english reading/writing skills are on a good level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English. I know a little bit of French and Japanese.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a simple task I'll do it myself.<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as possible.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
Project described below.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the "gamemaster" for MP.And maybe some MP add-on/map that uses this system. <br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is working on my Master Thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. While I'm doing this project, it'll be my first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See it on project description below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Yes, It'll be a pleasure to help the project whenever I have spare time =)<br />
<br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''namespace''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
The other goal of this project is to not only make users, but also multiplayer scenarios capable of handling persistent storage.<br />
<br />
Since currently there are no ways to store to store MP data in a server, implementing it is tricky and requires some tweaking and working around. Fortunately, the workaround is doable by this persistency system.<br />
<br />
Suppose you want to make a sequence of multiplayer games so that one game stores data that other games can retrieve. You put in those games an extra, virtual player called a "gamemaster" whose sole purpose is to maintain a set of game variables, (he can do that, because he is a player) manage them during gameplay, and after the game is done, participate on another game with the changed values. It is a system with limitations (for example, games happening in parallel can't share variables between them) but it leads to a lot of interesting scenario possibilities.<br />
<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation happening in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate. Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the "gamemaster" for MP. And maybe some showcase MP scenario if we have the help/time.<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35657SummerOfCodeProposal lfernando2010-04-07T22:37:25Z<p>Lfernando: </p>
<hr />
<div>{{SoC2010Student}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
No! That's one of my main interests to participating on this project, to know how it is to work on a big project. One of my major regrets from the above mentioned projects is that I didn't had the chance to work as a team, as most of the time I was a lone programmer in a musician's world. It wasn't bad at all, but I missed technical feedback from my peers and more experienced people than me(at least technically). <br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug #14114, on patch #1538.<br />
<br />
Reported minor bug #15601, and fixed it on patch #1525.<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I think my written english is almost on fluent level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English. I know a little bit of French and Japanese.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a simple task I'll do it myself.<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as possible.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
Project described below.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the "gamemaster" for MP.And maybe some MP add-on/map that uses this system. <br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is working on my Master Thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. While I'm doing this project, it'll be my first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See it on project description below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Yes, It'll be a pleasure to help the project whenever I have spare time =)<br />
<br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [get_global_variable] and [set_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[get_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/get_global_variable]<br />
<br />
[set_global_variable]<br />
side=1<br />
namespace=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/set_global_variable]<br />
<br />
[clear_global_variable]<br />
side=1<br />
namespace=my_addon<br />
global=foo<br />
[/clear_global_variable]<br />
<br />
<br />
===[get_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''namespace''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[set_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
===[clear_global_variable]===<br />
Deletes a global variable with name foo on namespace. <br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
crafted_scepter=0<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
*Game master description<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation to happen in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate(me =) ). Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the "gamemaster" for MP. And maybe some showcase MP scenario if we have the help/time.<br />
<br />
If you want to help, drop us a line!<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35655SummerOfCodeProposal lfernando2010-04-07T20:14:14Z<p>Lfernando: </p>
<hr />
<div>{{SoC2010Student}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [save_global_variable] and [load_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
No! That's one of my main interests to participating on this project, to know how it is to work on a big project. One of my major regrets from the above mentioned projects is that I didn't had the chance to work as a team, as most of the time I was a lone programmer in a musician's world. It wasn't bad at all, but I missed technical feedback from my peers and more experienced people than me(at least technically). <br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(Final Fantasy series, Chrono Trigger, Fallout, World of Warcraft, lots of other japanese rpgs), action games(Mario, Castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug #14114, on patch #1538.<br />
<br />
Reported minor bug #15601, and fixed it on patch #1525.<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I think my written english is almost on fluent level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English. I know a little bit of French and Japanese.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a simple task I'll do it myself.<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as possible.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
Project described below.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the "gamemaster" for MP.And maybe some MP add-on/map that uses this system. <br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is working on my Master Thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. While I'm doing this project, it'll be my first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See it on project description below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Yes, It'll be a pleasure to help the project whenever I have spare time =)<br />
<br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is introducing variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [save_global_variable] and [load_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those ones "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[load_global_variable]<br />
side=side1<br />
persist_id=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/load_global_variable]<br />
<br />
[save_global_variable]<br />
side=side1<br />
persist_id=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/save_global_variable]<br />
<br />
===[load_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''persist_id''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[save_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
*Game master description<br />
<br />
==Project Schedule==<br />
<br />
We are imagining this project implementation to happen in three separate phases:<br />
<br />
Phase one should be the implementation of persistency WML for singleplayer.<br />
<br />
Phase two should be the extension of that for multiplayer.<br />
<br />
Phase three should be the implementation of the "playerless persistency" via the gamemaster concept.<br />
<br />
So, more specifically, phase one will happen in the beginning of the project alongside with the studying of WML and wesnoth code by the candidate(me =) ). Especially code for WML implementation and save games file structure. That should take roughly three weeks.<br />
<br />
Implementation of phase two will happen afterwards, and should be done at the same time that we resolve any bug or issue left from phase 1. Phase two should take roughly three weeks too.<br />
<br />
Finally, there are some scenario makers interested for the content for phase 3. In the middle of playerless persistency implementation, we'll contact them and try to build a scenario that uses this concept. It should work as both a showcase and a testcase for our ideas. Phase three should be the most time expensive one, featuring a lot of dish cleaning and feature polishing. It should take about one month and a half or two to get it done.<br />
<br />
So, for a timeline, we should expect something along this way:<br />
<br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the "gamemaster" for MP. And maybe some showcase MP scenario if we have the help/time.<br />
<br />
If you want to help, drop us a line!<br />
<br />
Luiz Fernando</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35649SummerOfCodeProposal lfernando2010-04-07T19:28:20Z<p>Lfernando: </p>
<hr />
<div>{{SoC2010Student}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
*In Progress<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
No! That's one of my main interests to participating on this project, to know how it is to work on a big project. One of my main complaint from the above mentioned projects is that I had to do it by myself <br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(final fantasy series, chrono trigger, fallout, world of warcraft, lots of other japanese rpgs), action games(mario, castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug #14114, on patch #1538.<br />
<br />
Reported minor bug #15601, and fixed it on patch #1525.<br />
<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I think my written english is almost on fluent level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English. I know a little bit of French and Japanese.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a simple task I'll do it myself.<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as possible.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
Project described below.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the "gamemaster" for MP.And maybe some MP add-on/map that uses this system. <br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is working on my Master Thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. While I'm doing this project, it'll be my first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See it on project description below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Yes, It'll be a pleasure to help the project whenever I have spare time =)<br />
<br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D<br />
<br />
=Project Description=<br />
<br />
==Overview==<br />
The general idea of this project is to introduce variables that are independent from savefiles and campaign lines. They will be accessible from any context and not lose validity once a particular game/campaign has ended. We'll call them ''global'' variables.<br />
<br />
Global variables will be stored and retrieved using two special tags, [save_global_variable] and [load_global_variable]. They should be used on scenario WML, and their usage will allow that variables, as defined by the [set_variable] family of tags, (from now onwards we will call those "local" variables) should be saved to/loaded from an external source. <br />
<br />
I'm planning to store global variables on simple wml files with syntax borrowed from uncompressed saves. Each add-on will have its own set of variables, and its own file for global variables.<br />
<br />
<br />
==WML Syntax==<br />
Here goes a sample specification for the syntax of [load_global_variable] and [store_global_variable] as suggested by Crab_.<br />
<br />
[load_global_variable]<br />
side=side1<br />
persist_id=my_addon<br />
from_global=my_variable_name<br />
to_local=foo<br />
[/load_global_variable]<br />
<br />
[save_global_variable]<br />
side=side1<br />
persist_id=my_addon<br />
from_local=my_variable_name<br />
to_global=foo<br />
[/save_global_variable]<br />
<br />
===[load_global_variable]===<br />
Creates a local variable from the value of a global variable.<br />
*'''side''': Relevant only in MP. Determines which player on MP will do the load operation.<br />
*'''persist_id''': Used for determining from which add-on this variable should be loaded (default is the add-on of the game being played)<br />
*'''from_global''': Determines the global value from which the variable is loaded.<br />
*'''to_local''': Determines the name of the local variable that receives the loaded value.<br />
<br />
===[save_global_variable]===<br />
Stores a local variable as a global variable.<br />
<br />
It has the same syntax as [load_global_variable], except for noting that it stores local variable named ''from_local'' to a global variable named ''to_global''.<br />
<br />
<br />
Global variable files should have very simple wml syntax:<br />
<br />
[variables]<br />
tutorial_completed=1<br />
betrayed_darken_volk=1<br />
dragons_slain=2<br />
king_of_wesnoth=1<br />
...<br />
[/variables]<br />
<br />
==Gamemaster==<br />
<br />
*Game master description<br />
<br />
==Project Schedule==<br />
<br />
*To do</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35641SummerOfCodeProposal lfernando2010-04-07T16:39:31Z<p>Lfernando: /* Questionnaire */</p>
<hr />
<div>{{SoC2010Student}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
*In Progress<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays. IRC meet times should mostly depend on my mentor's time schedule.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
I just took a week-long vacation on the last week of March, so I don't plan to take any longer break until September. And besides, we have winter here in Brazil on the June - August period =). <br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
No! That's one of my main interests to participating on this project, to know how it is to work on a big project. One of my main complaint from the above mentioned projects is that I had to do it by myself <br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(final fantasy series, chrono trigger, fallout, world of warcraft, lots of other japanese rpgs), action games(mario, castlevania), shooters (Half-Life, Quake), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
Fix for bug #14114, on patch #1538.<br />
Reported minor bug #15601, and fixed it on patch #1525.<br />
Implemented a small example regarding the persistency idea, recorded on http://wesnoth.pastebin.com/g1hMez2J.<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I think my written english is almost on fluent level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English. I know a little bit of French and Japanese.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable, but I can handle angry complaining and trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's the advice is constructive, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want?</h4><br />
If it's a simple task I'll do it myself.<br />
If it's a bit more complicated, sometimes I'll sketch my idea in an example piece of code or some template files. Then I'll discuss it until I I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as possible.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
Project described below.<br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present and answered my begginer questions promptly. And finally, when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
*April 26 - May 17: Make persistence work for singleplayer.<br />
*May 15 - June 4: Make persistence work for multiplayer.<br />
*June 6 - August 6: Finish the "gamemaster" for MP.And maybe some MP add-on/map that uses this system. <br />
<br />
Right now, I'm not enrolled to school disciplines, and I don't have any exams to make. My only time-expensive activity is working on my Master Thesis. I'll keep working on my thesis, but I plan to finish it only by the end of the year. While I'm doing this project, it'll be my first priority to finish it on time. <br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
See it on project description below.<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Yes, It'll be a pleasure to help the project whenever I have spare time =)<br />
<br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming in the small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35629SummerOfCodeProposal lfernando2010-04-07T04:47:39Z<p>Lfernando: /* Description */</p>
<hr />
<div>{{SoC2010Student}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
*In Progress<br />
<br />
=IRC=<br />
lfernando<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
June - August period is winter in Brazil, so no candy =) . I plan to take two weeks vacation by the end of august.<br />
<br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
No! That's one of my main interests to participating on this project, to know how it is to work on a big project. <br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(final fantasy series, chrono trigger, fallout, world of warcraft, lots of other japanese rpgs), action games(mario, castlevania), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
*Listing patches tomorrow*<br />
<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I think my written english is almost on fluent level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English. I know a little bit of French and Japanese.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable but I can handle trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's constructive advice, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want</h4><br />
If it's a simple task I'll do it myself.<br />
If it's a bit more complicated, sometimes I'll sketch my idea in a example piece of code or some template files. Then I'll discuss it until I I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as possible.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
*Project stuff only tomorrow!*<br />
<br />
<h4>If you have invented your own project, please describe the project and the scope.</h4><br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present, and when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
*To do with project description tomorrow*<br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
*To do tomorrow*<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. World peace. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Yes, It'll be a pleasure to help the project whenever I have spare time =)<br />
<br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming at small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35628SummerOfCodeProposal lfernando2010-04-07T04:46:48Z<p>Lfernando: </p>
<hr />
<div>{{SoC2010Student}}<br />
[[Category:SoC Ideas Persistent Gameworld]]<br />
<br />
=Description=<br />
<h4>lfernando - Implement persistent storage of gameworld data between semi-related scenarios</h4><br />
*to do*<br />
=IRC=<br />
lfernando<br />
<br />
=Questionnaire=<br />
<h3>Basics</h3><br />
<br />
<h4>Write a small introduction to yourself.</h4><br />
My name is Luiz Fernando and I'm a 23 years old programmer/gamer/graduate student.<br />
<br />
<h4>State your preferred email address.</h4><br />
lucifernando@gmail.com<br />
<h4>If you have chosen a nick for IRC and Wesnoth forums, what is it?</h4><br />
lfernando<br />
<h4>Why do you want to participate in summer of code?</h4><br />
I'm very eager to get involved with the open source world and I want to know how it is to contribute in a big project used by many, many people. GSoC seems like a rewarding way to join an open source project. <br />
<br />
<h4>What are you studying, subject, level and school?</h4><br />
I'm a master student on UNICAMP(University of Campinas) where I graduated two years ago. My research subject is graph theory. <br />
<br />
<h4>What country are you from, at what time are you most likely to be able to join IRC?</h4><br />
I'm from Brazil(UTC-3) and I may be able to be on IRC mostly any time of the day on weekdays.<br />
<br />
<h4>Do you have other commitments for the summer period ? Do you plan to take any vacations ? If yes, when.</h4><br />
June - August period is winter in Brazil, so no candy =) . I plan to take two weeks vacation by the end of august.<br />
<br />
<h3>Experience</h3><br />
<br />
<h4>What programs/software have you worked on before?</h4><br />
I've worked on a music technology institute inside my university called NICS, where I started development for a music experimenting tool/improviser called Chord Jammer. Also, I fixed some bugs for a project called Javox. Both projects were implemented on Java.<br />
<br />
<h4>Have you developed software in a team environment before? (As opposed to hacking on something on your own)</h4><br />
No! That's one of my main interests to participating on this project, to know how it is to work on a big project. <br />
<br />
<h4>Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</h4><br />
Never participated on any Summer of Code project. <br />
<br />
<h4>Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</h4><br />
My first experience with open source is Battle for Wesnoth.<br />
<br />
<h4>Gaming experience - Are you a gamer?</h4><br />
Yeah!<br />
<br />
<h4>What type of gamer are you?</h4><br />
Well, I play videogames since I was a little kid(the first game I remember playing was megaman 4 on NES when I was 5 years old). I kept playing until now, so I guess I'm some avid gamer =P. Heck, even while I was fixing the bugs, lots of times I would just take a break and resume playing Httt =P. <br />
<h4>What type of games?</h4><br />
Fighting games(Street Fighter, Soul Calibur), strategy games(BfW, Warcraft, Age of Empires, Civilization), rpg's(final fantasy series, chrono trigger, fallout, world of warcraft, lots of other japanese rpgs), action games(mario, castlevania), <br />
<br />
<h4>What type of opponents do you prefer?</h4><br />
The clever, unpredictable ones.<br />
<br />
<h4>Are you more interested in story or gameplay?</h4><br />
Tough question! But I guess videogames are all about "playing", and some games don't even have a discernible story, so I'll choose gameplay. But some games(Fallout 1/2, Breath of Fire 2, Final Fantasy VII, Mother 3) grabbed me for the story alone if not for the great gameplay.<br />
<br />
<h4>Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</h4><br />
I played mainly singleplayer campaigns on Wesnoth.<br />
<br />
<h4>If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</h4><br />
*Listing patches tomorrow*<br />
<br />
<h3>3) Communication skills</h3><br />
<br />
<h4>Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</h4><br />
I think my written english is almost on fluent level.<br />
<br />
<h4>What spoken languages are you fluent in?</h4><br />
Portuguese and English. I know a little bit of French and Japanese.<br />
<br />
<h4>Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</h4><br />
Yes, I prefer when the conversation is enjoyable but I can handle trolling too if needed.<br />
<br />
<h4>Do you give constructive advice?</h4><br />
Of course.<br />
<br />
<h4>Do you receive advice well?</h4><br />
I think so. If it's constructive advice, I'm very attentious.<br />
<br />
<h4>Are you good at sorting useful criticisms from useless ones?</h4><br />
Yes.<br />
<br />
<h4>How autonomous are you when developing ? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want</h4><br />
If it's a simple task I'll do it myself.<br />
If it's a bit more complicated, sometimes I'll sketch my idea in a example piece of code or some template files. Then I'll discuss it until I I have a clear idea of what to do. Then I'll code it until it is implemented. Of course, doubts and questions arise as the project flows, and I'm eager to ask them as soon as possible.<br />
<h3>Project</h3><br />
<br />
<h4>Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</h4><br />
*Project stuff only tomorrow!*<br />
<br />
<h4>If you have invented your own project, please describe the project and the scope.</h4><br />
<br />
<h4>Why did you choose this project?</h4><br />
First of all because I enjoyed playing the game =). Also, it is "minimalist" and has concepts which are very simple to grasp. That suggested some kind of elegance. The community is really friendly and present, and when I downloaded the source and started studying it, it felt like it was made by folks with a firm grasp of C++ and I could learn a lot if I could understand the code and hack through it. <br />
<br />
<br />
<h4>Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</h4><br />
*To do with project description tomorrow*<br />
<br />
<h4>Include as much technical detail about your implementation as you can</h4><br />
*To do tomorrow*<br />
<br />
<h4>What do you expect to gain from this project?</h4><br />
Having fun with open source development. Learning how to work with many people on a big software project. C++ Enlightenment. World peace. =)<br />
<br />
<h4>What would make you stay in the Wesnoth community after the conclusion of SOC?</h4><br />
Yes, It'll be a pleasure to help the project whenever I have spare time =)<br />
<br />
<br />
<h3>Practical considerations</h3><br />
<br />
<h4>Are you familiar with any of the following tools or languages?</h4><br />
<br />
* Subversion (used for all commits)<br />
Yes.<br />
* C++ (language used for all the normal source code)<br />
Yes.<br />
* STL, Boost, Sdl (C++ libraries used by Wesnoth)<br />
STL and some Boost. Never worked with Sdl before. <br />
* Python (optional, mainly used for tools)<br />
Wrote mostly little programs with it. Seems a really well designed language, eager to use it more on the future.<br />
* build environments (eg cmake/autotools/scons)<br />
I know SCons and Autotools. Am using SCons to compile Wesnoth builds as for now.<br />
* WML (the wesnoth specific scenario language)<br />
Started learning it and guess I know it well enough to understand this problem.<br />
* Lua (used in combination with WML to create scenarios)<br />
No.<br />
<br />
<h4>Which tools do you normally use for development? Why do you use them?</h4><br />
Eclipse. Gedit for programming at small.<br />
<br />
<h4>What programming languages are you fluent in?</h4><br />
C, C++, Java.<br />
<br />
<h4>Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise! </h4><br />
Yeah! You can have my cell phone number and call me when any problem arise. You can have my family house number too, but if you want to call it'd be better be really important because my mother can't understand any english! =-D</div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35626SummerOfCodeProposal lfernando2010-04-07T01:48:18Z<p>Lfernando: </p>
<hr />
<div></p><br />
<table border="3" align="center" cellpadding="20" cellspacing="0"><br />
<tr><br />
<td align="center"> <b>This page is related to Summer of Code 2010</b><br />
</td></tr><br />
<tr><br />
<td align="center"> <a href="/SummerOfCodeIdeas" title="SummerOfCodeIdeas">See the list of Summer of Code 2010 Ideas</a><br />
</td></tr></table><br />
<p><br /><br />
<br />
</p><p><br /><br />
</p><br />
<table border="3" align="center" cellpadding="20" cellspacing="0"><br />
<tr><br />
<td align="center"> <b>This is a Summer of Code 2010 student page</b><br />
</td></tr></table><br />
<p><br /><br />
</p><br />
<table id="toc" class="toc" summary="Contents"><tr><td><div id="toctitle"><h2>Contents</h2></div><br />
<ul><br />
<li class="toclevel-1"><a href="#Description"><span class="tocnumber">1</span> <span class="toctext">Description</span></a><br />
<br />
<ul><br />
<li class="toclevel-2"><a href="#lfernando_-_Implement_persistent_storage_of_gameworld_data_between_semi-related_scenarios"><span class="tocnumber">1.1</span> <span class="toctext">Alexander Vishnevskiy - Implement persistent storage of gameworld data between semi-related scenarios</span></a></li><br />
</ul><br />
</li><br />
<li class="toclevel-1"><a href="#IRC"><span class="tocnumber">2</span> <span class="toctext">IRC</span></a></li><br />
<li class="toclevel-1"><a href="#Questionnaire"><span class="tocnumber">3</span> <span class="toctext">Questionnaire</span></a><br />
<ul><br />
<li class="toclevel-2"><a href="#Basics"><span class="tocnumber">3.1</span> <span class="toctext">Basics</span></a><br />
<br />
<ul><br />
<li class="toclevel-3"><a href="#Write_a_small_introduction_to_yourself."><span class="tocnumber">3.1.1</span> <span class="toctext">Write a small introduction to yourself.</span></a></li><br />
<li class="toclevel-3"><a href="#State_your_preferred_email_address."><span class="tocnumber">3.1.2</span> <span class="toctext">State your preferred email address.</span></a></li><br />
<li class="toclevel-3"><a href="#If_you_have_chosen_a_nick_for_IRC_and_Wesnoth_forums.2C_what_is_it.3F"><span class="tocnumber">3.1.3</span> <span class="toctext">If you have chosen a nick for IRC and Wesnoth forums, what is it?</span></a></li><br />
<li class="toclevel-3"><a href="#Why_do_you_want_to_participate_in_summer_of_code.3F"><span class="tocnumber">3.1.4</span> <span class="toctext">Why do you want to participate in summer of code?</span></a></li><br />
<br />
<li class="toclevel-3"><a href="#What_are_you_studying.2C_subject.2C_level_and_school.3F"><span class="tocnumber">3.1.5</span> <span class="toctext">What are you studying, subject, level and school?</span></a></li><br />
<li class="toclevel-3"><a href="#What_country_are_you_from.2C_at_what_time_are_you_most_likely_to_be_able_to_join_IRC.3F"><span class="tocnumber">3.1.6</span> <span class="toctext">What country are you from, at what time are you most likely to be able to join IRC?</span></a></li><br />
<li class="toclevel-3"><a href="#Do_you_have_other_commitments_for_the_summer_period_.3F_Do_you_plan_to_take_any_vacations_.3F_If_yes.2C_when."><span class="tocnumber">3.1.7</span> <span class="toctext">Do you have other commitments for the summer period&nbsp;? Do you plan to take any vacations&nbsp;? If yes, when.</span></a></li><br />
</ul><br />
</li><br />
<li class="toclevel-2"><a href="#Experience"><span class="tocnumber">3.2</span> <span class="toctext">Experience</span></a><br />
<br />
<ul><br />
<li class="toclevel-3"><a href="#What_programs.2Fsoftware_have_you_worked_on_before.3F"><span class="tocnumber">3.2.1</span> <span class="toctext">What programs/software have you worked on before?</span></a></li><br />
<li class="toclevel-3"><a href="#Have_you_developed_software_in_a_team_environment_before.3F_.28As_opposed_to_hacking_on_something_on_your_own.29"><span class="tocnumber">3.2.2</span> <span class="toctext">Have you developed software in a team environment before? (As opposed to hacking on something on your own)</span></a></li><br />
<li class="toclevel-3"><a href="#Have_you_participated_to_the_Google_Summer_of_Code_before.3F_As_a_mentor_or_a_student.3F_In_what_project.3F_Were_you_successful.3F_If_not.2C_why.3F"><span class="tocnumber">3.2.3</span> <span class="toctext">Have you participated to the Google Summer of Code before? As a mentor or a student? In what project? Were you successful? If not, why?</span></a></li><br />
<li class="toclevel-3"><a href="#Are_you_already_involved_with_any_open_source_development_projects.3F_If_yes.2C_please_describe_the_project_and_the_scope_of_your_involvement."><span class="tocnumber">3.2.4</span> <span class="toctext">Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.</span></a></li><br />
<br />
<li class="toclevel-3"><a href="#Gaming_experience_-_Are_you_a_gamer.3F"><span class="tocnumber">3.2.5</span> <span class="toctext">Gaming experience - Are you a gamer?</span></a></li><br />
<li class="toclevel-3"><a href="#What_type_of_gamer_are_you.3F"><span class="tocnumber">3.2.6</span> <span class="toctext">What type of gamer are you?</span></a></li><br />
<li class="toclevel-3"><a href="#What_type_of_games.3F"><span class="tocnumber">3.2.7</span> <span class="toctext">What type of games?</span></a></li><br />
<li class="toclevel-3"><a href="#What_type_of_opponents_do_you_prefer.3F"><span class="tocnumber">3.2.8</span> <span class="toctext">What type of opponents do you prefer?</span></a></li><br />
<li class="toclevel-3"><a href="#Are_you_more_interested_in_story_or_gameplay.3F"><span class="tocnumber">3.2.9</span> <span class="toctext">Are you more interested in story or gameplay?</span></a></li><br />
<br />
<li class="toclevel-3"><a href="#Have_you_played_Wesnoth.3F_If_so.2C_tell_us_roughly_for_how_long_and_whether_you_lean_towards_single_player_or_multiplayer."><span class="tocnumber">3.2.10</span> <span class="toctext">Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.</span></a></li><br />
<li class="toclevel-3"><a href="#If_you_have_contributed_any_patches_to_Wesnoth.2C_please_list_them_below._You_can_also_list_patches_that_have_been_submitted_but_not_committed_yet_and_patches_that_have_not_been_specifically_written_for_GSoC._If_you_have_gained_commit_access_to_our_SVN_.28during_the_evaluation_period_or_earlier.29_please_state_so."><span class="tocnumber">3.2.11</span> <span class="toctext">If you have contributed any patches to Wesnoth, please list them below. You can also list patches that have been submitted but not committed yet and patches that have not been specifically written for GSoC. If you have gained commit access to our SVN (during the evaluation period or earlier) please state so.</span></a></li><br />
</ul><br />
</li><br />
<li class="toclevel-2"><a href="#3.29_Communication_skills"><span class="tocnumber">3.3</span> <span class="toctext">3) Communication skills</span></a><br />
<ul><br />
<li class="toclevel-3"><a href="#Though_most_of_our_developers_are_not_native_English_speakers.2C_English_is_the_project.27s_working_language._Describe_your_fluency_level_in_written_English."><span class="tocnumber">3.3.1</span> <span class="toctext">Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.</span></a></li><br />
<br />
<li class="toclevel-3"><a href="#What_spoken_languages_are_you_fluent_in.3F"><span class="tocnumber">3.3.2</span> <span class="toctext">What spoken languages are you fluent in?</span></a></li><br />
<li class="toclevel-3"><a href="#Are_you_good_at_interacting_with_other_players.3F_Our_developer_community_is_friendly.2C_but_the_player_community_can_be_a_bit_rough."><span class="tocnumber">3.3.3</span> <span class="toctext">Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.</span></a></li><br />
<li class="toclevel-3"><a href="#Do_you_give_constructive_advice.3F"><span class="tocnumber">3.3.4</span> <span class="toctext">Do you give constructive advice?</span></a></li><br />
<li class="toclevel-3"><a href="#Do_you_receive_advice_well.3F"><span class="tocnumber">3.3.5</span> <span class="toctext">Do you receive advice well?</span></a></li><br />
<li class="toclevel-3"><a href="#Are_you_good_at_sorting_useful_criticisms_from_useless_ones.3F"><span class="tocnumber">3.3.6</span> <span class="toctext">Are you good at sorting useful criticisms from useless ones?</span></a></li><br />
<br />
<li class="toclevel-3"><a href="#How_autonomous_are_you_when_developing_.3F_Would_you_rather_discuss_intensively_changes_and_not_start_coding_until_you_know_what_you_want_to_do_or_would_you_rather_code_a_proof_of_concept_to_.22see_how_it_turn_out.22.2C_taking_the_risk_of_having_it_thrown_away_if_it_doesn.27t_match_what_the_project_want"><span class="tocnumber">3.3.7</span> <span class="toctext">How autonomous are you when developing&nbsp;? Would you rather discuss intensively changes and not start coding until you know what you want to do or would you rather code a proof of concept to "see how it turn out", taking the risk of having it thrown away if it doesn't match what the project want</span></a></li><br />
</ul><br />
</li><br />
<li class="toclevel-2"><a href="#Project"><span class="tocnumber">3.4</span> <span class="toctext">Project</span></a><br />
<ul><br />
<li class="toclevel-3"><a href="#Did_you_select_a_project_from_our_list.3F_If_that_is_the_case.2C_what_project_did_you_select.3F_What_do_you_want_to_especially_concentrate_on.3F"><span class="tocnumber">3.4.1</span> <span class="toctext">Did you select a project from our list? If that is the case, what project did you select? What do you want to especially concentrate on?</span></a></li><br />
<li class="toclevel-3"><a href="#If_you_have_invented_your_own_project.2C_please_describe_the_project_and_the_scope."><span class="tocnumber">3.4.2</span> <span class="toctext">If you have invented your own project, please describe the project and the scope.</span></a></li><br />
<br />
<li class="toclevel-3"><a href="#Why_did_you_choose_this_project.3F"><span class="tocnumber">3.4.3</span> <span class="toctext">Why did you choose this project?</span></a></li><br />
<li class="toclevel-3"><a href="#Include_an_estimated_timeline_for_your_work_on_the_project._Don.27t_forget_to_mention_special_things_like_.22I_booked_holidays_between_A_and_B.22_and_.22I_got_an_exam_at_ABC_and_won.27t_be_doing_much_then.22."><span class="tocnumber">3.4.4</span> <span class="toctext">Include an estimated timeline for your work on the project. Don't forget to mention special things like "I booked holidays between A and B" and "I got an exam at ABC and won't be doing much then".</span></a></li><br />
<li class="toclevel-3"><a href="#Include_as_much_technical_detail_about_your_implementation_as_you_can"><span class="tocnumber">3.4.5</span> <span class="toctext">Include as much technical detail about your implementation as you can</span></a></li><br />
<li class="toclevel-3"><a href="#What_do_you_expect_to_gain_from_this_project.3F"><span class="tocnumber">3.4.6</span> <span class="toctext">What do you expect to gain from this project?</span></a></li><br />
<li class="toclevel-3"><a href="#What_would_make_you_stay_in_the_Wesnoth_community_after_the_conclusion_of_SOC.3F"><span class="tocnumber">3.4.7</span> <span class="toctext">What would make you stay in the Wesnoth community after the conclusion of SOC?</span></a></li><br />
<br />
</ul><br />
</li><br />
<li class="toclevel-2"><a href="#Practical_considerations"><span class="tocnumber">3.5</span> <span class="toctext">Practical considerations</span></a><br />
<ul><br />
<li class="toclevel-3"><a href="#Are_you_familiar_with_any_of_the_following_tools_or_languages.3F"><span class="tocnumber">3.5.1</span> <span class="toctext">Are you familiar with any of the following tools or languages?</span></a></li><br />
<li class="toclevel-3"><a href="#Which_tools_do_you_normally_use_for_development.3F_Why_do_you_use_them.3F"><span class="tocnumber">3.5.2</span> <span class="toctext">Which tools do you normally use for development? Why do you use them?</span></a></li><br />
<li class="toclevel-3"><a href="#What_programming_languages_are_you_fluent_in.3F"><span class="tocnumber">3.5.3</span> <span class="toctext">What programming languages are you fluent in?</span></a></li><br />
<br />
<li class="toclevel-3"><a href="#Would_you_mind_talking_with_your_mentor_on_telephone_.2F_internet_phone.3F_We_would_like_to_have_a_backup_way_for_communications_for_the_case_that_somehow_emails_and_IRC_do_fail._If_you_are_willing_to_do_so.2C_please_do_list_a_phone_number_.28including_international_code.29_so_that_we_are_able_to_contact_you._You_should_probably_.2Aonly.2A_add_this_number_in_the_application_for_you_submit_to_google_since_the_info_in_the_wiki_is_available_in_public._We_will_.2Anot.2A_make_any_use_of_your_number_unless_some_case_of_.22there_is_no_way_to_contact_you.22_does_arise.21"><span class="tocnumber">3.5.4</span> <span class="toctext">Would you mind talking with your mentor on telephone / internet phone? We would like to have a backup way for communications for the case that somehow emails and IRC do fail. If you are willing to do so, please do list a phone number (including international code) so that we are able to contact you. You should probably *only* add this number in the application for you submit to google since the info in the wiki is available in public. We will *not* make any use of your number unless some case of "there is no way to contact you" does arise!</span></a></li><br />
</ul><br />
</li><br />
</ul><br />
</li><br />
</ul><br />
</td></tr></table><script type="text/javascript"> if (window.showTocToggle) { var tocShowText = "show"; var tocHideText = "hide"; showTocToggle(); } </script></div>Lfernandohttps://wiki.wesnoth.org/index.php?title=SummerOfCodeProposal_lfernando&diff=35625SummerOfCodeProposal lfernando2010-04-07T01:45:33Z<p>Lfernando: Lfernando's proposal</p>
<hr />
<div>Luiz Fernando - Teste<br />
Test Page!<br />
See SummerOfCodeProposal Luiz Fernando for more information.</div>Lfernando