Coding and development help

This documentation aims to help you set up a sane development environment to make your game, also if you never coded before. If you are an experienced coder, much of this will be familiar to you, but some things may still be useful.

Setting up a workflow

See also the Beginner Tutorial.

• Version Control
  • Setting up Git
  • Putting your game folder under version control
  • Forking Evennia
  • Working with your Evennia fork
  • Sharing your Evennia fixes on Github
  • Making an Evennia Pull Request
  • GIT tips and tricks
• Updating Your Game
  • Updating with the latest Evennia code changes
  • Upgrading Evennia dependencies
  • Migrating the Database Schema
  • Resetting your database
  • More about schema migrations

Coding away

• Coding Introduction
  • Start with the tutorial
  • Python
  • Explore Evennia interactively
  • Use a python syntax checker
  • Plan before you code
  • Code in your game folder, not in the evennia/ repository
  • Learn to read tracebacks
  • Docs are here to help you
  • The most important point
• Debugging
  • Debugging Evennia
  • A simple example using pdb
  • Cheat-sheet of pdb/pudb commands
• Unit Testing
  • Running the Evennia test suite
  • Running tests for your game dir
  • Writing new tests
  • Using the Evennia testing classes
  • Unit testing contribs with custom models
  • A note on making the test runner faster
• Profiling
  • Introduction
  • Simple timer tests
  • Using cProfile
  • The Dummyrunner
• Quirks
  • Forgetting to use reload to see changes to your typeclasses
  • Web admin to create new Account
  • Mutable attributes and their connection to the database
  • Commands are matched by name or alias
  • Objects turning to DefaultObject
  • Overriding of magic methods
  • Things to remember about the flat API
• Changelog
  • Evennia 1.0
  • Evennia 0.9.5
  • Evennia 0.9
  • Evennia 0.8
• Overview-Changelogs
  • Sept 2017:
  • Feb 2017:
  • Dec 2016:
  • May 2016:
  • Feb 2016:
  • Sept 2015:
  • Feb 2015:
  • Sept 2014:
  • Jan 2014:
  • Nov 2013:
  • May 2013:
  • Oct 2012:
  • March 2012:
  • Nov 2011:
  • Aug 2011:
  • May 2011:
  • Aug 2010:
  • May 2010:
  • April 2010:
• Older

Third-party integrations

• Continuous Integration
  • What is Continuous Integration (CI)?
  • List of continuous integration tools
• Setting up PyCharm with Evennia
  • Setting up the project interpreter
  • Attaching PyCharm debugger to Evennia
  • Setting up an Evennia run configuration
  • Alternative run configuration - utilizing logfiles as source of data