Clone wiki

trosnoth / Contribute to Trosnoth

Contributing to Trosnoth

Source Code

The Trosnoth source code repository can be accessed on bitbucket. You can fork the repository by clicking the + in the global sidebar and selecting Fork this repository.

Development Environment

If you don't yet have a favourite Python editor, we recommend using PyCharm community edition. PyCharm gives you easy code navigation and static checking. We've even added some PyCharm project settings to the Trosnoth repo so you can easily spin up a Trosnoth server, play a Trosnoth solo game, or run the test suite.

Communication

  • Most communication about Trosnoth development takes place on the Trosnoth Slack. However, you'll need an invitation to join. To request to join the Slack, send an email to the Trosnoth developers Google group and introduce yourself (see below).
  • Before setting up Slack, we used to use the Trosnoth developers Google group to communicate. It doesn't see much traffic these days, but it's still a great way to introduce yourself to the community.
  • Bug reports should go on the issue tracker
  • Ideas, brainstorming and feature requests are on this page, and can also be sent to the Trosnoth developers group. If you're new to Trosnoth development, you probably don't have write access to the wiki, so just send your idea to the Google group.
  • Work in progress by regular Trosnoth devs can be seen on the Trosnoth Trello board.

Dependencies

Once you've got your IDE set up, and cloned the repository, you'll need to install the dependencies. Dependencies for the development version of Trosnoth are:

  • Python 3.6+
  • Twisted (16.0 or newer)
  • Pygame
  • If on Windows, pywin32

Getting started

To start to get an understanding of how Trosnoth works inside, read Getting Started. The following how-to guides explain the process of some Trosnoth coding you might find interesting:

See Also

Updated