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

Add syntax hilighting in egi_client/README.md.

Browse source
This commit is contained in:
Greg Taylor 2016-10-18 20:57:00 -07:00
parent 8561e3de23
commit 1781a5acda
1 changed files with 68 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

8
evennia/contrib/egi_client/README.md
View file

@ -19,6 +19,7 @@ Start by `cd`'ing to your game directory. From there, open up
`server/conf/server_services_plugins.py`. It might look something like this
if you don't have any other optional add-ons enabled:
```python
"""
Server plugin services
@ -41,11 +42,12 @@ if you don't have any other optional add-ons enabled:
server - a reference to the main server application.
"""
pass
```
To enable the client, import `EvenniaGameIndexService` and fire it up after the
Evennia server has finished starting:
```python
"""
Server plugin services
@ -70,11 +72,12 @@ Evennia server has finished starting:
"""
egi_service = EvenniaGameIndexService()
server.services.addService(egi_service)
```
Next, configure your game listing by opening up `server/conf/settings.py` and
using the following as a starting point:
```python
######################################################################
# Contrib config
######################################################################
@ -98,6 +101,7 @@ Next, configure your game listing by opening up `server/conf/settings.py` and
# At minimum, specify this or the telnet_* options. Both is fine, too.
'web_client_url': 'http://my-game.com/webclient',
}
```
The following section in this README.md will go over all possible values.