New Contributors

From Hero of Allacrost Wiki
Revision as of 18:22, 18 December 2016 by (talk) (Online Resources: - by Roots)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This document is an orientation for people who are new to the Allacrost project and wish to lend their talents.


The Allacrost project began in June 2004. Throughout the years, our team has ranged from being very small (1-2 members) to very large (30 members). Our primary means of communication with each other, as well as with our community, is through our forums. We also chat in our IRC channel, #allacrost on No monetary compensation is offered through participation in the project. Everyone has their own personal reasons for contributing, whether it is to gain experience for their resume or portfolio, improve their skills, or simply because they enjoy it.

How Do I Join?[edit]

There is no formal process to join the team. Allacrost is an open source project, and our development model is open as well. We consider you a part of the team as soon as you make your first contribution.

Getting Started[edit]

To begin contributing to the project, here's a recommended list of steps to take.

  1. Read (or skim through) this entire page.
  2. Take a glance at our Roadmap to learn what our next major milestone is and what we need to do to get there.
  3. Create an account on our forums
  4. Post on the forums and introduce yourself, and let the team know what you'd like to help out with (art, programming, etc).
  5. Read through any relevant pages to your area of work on the wiki. The Main Page organizes the most important pages for each area.
  6. Download and play through the latest release, or (if available) watch a playthrough video of it online.
  7. Complete a simple task that was suggested to you by the team and share your work with us on the forums.
  8. Continue asking for additional tasks to work on. Or take initiative and volunteer yourself to work on things needed from the Roadmap.

Whether you are a programmer, artist, musician, or something else, the best way to get started is to first make a post on our forums. Introduce yourself to us and state what it is that you'd like to help out with. We strongly encourage you to start out by working on something small that you are comfortable doing. Joining a large project with a long history can be intimidating, so getting some early gratification by completing something is strongly recommended. It also demonstrates to the team that you are committed to being a part of the project.

After completing your first task, you will be given the status of "Contributor" on the forums, which is your official acceptance as part of the team. From there, you can ask for more tasks, or track the ongoing discussions on the forum and find ways to help. It is recommended to keep performing small, easily-completed tasks for your first few days or weeks as you get accustomed to working on the project. Over time, you'll find yourself better prepared to handle larger and more complex tasks.

At the bottom of this page, you'll find links that will take you to additional information relative to the type of work that you will be doing.

General Advice[edit]

Allacrost is an old project with a lot of history and a lot of code. It is natural to feel a bit overwhelmed at the start. Here's some recommendations on how to narrow your focus and make your first weeks more manageable and enjoyable.

  • Do not try to read the whole forum or wiki. Reading old discussions is going to be little to no help to you, and more than likely will just be a waste of your time. Instead, we recommend you only look through active and recent discussions to learn what issues we're encountering and design decisions we are making at the moment. And if you have an opinion on a recent topic, go ahead and share it. Getting engaged with active discussions about the game is really encouraged and will keep you more motivated and interested in your work.
  • Do download and play an hour or so of the most recent release. As you do so, think about the flaws you encounter and how you might use your skills to improve it. For example, is there some artwork that seems out-of-place or lacking in quality compared with the rest? Did you discover any bugs or issues with the game's operation? Are the game menus intuitive and well-designed?
  • Do not think too much about the big picture at first. Narrow your focus to something with a limited scope when starting out. Either by completing a sprite animation or fixing a few small bugs. Trying to jump right into very complex and complicated work is typically discouraging. Start small and as you gain experience, build up to larger and more complex tasks.
  • Do ask for as much help as you need starting out. Whether you are struggling with building the game, understanding our designs, or working with the code, we want to help you. Don't let yourself get stuck on something for long.
  • Do not commit yourself more to this project than you reasonably can. This is supposed to be a fun and enjoyable experience for you. If you try to cram every free minute you have into it, this will become a source of stress for you and you'll eventually burn out. There's no reason why you can't take a few days or weeks off either when you don't have the time or energy for this hobby.
  • Do stay active and engaged on the forums. Participating in conversations and design decisions is the best way to keep your interest in what we are doing and shape the direction that this game takes. If you just want to be a work-horse though, that's fine. But we really encourage people to take a stake in shaping up what Allacrost is to be and make their mark on the designs.

Team Hierarchy[edit]

  • Contributors are those who have made a small amount of meaningful contributions
  • Staff are those who have distinguished themselves from normal contributors through their experience on the team and ability to handle larger tasks
  • Leaders are seasoned veterans who have put a serious amount of their time into the project. They hold the most influence and are usually involved in the game design.

We have a pretty loose and relaxed structure to our team. The three roles above signify the degree of commitment that an individual has made to a project. To get promoted, you simply need to continue contributing to the project. There are no tangible rewards for being promoted, but you do earn a higher level of respect and influence on the game's design as a result. The purpose of these "ranks" is meant simply to help us distinguish who the most influential people in the project are, in terms of how much they have contributed to our project. Being granted a higher rank means that we can feel okay to expect a little more out of you. A promotion is not a binding commitment where we expect you to spend more of your time working on Allacrost. Generally, we never demote anyone to a lower rank.

Team Policies[edit]

The following are a few recommendations to get the most out of your time with us here. Following these policies will help you to be more happy, productive, and enable you to work better with other team members.


Help each other improve their work with feedback and modifications.

Collaboration means that we help each other improve our work. Most often, this comes in the form of verbal feedback and suggestions for how someone can improve a feature or art piece that they are working on. Other times someone may directly modify your work and present it as a possible improvement. For example, if you are working on a sprite and share a draft of it, another artist may build upon it or greatly modify it to present an improved version. Do not take this act personally as an insult to the original owner of the work or as a kind of "theft". The end goal for the team is to produce the best product possible, and collaboration is one means that we use to reach that goal.


Ask for feedback on your work, and give your feedback to others.

As you are are working on a new feature, composition, or whatever task you are doing, continually share your work with the team throughout the design process. This could be drafts of images or music, implementation ideas for code, map layouts, etc. The reason we encourage you to share your works in progress regularly is so that we can make sure that it meets expectations and you can receive suggestions and critiques of the work. It is very frustrating to work on a difficult task for a long time, only for the "finished" product you present to be poorly received, or find out that you had incorrect assumptions about the expectations for your work. It will save you time and frustration by sharing your work frequently, and will more than likely help your final product be better than it would have been otherwise as well.


Speak your mind freely, even when you disagree with the majority.

Don't be afraid if you have a different opinion from everyone else. It's a good thing. No one will punish you if you think something should be done in another way. This game belongs to each of us, not to a single person. When we have different opinions about something on the team, we discuss our options and go with a majority vote on the issue.


Take a break when you need to, but let others know.

Sometimes, life happens. You have to move, you get a second job, or something else greatly reduces your availability to contribute to Allacrost. If that happens, please be sure to let us know of your situation. Don't just completely disappear on us without a word, because after not hearing from people for a while we begin to question whether or not they'll come back.


Don't be afraid if you want to switch to something new.

If you were assigned with a task that you have become disinterested or tired with and would like to work on something else, let us know. There is a ton of work to do for Allacrost and it's almost guaranteed that we can find you something else to work on that you are interested in.


Most of all, make sure that you're having fun.

You are not being paid to work on this project. Therefore if you are not enjoying the work that you are doing. then there's not much reason for you to be working at all. All of us here came together because we saw potential in this game, and were willing to dedication our time and effort to realizing that potential. Please remember this, and if you find that you're not enjoying yourself, don't be afraid to talk about it with someone or share your discontent with the team. We can help you find ways to improve the situation.

Online Resources[edit]

Our project has several online services which our team uses on a daily basis to help us track our progress, communicate with one another, or archive our files. A list of all available services is first, followed by information on how to get an account, or get elevated privileges to an account, with each service. The are ordered according to their relative importance to the project.


Our primary medium of communication on this team is through the forums. We probably hold over 90% of our discussions and decisions on the forums, so its critical for you to stay informed of forum topics relevant to your work. Our forums include a private section that is only visible to team members, although most of our forum discussions take place in the public areas.


We use our wiki for a wide variety of purposes, including documentation, standards for code/art/music, and other miscellaneous project information. It is greatly appreciated if you can spare some time to help keep the wiki up-to-date and continue to improve and expand the information shared there.


We maintain a Discord server to host our real-time discussions, which can be accessed in your web browser. The server is open to the public to view and comment, just like the forums. The forums are preferred over chat for structured, persistent conversations and serve as our primary means of communication.


  • #allacrost, #allacrost-dev @
  • Account creation is optional. You do not need an account to join the IRC channel.

NOTE: Use of our IRC channels were deprecated in favor of our chat server at the end of 2016. The IRC channels will remain, but real time communication should be preferred on the chat server.

Our team has two IRC channels available for real-time chat. The first, #allacrost, is available for anyone to join. The second, #allacrost-dev, is password-protected and available only to team members. We primarily chat in the public channel and only use the private channel for meetings and important discussions. IRC participation is encouraged, but optional. It is especially helpful for developers and game designers to use the IRC channel to get instant help or feedback.


If desired, any team member can have a personal FTP account and space created for them. This is useful if you have several files that you would like to share, such as concept art, early versions of a piece of music or a sprite, and so on. Artists and musicians are highly encouraged to ask for an account and use the FTP to share and organize all of their work. You can create whatever folders you would like and organize your FTP space in any manner that you wish. Once you upload your work, it is very simple to share a link to your work for others to examine.

Note that your FTP has no quota, but we ask that you do not abuse this privilege by uploading personal content not related to Allacrost. Do not upload copyrighted content that you do not have permission to share.

BitBucket (repository, release files, issue tracker)[edit]

Allacrost's project files are hosted on BitBucket. This page also hosts our issue tracker and release files. (Note: Allacrost used to be hosted on Sourceforge, and while we still have a project page up there hosting some older release files, it is otherwise inactive).


Our website serves as our primary portal to the public. We share information about the project, major news updates, media releases (including screenshots), and announce new product releases here. The website allows people to post comments on news stories. Create an account on the website if you would like to post comments or plan to be creating or administrating pages.


Some members may wish to use an Allacrost e-mail address. An official e-mail address is just like any other e-mail account that you can use with your favorite mail client (Microsoft Outlook, Mozilla Thunderbird, etc.). You can also access your e-mail through a webmail client at the address provided above. A second option is a forwarding account. You can have any e-mail that is sent to to be re-directed to, for example. Some members may choose this if they want to give out their Allacrost e-mail, but continue to use an existing personal e-mail account.

Next Steps[edit]

From here, you need to learn information that is relative to your line of work. Visit the page in the list below that is most relevant to your intended roll. If there is a link for "New [Role]" available on the page that you go to, you should read through that page and it should help you get started.

Additionally, you should pay a visit to the section of the forums that is most relevant to your work and take a look at any stickied topics. Browsing through any recent discussions in your forum section is advised as well, as you will learn what items are under active development and discussion.

Setup Accounts[edit]

Once you know which online services you will be using, you'll need to create accounts on them. If possible, please try to use the same or similar alias for all of your accounts so its easy for others to know who you are when they see your name across the different services. Some services may require assistance from a team leader to setup your account, or be granted the proper permissions. A list of team leaders can be found on the forums here. Feel free to send one of them a private message.

  • Forums

Register an account at the forums. Once you submit your first contribution, a team leader will add you into the contributors forum group, granting you access to see a few hidden sections of the forums that are only viewable by the team.

  • Wiki

Register an account at the wiki. You should not need any elevated privileges here.

  • IRC

You do not need to register a nickname to use the Freenode IRC network. But if you would like to register a nickname, follow the instructions found here

  • FTP

Ask a team leader to create an account for you. You will be sent information on how to access your new FTP account.

  • Website

Look to the left hand side of the website to create an account. Ask a team leader to grant you additional permissions if you want to be able to write blog posts on the site.

  • E-mail

Ask a team leader to set this up for you. Make sure to tell them whether or not you want an e-mail account or an e-mail forwarding address setup.

  • BitBucket

You'll need to register your account on the BitBucket website if you don't have one already.