Metadata-Version: 2.1
Name: evennia-wiki
Version: 0.5
Summary: A simple Django app to add a wiki to Evennia
Home-page: UNKNOWN
Author: Vincent Le Goff
Author-email: vincent.legoff.srs@gmail.com
License: BSD License
Description: # evennia-wiki
        
        A simple wiki for `Evennia`, simple to install within an [Evennia](www.evennia.com) game.
        
        ## Installation
        
        You have to install Evennia beforehand.  Once done, to add the Wiki, install from pypi:
        
            pip install evennia_wiki
        
        Then, in your Evennia folder, edit `server/conf/settings.py` to add
        the installed app:
        
        ```python
        INSTALLED_APPS += (
                # ...
                "evennia_wiki",
        )
        ```
        
        Finally, in `web/urls.py`, you should add the custom URL:
        
        ```python
        custom_patterns = [
            # ...
            url(r'^wiki/', include('evennia_wiki.urls')),
        ]
        ```
        
        Donâ€™t forget to run `evennia migrate` after that.
        
        ## Usage
        
        You can now run your game:
        
            evennia start
        
        Go to your website: http://localhost:4001/wiki/ .
        
        ## Settings
        
        By default, the wiki is off-limit to players.  Only authenticated builders have access to it, to write it and read it.  You can change these defaults.
        
        The current possibility is to change this default for every page.  It is not possible to do it for a specific page.  Go to your `settings.lpy` file and change one of these settings:
        
        - `WIKI_CAN_READ`: who can read the wiki? Set to `"builder"` by default. Change it to `"anonymous"` to allow anonymous visitors to read your wiki (but not edit it).
        - `WIKI_CAN_WRITE`: who can write your wiki?  Set to `"builder"` by default.  For the time being, anonymous users cannot edit a wiki page, so you need to set it to a group of authenticated users (like `"builder"`  or `"admin"`).
        
        ## Documentation
        
        See the [project documentation hosted on Github pages](https://vincent-lg.github.io/evennia-wiki/).
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Description-Content-Type: text/markdown
