Contributing to Andor's Trail - Contribution Guide
Posted: Sun Jan 26, 2014 11:01 pm
Hello fellow adventurers,
It's been a long time since I wanted to write this post, but time was missing, and I had to organize my ideas constructively to make it useful.
The intent of this post is to show you the way to start creating all types of content for AT. This will not necessarily be an in-depth guide to everything, but you should know that it has the words "DON'T PANIC" in large, friendly letters on the cover.
I have to thank our forum overlord sdevaney and long-time contributor and highly skilled writer ctnbeh13 who worked on a "How to contribute? What to do?" FAQ which I discovered after starting this one, and from which I borrowed full chunks of text and ideas. After all, reading ctnbeh13's words, I knew that my non-native English just couldn't compete...
Introduction
As an introduction, I should say that Andor's Trail is not your typical, content-craving, open-source project. The original author of the game, Oskar Wiksten, has a clear vision, not only for the gameplay and storylines, but also on the development process. For those who don't know him, he's very open-minded and thankful to the community, and doesn't have a fixed roadmap, but he's still our BDFL (benevolent dictator for life), so in the end, he decides what gets included or not.
The two following documents are a must-read to fully grasp how he sees Andor's Trail: his interview with Hookshot Inc. from March 2012 and the rationale of Andor's Trail on the wiki.
Further reading, still on the wiki: the world of Andor's Trail, and the already rejected ideas
Globally, the whole developer section of the Andor's Trail wiki is full enough of information for you to get started. Actually, that's what got me started. I just wanted to synthesize it all, and gather the useful links in one place. Moreover, some of it could use some update (ongoing), and some of it I just do differently. It is very possible that I will just end up copy-pasting some content from this post to the wiki in a further point in time.
Remember that Andor's Trail is open-source, and we are really open to all kind of contributions. After all, the more you contribute, the biggest the next update
Don't be afraid, we really appreciate all kind of suggestions. We will never ever send you back home or throw away what you did. If we think that something could be changed, or that some more work is needed, we will explain constructively why and how, and more generally help you out.
Moreover, you don't have to take on a task alone. You can team up with other members with whom you share an opinion on a feature to get it done.
What can you contribute ?
Content Creation
--Graphics
--Maps
--Game objects
--Translations
Development
--Set up the build environment
--Get familiar with Git
--Edit the code !
Content integration
--Project Layout presentation
--Generalities
--Testing and integrating a new map
--Testing and integrating new game objects
--Integrate your new sprites/spritesheets in the game
--Integrate your translation
Conclusion
Appendix A - Setup the build environment on an offline system.
Appendix B - View the Javadoc and/or sources of the Android API
Appendix C - Content Format Reference
It's been a long time since I wanted to write this post, but time was missing, and I had to organize my ideas constructively to make it useful.
The intent of this post is to show you the way to start creating all types of content for AT. This will not necessarily be an in-depth guide to everything, but you should know that it has the words "DON'T PANIC" in large, friendly letters on the cover.
I have to thank our forum overlord sdevaney and long-time contributor and highly skilled writer ctnbeh13 who worked on a "How to contribute? What to do?" FAQ which I discovered after starting this one, and from which I borrowed full chunks of text and ideas. After all, reading ctnbeh13's words, I knew that my non-native English just couldn't compete...
Introduction
As an introduction, I should say that Andor's Trail is not your typical, content-craving, open-source project. The original author of the game, Oskar Wiksten, has a clear vision, not only for the gameplay and storylines, but also on the development process. For those who don't know him, he's very open-minded and thankful to the community, and doesn't have a fixed roadmap, but he's still our BDFL (benevolent dictator for life), so in the end, he decides what gets included or not.
The two following documents are a must-read to fully grasp how he sees Andor's Trail: his interview with Hookshot Inc. from March 2012 and the rationale of Andor's Trail on the wiki.
Further reading, still on the wiki: the world of Andor's Trail, and the already rejected ideas
Globally, the whole developer section of the Andor's Trail wiki is full enough of information for you to get started. Actually, that's what got me started. I just wanted to synthesize it all, and gather the useful links in one place. Moreover, some of it could use some update (ongoing), and some of it I just do differently. It is very possible that I will just end up copy-pasting some content from this post to the wiki in a further point in time.
Remember that Andor's Trail is open-source, and we are really open to all kind of contributions. After all, the more you contribute, the biggest the next update
Don't be afraid, we really appreciate all kind of suggestions. We will never ever send you back home or throw away what you did. If we think that something could be changed, or that some more work is needed, we will explain constructively why and how, and more generally help you out.
Moreover, you don't have to take on a task alone. You can team up with other members with whom you share an opinion on a feature to get it done.
Table of contentsctnbeh13 wrote:There are an abundance of great ideas and suggestions, to which we welcome, appreciate, and encourage you to continue to offer up. One of the main factors that determines if and when these might see the light of day in-game is who has the time to commit to their development. This often applies to content that some might assume should just be added to the current workload of those who are writing the game code. Should you read of a fellow forum member's idea or suggestion that you may strongly agree with and support, taking the time to send that individual a P.M. to inquire about working together to make it happen, or work towards completion to the best of your ability, is another great way to contribute.
What can you contribute ?
Content Creation
--Graphics
--Maps
--Game objects
--Translations
Development
--Set up the build environment
--Get familiar with Git
--Edit the code !
Content integration
--Project Layout presentation
--Generalities
--Testing and integrating a new map
--Testing and integrating new game objects
--Integrate your new sprites/spritesheets in the game
--Integrate your translation
Conclusion
Appendix A - Setup the build environment on an offline system.
Appendix B - View the Javadoc and/or sources of the Android API
Appendix C - Content Format Reference