RujasuScenarioEditor - Revision history

Octalot: Mark as obsolete

2022-12-13T10:44:28Z

Mark as obsolete

← Older revision		Revision as of 10:44, 13 December 2022
Line 1:		Line 1:
			{{Obsolete\|Reason: It's an GSoC application, and the ideas from it are now either implemented or logged in the issues database.}}

	==Basics==		==Basics==
	My name is Jacob Rudolph. I'm twenty years old and currently reside in Pennsylvania. I'm hoping for a career in software development, though I have not decided my exact ambitions yet. My hobbies include acting, and, well, open source game development.		My name is Jacob Rudolph. I'm twenty years old and currently reside in Pennsylvania. I'm hoping for a career in software development, though I have not decided my exact ambitions yet. My hobbies include acting, and, well, open source game development.

Rujasu at 15:49, 4 April 2008

2008-04-04T15:49:46Z

← Older revision		Revision as of 15:49, 4 April 2008
Line 24:		Line 24:

	==Project==		==Project==
	I chose the scenario editor project from the list. I chose this project because I would like to create an editor that is more usable and flexible than the out-of-date campgen, and one that will ultimately be more powerful.		I chose the scenario editor project from the list. I chose this project because I would like to create an editor that is more usable and flexible than the out-of-date campgen, and one that will ultimately be more powerful. The editor will be written in C++. This is my most proficient language, and it allows better integration with other aspects of Wesnoth.

	~~During the summer~~, I ~~expect~~ to ~~build an~~ editor ~~that can produce playable scenarios~~ to be ~~used in full campaigns~~. ~~The editor will~~ be ~~flexible enough~~ to, ~~at some point, include~~ additional ~~features such as importing scenarios from WML~~. ~~Additional tools can be developed for unit modification~~ and ~~any other possible campaign considerations; this will not~~ be ~~in the scope of my summer project~~.		The editor will be using Wesnoth's own GUI toolkit (currently in development), with any necessary extensions being added as needed. I plan to use this toolkit because it would allow the editor to be distributed with Wesnoth, without any added dependencies. Since it is supposed to be easy-to-use, we don't want the user to have to install additional libraries. It would also keep the general feel of the game. Map viewing code from the map editor and/or main game could be re-used.

	The ~~editor~~ will be written in C++. This is my most proficient language, and it allows better integration with other aspects of Wesnoth. (For one thing, map-viewing code could potentially be re-used.) The editor will use Wesnoth's own GUI toolkit, which Mordante is currently developing. This will help to give the editor a united feel with the game itself.		The interface will allow:

	~~I believe this project~~ will ~~help me~~ to ~~improve my practical software development abilities while doing something I enjoy~~. ~~I fully intend~~ to ~~continue improving~~ the editor, ~~and possibly contributing~~ to ~~other areas~~ of ~~Wesnoth~~, ~~once~~ the ~~SoC period~~ is ~~complete~~.		- Modification of basic scenario infomation
			- Modification of sides/unit types
			- Adding/removing/editing WML events by clicking on specific units, locations, or list of turns
			- Saving to WML, loading from WML

			On the back end, the editor will work using a simple process:

			- Load and parse the scenario's CFG file.
			- Modify the components of the WML as directed by the user/interface.
			- Output the WML components to a CFG file.

			This will also allow significant re-use and coordination with the main game's code. Much of the WML parser will be re-used, or at least used as a guide. Other things to worry about on the WML side:

			Events will have to be dealt with. The system will have to be able to create events, remove events, and modify existing events. Removing events will be simple enough; just delete the event code. My plan to deal with creating events is to use small templates for common types of events. For modifying events, the editor can essentially list everything that happens as a part of that event, allowing the user to add to the event, remove from the event, or change parts of the event. To change the condition for an event, the user will probably have to create new events in most cases.

			Preferably, comments written in WML would be preserved, though exact formatting will not be. This is a feature that may be difficult to implement during a summer project. However, comments could be preserved by keeping a record of all comments loaded from a data file and the information directly below them.

			Macros would be very possible to deal with, however it would require a fundamental change to the editor's internal representation, so it would probably not be a feasible goal for this project to preserve macros.

	==Practical considerations==		==Practical considerations==
Line 44:		Line 61:

	Learn more about Wesnoth: read documentation, talk to developers, etc.		Learn more about Wesnoth: read documentation, talk to developers, etc.
	Play through as many currently-available campaigns as possible.		Play through as many currently-available campaigns as possible.
	Refine ideas.		Refine ideas.
	Talk to scenario developers and get an idea of most requested features, etc.		Talk to scenario developers and get an idea of most requested features, etc.

	May 26 - June 8:		May 26 - June 8:

	Begin coding.		Begin coding
	~~Begin implementing the interface.~~		Implement loading from WML, using (derivative of) current Wesnoth parser
	Implement ~~support for global campaign data (name, difficulties~~, ~~description, etc.)~~		Begin implementing the interface
	~~Implement support for editing general scenario information~~ (~~name, description, map data, etc.~~)
	~~Implement editing of sides (available units).~~

	June 9 - June 22:		June 9 - June 22:

	Implement ~~creation of events for basic victory conditions.~~		Implement saving to WML
	Implement ~~pre-~~scenario ~~events.~~		Implement basic modification support: static scenario information
	~~Implement placement of default units on map.~~

	June 23 - July 6:		June 23 - July 6:

	Implement ~~in-game~~ events.		Implement support for creating events
	~~- One view~~ for events ~~specific to units (if unit attacks, if unit is attacked, if unit moves to a location).~~		Implement support for modifying events
	~~- One view~~ for ~~events specific to time~~ (~~turns finished, specific event happens on turn 2~~).		Implement support for creating new scenarios (default CFG files)
	~~- Map view for events specific to location (any unit from a specific side reaches a certain point.~~

	July 7 - July 20:		July 7 - July 20:

	Clean up loose ends.		Clean up loose ends
	Implement "export to WML" and test basic scenario.		Continue to work on implementing more events
			Implement "export to WML" and test basic scenario

	July 21 - August 3:		July 21 - August 3:

	Put out version to community for testing/feedback.		Put out version to community for testing/feedback
	~~Possibly implement "import from WML."~~		Implement an interface that will allow the user to tie scenarios together into a full campaign
	~~Work~~ on additional features?		Continue to work on implementing more events
			Begin implementing additional features, such as:
			- preserving comments
			- events that affect AI?

	August 4 - August 18:		August 4 - August 18:

	Respond to feedback/bug reports.		Respond to feedback/bug reports
	Finish anything not already completed.		Finish anything not already completed
	Work on additional features?		Work on additional features/events

	[[Category:Summer of Code]]		[[Category:Summer of Code]]

Rujasu: /* Tenative Timeline */

2008-03-30T18:26:14Z

Tenative Timeline

← Older revision		Revision as of 18:26, 30 March 2008
Line 40:		Line 40:

	==Tenative Timeline==		==Tenative Timeline==

			Now - May 25:

			Learn more about Wesnoth: read documentation, talk to developers, etc.
			Play through as many currently-available campaigns as possible.
			Refine ideas.
			Talk to scenario developers and get an idea of most requested features, etc.

	May 26 - June 8:		May 26 - June 8:

Rujasu: Added timeline

2008-03-30T17:10:27Z

Added timeline

← Older revision		Revision as of 17:10, 30 March 2008
Line 38:		Line 38:

	My only fluent language is English. My knowledge of Spanish is passable at best. Generally, I am awake from 14:00 to 6:00 UTC. I am able to talk over the phone; haven't really done anything with VOIP before.		My only fluent language is English. My knowledge of Spanish is passable at best. Generally, I am awake from 14:00 to 6:00 UTC. I am able to talk over the phone; haven't really done anything with VOIP before.

			==Tenative Timeline==

			May 26 - June 8:

			Begin coding.
			Begin implementing the interface.
			Implement support for global campaign data (name, difficulties, description, etc.)
			Implement support for editing general scenario information (name, description, map data, etc.)
			Implement editing of sides (available units).

			June 9 - June 22:

			Implement creation of events for basic victory conditions.
			Implement pre-scenario events.
			Implement placement of default units on map.

			June 23 - July 6:

			Implement in-game events.
			- One view for events specific to units (if unit attacks, if unit is attacked, if unit moves to a location).
			- One view for events specific to time (turns finished, specific event happens on turn 2).
			- Map view for events specific to location (any unit from a specific side reaches a certain point.

			July 7 - July 20:

			Clean up loose ends.
			Implement "export to WML" and test basic scenario.

			July 21 - August 3:

			Put out version to community for testing/feedback.
			Possibly implement "import from WML."
			Work on additional features?

			August 4 - August 18:

			Respond to feedback/bug reports.
			Finish anything not already completed.
			Work on additional features?

	[[Category:Summer of Code]]		[[Category:Summer of Code]]

Ivanovic: add category info

2008-03-22T14:03:43Z

add category info

← Older revision		Revision as of 14:03, 22 March 2008
Line 38:		Line 38:

	My only fluent language is English. My knowledge of Spanish is passable at best. Generally, I am awake from 14:00 to 6:00 UTC. I am able to talk over the phone; haven't really done anything with VOIP before.		My only fluent language is English. My knowledge of Spanish is passable at best. Generally, I am awake from 14:00 to 6:00 UTC. I am able to talk over the phone; haven't really done anything with VOIP before.

			[[Category:Summer of Code]]

Rujasu at 07:03, 22 March 2008

2008-03-22T07:03:54Z

Rujasu: New page: ==Basics== My name is Jacob Rudolph. I'm twenty years old and currently reside in Pennsylvania. I'm hoping for a career in software development, though I have not decided my exact ambit...

2008-03-22T07:02:34Z

New page: ==Basics== My name is Jacob Rudolph. I'm twenty years old and currently reside in Pennsylvania. I'm hoping for a career in software development, though I have not decided my exact ambit...

New page

==Basics==
My name is Jacob Rudolph. I'm twenty years old and currently reside in Pennsylvania. I'm hoping for a career in software development, though I have not decided my exact ambitions yet. My hobbies include acting, and, well, open source game development.

Email: rujasu@yahoo.com

My nick is "rujasu" on IRC and forums. Generally, if you see "rujasu," it's probably me.

I am hoping that Summer of Code will give me enough income to dedicate more of my time to working on one of my favorite open source games, and less time working at a job that may not relate to my ultimate career path.

I'm a junior (third-year) undergraduate student at York College of Pennsylvania, majoring in Computer Science. I've taken nearly every programming-related course possible.

==Experience==
I have been a developer for Hero of Allacrost (www.allacrost.org) for about a year now, and was recently named lead of the programming team. Hero of Allacrost is an open source project for a single player RPG with 2D graphics; it draws inspiration from games such as Final Fantasy and Chrono Trigger. This would be my first Summer of Code experience.

I believe in using a general agile development model. It is clear that the waterfall model does not work in open source development. Documentation is important, but more important is producing readable and flexible code. Creating full prototypes is unnecessary for this project, but it will be helpful to create some interface mockups. For this project, the best method of testing is having people try using the software; I don't feel that automated testing will be useful for this project.

For the Allacrost project, I have worked on bugfixing and extending the functionality of the game's shopping and game menu interfaces. I have also contributed ideas, tested for bugs, and worked with scripting in Lua. More recently, I have been mentoring new contributing programmers for the project and working on battle mode.

I consider myself a pretty serious strategy/RPG gamer, though I haven't been playing as many games as I'd like lately. I play single-player games almost exclusively. I like games that challenge me; great gameplay is always the important factor, but a fantasy game needs a great story to be a true classic. I first learned of Wesnoth from a friend, a little over a year ago. I play single-player campaigns and have not tried multiplayer.

==Communication skills==
I am a native English speaker. I am an effective communicator and have taken academic writing classes through college. I do my best to help anyone who has questions or problems. I am very patient, and I should be able to interact with players easily. Whenever possible, I give constructive advice. I do not give negative or demeaning feedback. I am always willing to listen to advice and constructive criticisms. I am able to recognize when a criticism is accurate and useful.

==Project==
I chose the scenario editor project from the list. I chose this project because I would like to create an editor that is more usable and flexible than the out-of-date campgen, and one that will ultimately be more powerful.

During the summer, I expect to build an editor that can produce playable scenarios to be used in full campaigns. The editor will be flexible enough to, at some point, include additional features such as importing scenarios from WML. Additional tools can be developed for unit modification and any other possible campaign considerations; this will not be in the scope of my summer project.

The editor will be written in C++. This is my most proficient language, and it allows better integration with other aspects of Wesnoth. (For one thing, map-viewing code could potentially be re-used.) The editor will use Wesnoth's own GUI toolkit, which Mordante is currently developing. This will help to give the editor a united feel with the game itself.

I believe this project will help me to improve my practical software development abilities while doing something I enjoy. I fully intend to continue improving the editor, and possibly contributing to other areas of Wesnoth, once the SoC period is complete.

==Practical considerations==
I am very familiar with SVN, mainly from my work on Allacrost. Also, I have been using C++ for about six years. Though I have no experience with Python, I am confident in my ability to learn programming languages quickly when needed.

As a Linux user, my work is mostly done on KDE development tools such as KWrite and KDevelop. I believe these are the most easily usable and visually appealing tools available for Linux. I am fluent in C++, Java, and C, with a working knowledge in Lua and a few others. Unfortunately, I am also fluent in BASIC, though I haven't touched it in years.

My only fluent language is English. My knowledge of Spanish is passable at best. Generally, I am awake from 14:00 to 6:00 UTC. I am able to talk over the phone; haven't really done anything with VOIP before.

← Older revision		Revision as of 07:03, 22 March 2008
Line 1:		Line 1:
	==Basics==		==Basics==
	My name is Jacob Rudolph. I'm twenty years old and currently reside in Pennsylvania. I'm hoping for a career in software development, though I have not decided my exact ambitions yet. My hobbies include acting, and, well, open source game development.		My name is Jacob Rudolph. I'm twenty years old and currently reside in Pennsylvania. I'm hoping for a career in software development, though I have not decided my exact ambitions yet. My hobbies include acting, and, well, open source game development.

	Email: rujasu@yahoo.com		Email: rujasu@yahoo.com

	My nick is "rujasu" on IRC and forums. Generally, if you see "rujasu," it's probably me.		My nick is "rujasu" on IRC and forums. Generally, if you see "rujasu," it's probably me.

	I am hoping that Summer of Code will give me enough income to dedicate more of my time to working on one of my favorite open source games, and less time working at a job that may not relate to my ultimate career path.		I am hoping that Summer of Code will give me enough income to dedicate more of my time to working on one of my favorite open source games, and less time working at a job that may not relate to my ultimate career path.

	I'm a junior (third-year) undergraduate student at York College of Pennsylvania, majoring in Computer Science. I've taken nearly every programming-related course possible.		I'm a junior (third-year) undergraduate student at York College of Pennsylvania, majoring in Computer Science. I've taken nearly every programming-related course possible.

	==Experience==		==Experience==
	I have been a developer for Hero of Allacrost (www.allacrost.org) for about a year now, and was recently named lead of the programming team. Hero of Allacrost is an open source project for a single player RPG with 2D graphics; it draws inspiration from games such as Final Fantasy and Chrono Trigger. This would be my first Summer of Code experience.		I have been a developer for Hero of Allacrost (www.allacrost.org) for about a year now, and was recently named lead of the programming team. Hero of Allacrost is an open source project for a single player RPG with 2D graphics; it draws inspiration from games such as Final Fantasy and Chrono Trigger. This would be my first Summer of Code experience.

	I believe in using a general agile development model. It is clear that the waterfall model does not work in open source development. Documentation is important, but more important is producing readable and flexible code. Creating full prototypes is unnecessary for this project, but it will be helpful to create some interface mockups. For this project, the best method of testing is having people try using the software; I don't feel that automated testing will be useful for this project.		I believe in using a general agile development model. It is clear that the waterfall model does not work in open source development. Documentation is important, but more important is producing readable and flexible code. Creating full prototypes is unnecessary for this project, but it will be helpful to create some interface mockups. For this project, the best method of testing is having people try using the software; I don't feel that automated testing will be useful for this project.

	For the Allacrost project, I have worked on bugfixing and extending the functionality of the game's shopping and game menu interfaces. I have also contributed ideas, tested for bugs, and worked with scripting in Lua. More recently, I have been mentoring new contributing programmers for the project and working on battle mode.		For the Allacrost project, I have worked on bugfixing and extending the functionality of the game's shopping and game menu interfaces. I have also contributed ideas, tested for bugs, and worked with scripting in Lua. More recently, I have been mentoring new contributing programmers for the project and working on battle mode.

	I consider myself a pretty serious strategy/RPG gamer, though I haven't been playing as many games as I'd like lately. I play single-player games almost exclusively. I like games that challenge me; great gameplay is always the important factor, but a fantasy game needs a great story to be a true classic. I first learned of Wesnoth from a friend, a little over a year ago. I play single-player campaigns and have not tried multiplayer.		I consider myself a pretty serious strategy/RPG gamer, though I haven't been playing as many games as I'd like lately. I play single-player games almost exclusively. I like games that challenge me; great gameplay is always the important factor, but a fantasy game needs a great story to be a true classic. I first learned of Wesnoth from a friend, a little over a year ago. I play single-player campaigns and have not tried multiplayer.

	==Communication skills==		==Communication skills==
	I am a native English speaker. I am an effective communicator and have taken academic writing classes through college. I do my best to help anyone who has questions or problems. I am very patient, and I should be able to interact with players easily. Whenever possible, I give constructive advice. I do not give negative or demeaning feedback. I am always willing to listen to advice and constructive criticisms. I am able to recognize when a criticism is accurate and useful.		I am a native English speaker. I am an effective communicator and have taken academic writing classes through college. I do my best to help anyone who has questions or problems. I am very patient, and I should be able to interact with players easily. Whenever possible, I give constructive advice. I do not give negative or demeaning feedback. I am always willing to listen to advice and constructive criticisms. I am able to recognize when a criticism is accurate and useful.


	==Project==		==Project==
	I chose the scenario editor project from the list. I chose this project because I would like to create an editor that is more usable and flexible than the out-of-date campgen, and one that will ultimately be more powerful.		I chose the scenario editor project from the list. I chose this project because I would like to create an editor that is more usable and flexible than the out-of-date campgen, and one that will ultimately be more powerful.

	During the summer, I expect to build an editor that can produce playable scenarios to be used in full campaigns. The editor will be flexible enough to, at some point, include additional features such as importing scenarios from WML. Additional tools can be developed for unit modification and any other possible campaign considerations; this will not be in the scope of my summer project.		During the summer, I expect to build an editor that can produce playable scenarios to be used in full campaigns. The editor will be flexible enough to, at some point, include additional features such as importing scenarios from WML. Additional tools can be developed for unit modification and any other possible campaign considerations; this will not be in the scope of my summer project.

	The editor will be written in C++. This is my most proficient language, and it allows better integration with other aspects of Wesnoth. (For one thing, map-viewing code could potentially be re-used.) The editor will use Wesnoth's own GUI toolkit, which Mordante is currently developing. This will help to give the editor a united feel with the game itself.		The editor will be written in C++. This is my most proficient language, and it allows better integration with other aspects of Wesnoth. (For one thing, map-viewing code could potentially be re-used.) The editor will use Wesnoth's own GUI toolkit, which Mordante is currently developing. This will help to give the editor a united feel with the game itself.

	I believe this project will help me to improve my practical software development abilities while doing something I enjoy. I fully intend to continue improving the editor, and possibly contributing to other areas of Wesnoth, once the SoC period is complete.		I believe this project will help me to improve my practical software development abilities while doing something I enjoy. I fully intend to continue improving the editor, and possibly contributing to other areas of Wesnoth, once the SoC period is complete.

	==Practical considerations==		==Practical considerations==
	I am very familiar with SVN, mainly from my work on Allacrost. Also, I have been using C++ for about six years. Though I have no experience with Python, I am confident in my ability to learn programming languages quickly when needed.		I am very familiar with SVN, mainly from my work on Allacrost. Also, I have been using C++ for about six years. Though I have no experience with Python, I am confident in my ability to learn programming languages quickly when needed.

	As a Linux user, my work is mostly done on KDE development tools such as KWrite and KDevelop. I believe these are the most easily usable and visually appealing tools available for Linux. I am fluent in C++, Java, and C, with a working knowledge in Lua and a few others. Unfortunately, I am also fluent in BASIC, though I haven't touched it in years.		As a Linux user, my work is mostly done on KDE development tools such as KWrite and KDevelop. I believe these are the most easily usable and visually appealing tools available for Linux. I am fluent in C++, Java, and C, with a working knowledge in Lua and a few others. Unfortunately, I am also fluent in BASIC, though I haven't touched it in years.

	My only fluent language is English. My knowledge of Spanish is passable at best. Generally, I am awake from 14:00 to 6:00 UTC. I am able to talk over the phone; haven't really done anything with VOIP before.		My only fluent language is English. My knowledge of Spanish is passable at best. Generally, I am awake from 14:00 to 6:00 UTC. I am able to talk over the phone; haven't really done anything with VOIP before.