Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-27 18:26:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

EGD: Make short_description required. Add more examples of options to README.

Browse source
This commit is contained in:
Greg Taylor 2016-04-12 12:43:46 -07:00
parent b5bd15b2e8
commit a61a1f7e32
2 changed files with 14 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

13
evennia/contrib/gamedir_client/README.md
View file

@ -81,9 +81,22 @@ Next, configure your game listing by opening up `server/conf/settings.py` and
GAME_DIRECTORY_LISTING = {
'game_status': 'pre-alpha',
# Optional, comment out or remove if N/A
'game_website': 'http://my-game.com',
'short_description': 'This is my game. It is fun. You should play it.',
# Optional but highly recommended. Markdown is supported.
'long_description': (
"Hello, there. You silly person.\n\n"
"This is the start of a new paragraph. Markdown is cool. Isn't this "
"[neat](http://evennia.com)? My game is best game. Woohoo!\n\n"
"Time to wrap this up. One final paragraph for the road."
),
'listing_contact': 'me@my-game.com',
# At minimum, specify this or the web_client_url options. Both is fine, too.
'telnet_hostname': 'my-game.com',
'telnet_port': 1234,
# 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.

2
evennia/contrib/gamedir_client/client.py
View file

@ -77,7 +77,7 @@ class EvenniaGameDirClient(object):
'game_name': settings.SERVERNAME,
'game_status': gd_config['game_status'],
'game_website': gd_config.get('game_website') or '',
'short_description': gd_config.get('short_description') or '',
'short_description': gd_config['short_description'],
'long_description': gd_config.get('long_description') or '',
'listing_contact': gd_config['listing_contact'],