SummerOfCodeProposal ryanc app

From The Battle for Wesnoth Wiki

Ryan's Application Page

Optimize implementation of WML for memory usage

Basics

  1. Write a small introduction to yourself.
    My name is Ryan and I love games & games programming. :)
    I started programming at the age of 13 and picked up C++ when I was 15.
    I have since been actively learning and improving my programming skills over the years and have made a few small games in my free time.
    I haven't gotten around to getting my lazy butt to start a blog and post my work/ideas yet but that's coming soon.
  2. State your preferred email address.
    ryan@chewablestudios.com
  3. If you have chosen a nick for IRC and Wesnoth forums, what is it?
    IRC: KnightR
    Forum ID: chewryan
  4. Why do you want to participate in summer of code?
    The Wesnoth project, in particular, struck my interest for GSoC 2009 as I am training to be a professional game developer. I felt this would be the perfect opportunity to gain valuable knowledge and skills, working alongside professionals and learning what it takes to work with a team and community.
  5. What are you studying, subject, level and school?
    I am currently a first year student at DigiPen Institute of Technology - Singapore, earning a BSc in Real-Time Interactive Simulations.
    It's a fancy name for game programming ;)
  6. 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 Wesnoth. If you have gained commit access to our S­­V­­N (during the evaluation period or earlier) please state so.
    I have not contributed any patches to Wesnoth yet but intend to do so over the next few days.

Experience

  1. What programs/software have you worked on before?
    Most of the programs I have developed were small utilities and several small game projects, personal and school-related.
  2. Have you developed software in a team environment before? (As opposed to hacking on something on your own)
    I have spent two semesters working with two different student teams on game projects as part of my school curriculum.
    Aside from that, I had also spent 2 months before I began my DigiPen course interning at a professional game development company.
  3. 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?
    No I have not participated in GSoC before.

Open Source

  1. Are you already involved with any open source development projects? If yes, please describe the project and the scope of your involvement.
    I am not involved in any other open source projects.

Gaming Experience

  1. Are you a gamer?
    Most definitely :)
  2. What type of gamer are you?
    I'm a hardcore gamer ;)
  3. What type of games?
    I enjoy a wide variety of games from various genres, particularly RPGs, FPSes, platformers, RTSes and turn-based strategy games.
    Wesnoth's gameplay reminds me of classic masterpieces such as Civilization 1/2 and Master of Orion.
  4. What type of opponents do you prefer?
    I prefer mature opponents that match my skill level and provide me a challenge when playing against them.
    I also enjoy playing against opponents that introduce interesting strategies and tactics that I might not have thought of.
  5. Are you more interested in story or gameplay?
    I lean more towards enjoyable gameplay as I believe that not all games require good stories, or even a story for that matter.
    It wouldn't be much of a game if it didn't have good gameplay :)
  6. Have you played Wesnoth? If so, tell us roughly for how long and whether you lean towards single player or multiplayer.
    Yes I have but I have not gone too much in-depth as I am busy with the school semester and the GSoC proposal.
    I have yet to experience Wesnoth in a multiplayer setting so I shall reserve my opinion for when I have the time to explore the depths of Wesnoth's gameplay.
    I am enjoying the game more as I play and my first impressions are that it feels like a commercial game to me :)

Communication skills

  1. Though most of our developers are not native English speakers, English is the project's working language. Describe your fluency level in written English.
    English is my first language and I am confident of my proficiency with the language.
  2. Are you good at interacting with other players? Our developer community is friendly, but the player community can be a bit rough.
    I am a very objective person and am able to maintain communications strictly on a professional level.
  3. 3) Do you give constructive advice?
    I believe I do but that is more for others to decide :)
  4. Do you receive advice well?
    I receive advice well but will research on the subject matter if I do not agree to provide constructive counter-arguments.
  1. Are you good at sorting useful criticisms from useless ones?
    Yes I believe I am able to filter out useful criticisms.

Project

  1. 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?
    Yes, I have selected to work on the WML Memory Optimisation project.
    I would like to focus on implementing an efficient solution for reducing the memory usage taken up by WML documents when loaded.
  2. If you have invented your own project, please describe the project and the scope.
    N/A
  3. Why did you choose this project?
    I chose this project as I believe it would provide a challenging experience.
    I feel my current programming skill level is sufficient for the task at hand and I am confident that I can produce desirable results.
  4. 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".
    My school semester ends on the 29th of April and as such, I am unable to dedicate much time to the project before the aforementioned date.
    May::
    • Get a better feel of how the Wesnoth developers work.
    • Study WML's technical implementation (learn how documents are parsed).
    • Profile WML's memory usage and identify areas which are taking up large amounts of memory.
    • Research on various implementations to reduce memory usage.
    • Run ideas through developers and community for optimal solutions and refine them.
    June::
    • Implement initial solutions and test, test, test.
    • Research other possible areas of improvement.
    July:
    • Research stops and working time should all be spent on continued implementation of discussed and agreed-upon solutions (no more new stuff).
    • Prepare for mid-term evaluation.
    August::
    • Testing and bug fixing.
    • Wrap up for final evaluation.
  5. Include as much technical detail about your implementation as you can.
    Currently, one of the major memory hogs is the use of std::map and the large amounts of strings stored by the config class.
    The idea would be to find an efficient implementation to replace the usage of a map, reduce string duplicates and, if needed, revert to simpler data structures.
    Here are several ideas for implementation:
    • Use a simple hash (with caching and fast reverse-hashing features) as the key instead of std::string.
    • Store values in their integral forms instead of std::string.
    • Find a viable replacement for std::map, like an ordered vector which indexes into values.
    Time would also have to be allocated to study WML's technical implementation and possibly detail it in a technical document as I understand the documentation is lacking at the moment.
    There will probably be other areas for improvement as well, like lazy-loading, but those will have to wait until I fully understand the inner-workings of WML.
  6. What do you expect to gain from this project?
    Working on an OSS project for the first time, I expect to gain valuable industry skills/knowledge and to learn from the experienced developers currently on the Wesnoth project.
    This experience will also provide me a chance to work in a highly diversified team and learn to manage working with developers in different locations and timezones.
  7. What would make you stay in the Wesnoth community after the conclusion of SOC?
    Wesnoth is a fun little game that I can see myself dedicated time and energy to developing even after GSoC.
    Plus, I wouldn't pass up on the chance to continue learning from the Wesnoth developers and expand my programming.

Practical considerations

  1. Are you familiar with any of the following tools or languages?
    • S­­V­­N - Yes.
    • C++ - Yes.
    • Python - No.
    • Build Environments - Basics but don't use it much.
  2. Which tools do you normally use for development? Why do you use them?
    I use Visual Studio as my main IDE tool but am occassionally use g++ with Notepad++.
    As an aspiring game developer, I am rather limited to working on Windows machines for developing games and my school's curriculum focuses mostly on Windows game development.
    Apart from MSVC being a mandatory tool for me, the IDE's debugger is one of the best tools available for debugging.
    I am also familiar with Linux development and favour the Ubuntu flavour :)
  3. What programming languages are you fluent in?
    C++, C#
  4. What spoken languages are you fluent in?
    I am fluent in English and Chinese.
  5. At what hours are you awake and when will you be able to be in IRC (please specify in UTC)
    I am on the GMT +8 timezone and am usually awake from
    4:00am UTC to 4:00pm UTC
    and will probably be available in IRC during those times if I do not have any prior arrangements.
  6. 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.
    Nope I don't mind at all. :)
This page was last edited on 20 March 2013, at 23:18.