Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Refactoring contribs

Browse source
This commit is contained in:
Griatch 2021-12-18 18:02:37 +01:00
parent f5f75bd04d
commit 0ab1c30716
103 changed files with 3203 additions and 604 deletions
Download patch file Download diff file Expand all files Collapse all files

32
evennia/contrib/full_systems/evscaperoom/README.md
View file

@ -6,19 +6,19 @@ This 'Evennia escaperoom game engine' was created for the MUD Coders Guild game
Jam, April 14-May 15 2019. The theme for the jam was "One Room". This contains the
utilities and base classes and an empty example room.
The original code for the contest is found at https://github.com/Griatch/evscaperoom
but the version on the public Evennia demo is more updated, so if you really
want the latest bug fixes etc you should rather look at
https://github.com/evennia/evdemo/tree/master/evdemo/evscaperoom instead.
A copy of the full game can also be played on the Evennia demo server at
https://demo.evennia.com - just connect to the server and write `evscaperoom`
The original code for the contest is found at
https://github.com/Griatch/evscaperoom but the version on the public Evennia
demo is more updated, so if you really want the latest bug fixes etc you should
rather look at https://github.com/evennia/evdemo/tree/master/evdemo/evscaperoom
instead. A copy of the full game can also be played on the Evennia demo server
at https://demo.evennia.com - just connect to the server and write `evscaperoom`
in the first room to start!
# Introduction
Evscaperoom is, as it sounds, an escaperoom in text form. You start locked into
a room and have to figure out how to get out. This engine contains everything needed
to make a fully-featured puzzle game of this type!
a room and have to figure out how to get out. This engine contains everything
needed to make a fully-featured puzzle game of this type!
# Installation
@ -38,8 +38,9 @@ class CharacterCmdSet(...):
self.add(CmdEvscapeRoomStart())
```
Reload the server and the `evscaperoom` command will be available. The contrib comes
with a small (very small) escape room as an example.
Reload the server and the `evscaperoom` command will be available. The contrib
comes with a small (very small) escape room as an example.
# Making your own evscaperoom
@ -57,21 +58,20 @@ the following to your `mygame/server/conf/settings.py` file:
```
Reload and the example evscaperoom should still work, but you can now modify and expand
it from your game dir!
Reload and the example evscaperoom should still work, but you can now modify and
expand it from your game dir!
## Other useful settings
There are a few other settings that may be useful:
- `EVSCAPEROOM_START_STATE` - default is `state_001_start` and is the name of the
state-module to start from (without `.py`). You can change this if you want some
other naming scheme.
- `EVSCAPEROOM_START_STATE` - default is `state_001_start` and is the name of
the state-module to start from (without `.py`). You can change this if you
want some other naming scheme.
- `HELP_SUMMARY_TEXT` - this is the help blurb shown when entering `help` in
the room without an argument. The original is found at the top of
`evennia/contrib/evscaperoom/commands.py`.
# Playing the game
You should start by `look`ing around and at objects.

13
evennia/contrib/full_systems/evscaperoom/__init__.py
View file

@ -0,0 +1,13 @@
"""
Evscaperoom - Griatch 2019
"""
from .evscaperoom import commands # noqa
from .evscaperoom import menu # noqa
from .evscaperoom import objects # noqa
from .evscaperoom import room # noqa
from .evscaperoom import scripts # noqa
from .evscaperoom import state # noqa
from .evscaperoom import tests # noqa
from .evscaperoom import utils # noqa