Upgrading an existing installation¶
This is relevant to you already having code in an older Evennia version. If you are new, or don’t have much code yet, it may be easier to just start fresh with the Installation instructions and copy over things manually.
Evennia v0.9.5 to 1.0+¶
Upgrading the Evennia library¶
Prior to 1.0, all Evennia installs were Git-installs. These instructions assume that you already have a cloned
evennia repo, and use a virtualenv (best practices).
Make sure to stop Evennia 0.9.5 entirely with
evennia stopfrom your game dir.
deactivateto leave your active virtualenv.
Delete the old virtualenv
evenvfolder, or rename it (in case you want to keep using 0.9.5 for a while).
evennia/root folder (you want to be where you see the
bin/directories as well as a nested
git checkout main(instead of
masterwhich was used for
From here on, proceed with the Git Installation, except skip cloning Evennia (since you already have the repo). Note that you can also follow the normal pip install if you don’t need or want to use git to track bleeding edge changes nor want to be able to help contribute to Evennia itself.
Upgrading your game dir¶
If you don’t have anything you want to keep in your existing game dir, you can just start a new one using the normal install instructions. If you want to keep/convert your existing game dir, continue below.
First, make a backup of your exising game dir! If you use version control, make sure to commit your current state.
cdto your existing 0.9.5-based game folder (like
If you have changed
mygame/web, rename the folder to
web_0.9.5. If you didn’t change anything (or don’t have anything you want to keep), you can delete it entirely.
cp -Rfor a file manager). This new
webfolder replaces the old one and has a very different structure.
evennia migrate- note that it’s normal to see some warnings here, don’t run
makemigrationseven if the system asks you to.
If you made extensive work in your game dir, you may well find that you need to do some (hopefully minor) changes to your code before it will start with Evennia 1.0. Some important points:
evennia/contrib/folder changed structure - there are now categorized sub-folders, so you have to update your imports.
webchanges need to be moved back from your backup into the new structure of
See the Evennia 1.0 Changelog for all changes.