From a61a1f7e32c7280a45b3b7bf57e6cf6d113e7bb0 Mon Sep 17 00:00:00 2001 From: Greg Taylor Date: Tue, 12 Apr 2016 12:43:46 -0700 Subject: [PATCH] EGD: Make short_description required. Add more examples of options to README. --- evennia/contrib/gamedir_client/README.md | 13 +++++++++++++ evennia/contrib/gamedir_client/client.py | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/evennia/contrib/gamedir_client/README.md b/evennia/contrib/gamedir_client/README.md index bf04afa550..5d5e7d3510 100644 --- a/evennia/contrib/gamedir_client/README.md +++ b/evennia/contrib/gamedir_client/README.md @@ -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. diff --git a/evennia/contrib/gamedir_client/client.py b/evennia/contrib/gamedir_client/client.py index 33874c5f45..417a4af192 100644 --- a/evennia/contrib/gamedir_client/client.py +++ b/evennia/contrib/gamedir_client/client.py @@ -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'],