mirror of
https://github.com/evennia/evennia.git
synced 2026-03-16 21:06:30 +01:00
More doc updates
This commit is contained in:
parent
f468005a34
commit
9d99ce283e
4 changed files with 11 additions and 28 deletions
|
|
@ -5,11 +5,11 @@ name: test-suite
|
|||
|
||||
on:
|
||||
push:
|
||||
branches: [master, develop]
|
||||
branches: [main, develop]
|
||||
paths-ignore:
|
||||
- "docs/**"
|
||||
pull_request:
|
||||
branches: [master, develop]
|
||||
branches: [main, develop]
|
||||
|
||||
jobs:
|
||||
test:
|
||||
|
|
@ -95,7 +95,7 @@ jobs:
|
|||
# it's also not critical if pushing to either service fails (happens for PRs since env is not
|
||||
# available outside of the evennia org)
|
||||
- name: Send data to Coveralls
|
||||
if: ${{ matrix.coverage-test && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/develop') }}
|
||||
if: ${{ matrix.coverage-test && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop') }}
|
||||
continue-on-error: true
|
||||
env:
|
||||
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
|
||||
|
|
|
|||
|
|
@ -13,12 +13,6 @@ If you are converting an existing game from a previous version, [see here](./Ins
|
|||
For the impatient. If you have trouble with a step, you should jump on to the
|
||||
more detailed instructions for your platform.
|
||||
|
||||
```{warning}
|
||||
Currently, these instructions will install 'latest' (stable) Evennia, which is
|
||||
the 0.9.5 version. To install 1.0-dev, you need to add a step `git checkout develop` between steps
|
||||
3 and 4 below.
|
||||
```
|
||||
|
||||
1. Install Python and GIT. Start a Console/Terminal.
|
||||
2. `cd` to some place you want to do your development (like a folder
|
||||
`/home/anna/muddev/` on Linux or a folder in your personal user directory on Windows).
|
||||
|
|
|
|||
|
|
@ -7,18 +7,18 @@ over things manually.
|
|||
|
||||
### Upgrading the Evennia library
|
||||
|
||||
Prior to 1.0, all Evennia installs were [Git-installs](./Installation-Git.md). These instructions assume that you have a cloned `evennia` repo and use a virtualenv (best practices).
|
||||
Prior to 1.0, all Evennia installs were [Git-installs](./Installation-Git.md). 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 stop` from your game dir.
|
||||
- `deactivate` to leave your active virtualenv.
|
||||
- Install Python 3.11 (recommended). Follow the [Git-installation](./Installation-Git.md) for your OS if needed.
|
||||
- Delete the old virtualenv `evenv` folder, or rename it (in case you want to keep using 0.9.5 for a while).
|
||||
- Make _new_ `evenv` virtualenv (see the [virtualenv instructions](./Installation-Git.md#virtualenv) for help)
|
||||
- `cd` into your `evennia/` root folder (you want to see the `docs/` and `bin/` directories as well as a nested `evennia/` folder)
|
||||
- Make a _new_ `evenv` virtualenv (see the [virtualenv instructions](./Installation-Git.md#virtualenv) for help) and make sure it's active
|
||||
- `cd` into your `evennia/` root folder (you want to be where you see the `docs/` and `bin/` directories as well as a nested `evennia/` folder)
|
||||
- `git pull`
|
||||
- `git checkout develop` TODO - only until 1.0 release.
|
||||
- `pip install -e .`
|
||||
- If you want the optional extra libs (needed by some contribs), do `pip install -e .[extra]`
|
||||
- `git checkout main` (the `master`)
|
||||
- `pip install -e --upgrade .`
|
||||
- If you want the optional extra libs (needed by some contribs), do `pip install -e --upgrade .[extra]`
|
||||
- Test that you can run the `evennia` command.
|
||||
|
||||
### Upgrading your game dir
|
||||
|
|
@ -29,9 +29,8 @@ If you don't have anything you want to keep in your existing game dir, you can j
|
|||
- `cd` to your existing 0.9.5-based game folder (like `mygame`).
|
||||
- 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.
|
||||
- Copy `evennia/evennia/game_template/web` to `mygame/` (e.g. using `cp -Rf` or a file manager). This new `web` folder _replaces the old one_ and has a very different structure.
|
||||
- It's possible you need to replace/comment out import and calls to the deprecated
|
||||
[`django.conf.urls`](https://docs.djangoproject.com/en/3.2/ref/urls/#url). The new way to call it is [available here](https://docs.djangoproject.com/en/4.0/ref/urls/#django.urls.re_path).
|
||||
- Run `evennia migrate`
|
||||
- It's possible you need to replace/comment out import and calls to the deprecated [`django.conf.urls`](https://docs.djangoproject.com/en/3.2/ref/urls/#url). The new way to call it is [available here](https://docs.djangoproject.com/en/4.0/ref/urls/#django.urls.re_path).
|
||||
- Run `evennia migrate` - note that it's normal to see some warnings here, _don't_ run `makemigrations` even if the system asks you to.
|
||||
- Run `evennia start`
|
||||
|
||||
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:
|
||||
|
|
|
|||
|
|
@ -1,13 +1,3 @@
|
|||
|
||||
```{warning}
|
||||
|
||||
This is the **WIP** documentation of the development branch of Evennia (v1.0-dev).
|
||||
|
||||
Unless you are beta-testing the new version, you are likely best
|
||||
off using v0.9.5 of the docs (switch to it in the bottom left)
|
||||
or the original github wiki. You have been warned.
|
||||
```
|
||||
|
||||
# Evennia Documentation
|
||||
|
||||
This is the manual of [Evennia](https://www.evennia.com), the open source Python `MU*` creation system. Use the Search bar on the left to find or discover interesting articles.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue