From 892d8efb9339e002f46b2ef6cfe3bc78b8087d68 Mon Sep 17 00:00:00 2001 From: Griatch Date: Wed, 17 Jun 2020 18:06:41 +0200 Subject: [PATCH] Reorganize docs into flat folder layout --- docs/source/API-refactoring.md | 46 --- docs/source/Administrative-Docs.md | 45 --- docs/source/Builder-Docs.md | 26 -- .../{ => Coding}/Continuous-Integration.md | 0 docs/source/{ => Coding}/Debugging.md | 0 .../source/{ => Coding}/Directory-Overview.md | 0 docs/source/{ => Coding}/Evennia-API.md | 0 docs/source/{ => Coding}/Profiling.md | 0 docs/source/{ => Coding}/Quirks.md | 0 .../source/{ => Coding}/Setting-up-PyCharm.md | 0 docs/source/{ => Coding}/Unit-Testing.md | 0 .../source/{ => Coding}/Updating-Your-Game.md | 0 docs/source/{ => Coding}/Using-Travis.md | 0 docs/source/{ => Coding}/Version-Control.md | 0 docs/source/{ => Component}/Accounts.md | 0 docs/source/{ => Component}/Attributes.md | 0 .../{ => Component}/Batch-Code-Processor.md | 0 .../Batch-Command-Processor.md | 0 .../{ => Component}/Batch-Processors.md | 0 .../Bootstrap-Components-and-Utilities.md | 0 docs/source/{ => Component}/Coding-Utils.md | 0 docs/source/{ => Component}/Command-Sets.md | 0 docs/source/{ => Component}/Commands.md | 0 docs/source/{ => Component}/Communications.md | 0 .../{ => Component}/Connection-Screen.md | 0 .../{ => Component}/Default-Command-Help.md | 0 docs/source/{ => Component}/EvEditor.md | 0 docs/source/{ => Component}/EvMenu.md | 0 docs/source/{ => Component}/EvMore.md | 0 docs/source/{ => Component}/Help-System.md | 0 docs/source/{ => Component}/Inputfuncs.md | 0 docs/source/{ => Component}/Locks.md | 0 docs/source/{ => Component}/MonitorHandler.md | 0 docs/source/{ => Component}/Nicks.md | 0 docs/source/{ => Component}/Objects.md | 0 .../{ => Component}/Portal-And-Server.md | 0 docs/source/{ => Component}/Scripts.md | 0 docs/source/{ => Component}/Server-Conf.md | 0 docs/source/{ => Component}/Sessions.md | 0 docs/source/{ => Component}/Signals.md | 0 .../{ => Component}/Spawner-and-Prototypes.md | 0 docs/source/{ => Component}/Tags.md | 0 docs/source/{ => Component}/TickerHandler.md | 0 docs/source/{ => Component}/Typeclasses.md | 0 docs/source/{ => Component}/Webclient.md | 0 docs/source/{ => Concept}/Async-Process.md | 0 docs/source/{ => Concept}/Banning.md | 0 .../{ => Concept}/Bootstrap-&-Evennia.md | 0 .../{ => Concept}/Building-Permissions.md | 0 docs/source/{ => Concept}/Command-System.md | 0 docs/source/{ => Concept}/Custom-Protocols.md | 0 docs/source/{ => Concept}/Guest-Logins.md | 0 .../{ => Concept}/Internationalization.md | 0 docs/source/{ => Concept}/Messagepath.md | 0 docs/source/{ => Concept}/New-Models.md | 0 docs/source/{ => Concept}/OOB.md | 0 docs/source/{ => Concept}/Soft-Code.md | 0 docs/source/{ => Concept}/Text-Encodings.md | 0 docs/source/{ => Concept}/TextTags.md | 0 .../{ => Concept}/Using-MUX-as-a-Standard.md | 0 docs/source/{ => Concept}/Web-Features.md | 0 docs/source/{ => Concept}/Zones.md | 0 .../A-voice-operated-elevator-using-events.md | 0 docs/source/{ => Contrib}/Building-menus.md | 0 .../{ => Contrib}/Dialogues-in-events.md | 0 .../{ => Contrib}/Dynamic-In-Game-Map.md | 0 .../{ => Contrib}/Static-In-Game-Map.md | 0 .../Tutorial-World-Introduction.md | 0 docs/source/Contributing-Docs.md | 37 +- docs/source/Developer-Central.md | 108 ------ docs/source/Docs-refactoring.md | 117 ------ .../{ => Howto}/Add-a-wiki-on-your-website.md | 0 .../{ => Howto}/Building-a-mech-tutorial.md | 0 docs/source/{ => Howto}/Coding-FAQ.md | 0 docs/source/{ => Howto}/Command-Cooldown.md | 0 docs/source/{ => Howto}/Command-Duration.md | 0 docs/source/{ => Howto}/Command-Prompt.md | 0 docs/source/{ => Howto}/Coordinates.md | 0 docs/source/{ => Howto}/Customize-channels.md | 0 .../source/{ => Howto}/Default-Exit-Errors.md | 0 .../{ => Howto}/Evennia-for-Diku-Users.md | 0 .../{ => Howto}/Evennia-for-MUSH-Users.md | 0 .../Evennia-for-roleplaying-sessions.md | 0 docs/source/{ => Howto}/Game-Planning.md | 0 docs/source/{ => Howto}/Gametime-Tutorial.md | 0 .../{ => Howto}/Help-System-Tutorial.md | 0 .../Implementing-a-game-rule-system.md | 0 .../Learn-Python-for-Evennia-The-Hard-Way.md | 0 .../{ => Howto}/Manually-Configuring-Color.md | 0 .../Mass-and-weight-for-objects.md | 0 docs/source/{ => Howto}/NPC-shop-Tutorial.md | 0 .../Add-a-simple-new-web-page.md | 0 .../Adding-Command-Tutorial.md | 0 .../Adding-Object-Typeclass-Tutorial.md | 0 .../StartingTutorial}/Building-Quickstart.md | 0 .../StartingTutorial}/Coding-Introduction.md | 0 .../StartingTutorial}/Execute-Python-Code.md | 0 .../StartingTutorial}/First-Steps-Coding.md | 0 ...nd-arguments,-theory-and-best-practices.md | 0 .../Python-basic-introduction.md | 0 .../Python-basic-tutorial-part-two.md | 0 .../Turn-based-Combat-System.md | 0 .../Tutorial-Searching-For-Objects.md | 0 .../Tutorial-for-basic-MUSH-like-game.md | 0 .../StartingTutorial}/Web-Tutorial.md | 0 .../{ => Howto}/Tutorial-Aggressive-NPCs.md | 0 .../{ => Howto}/Tutorial-NPCs-listening.md | 0 .../Tutorial-Tweeting-Game-Stats.md | 0 docs/source/{ => Howto}/Tutorial-Vehicles.md | 0 .../{ => Howto}/Understanding-Color-Tags.md | 0 docs/source/{ => Howto}/Weather-Tutorial.md | 0 .../{ => Howto}/Web-Character-Generation.md | 0 .../Web-Character-View-Tutorial.md | 0 docs/source/Python-3.md | 87 ----- docs/source/Roadmap.md | 5 - docs/source/Screenshot.md | 20 - docs/source/{ => Setup}/Apache-Config.md | 0 .../{ => Setup}/Arxcode-installing-help.md | 0 .../{ => Setup}/Choosing-An-SQL-Server.md | 0 .../source/{ => Setup}/Client-Support-Grid.md | 0 docs/source/{ => Setup}/Evennia-Game-Index.md | 0 docs/source/{ => Setup}/Getting-Started.md | 0 docs/source/{ => Setup}/Grapevine.md | 0 .../{ => Setup}/HAProxy-Config-(Optional).md | 0 .../How-to-connect-Evennia-to-Twitter.md | 0 docs/source/{ => Setup}/IRC.md | 0 .../{ => Setup}/Installing-on-Android.md | 0 docs/source/{ => Setup}/Online-Setup.md | 0 docs/source/{ => Setup}/RSS.md | 0 .../{ => Setup}/Running-Evennia-in-Docker.md | 0 docs/source/{ => Setup}/Security.md | 0 docs/source/{ => Setup}/Start-Stop-Reload.md | 0 docs/source/Tutorials.md | 156 -------- docs/source/Webclient-brainstorm.md | 357 ------------------ docs/source/Wiki-Index.md | 210 ----------- 135 files changed, 34 insertions(+), 1180 deletions(-) delete mode 100644 docs/source/API-refactoring.md delete mode 100644 docs/source/Administrative-Docs.md delete mode 100644 docs/source/Builder-Docs.md rename docs/source/{ => Coding}/Continuous-Integration.md (100%) rename docs/source/{ => Coding}/Debugging.md (100%) rename docs/source/{ => Coding}/Directory-Overview.md (100%) rename docs/source/{ => Coding}/Evennia-API.md (100%) rename docs/source/{ => Coding}/Profiling.md (100%) rename docs/source/{ => Coding}/Quirks.md (100%) rename docs/source/{ => Coding}/Setting-up-PyCharm.md (100%) rename docs/source/{ => Coding}/Unit-Testing.md (100%) rename docs/source/{ => Coding}/Updating-Your-Game.md (100%) rename docs/source/{ => Coding}/Using-Travis.md (100%) rename docs/source/{ => Coding}/Version-Control.md (100%) rename docs/source/{ => Component}/Accounts.md (100%) rename docs/source/{ => Component}/Attributes.md (100%) rename docs/source/{ => Component}/Batch-Code-Processor.md (100%) rename docs/source/{ => Component}/Batch-Command-Processor.md (100%) rename docs/source/{ => Component}/Batch-Processors.md (100%) rename docs/source/{ => Component}/Bootstrap-Components-and-Utilities.md (100%) rename docs/source/{ => Component}/Coding-Utils.md (100%) rename docs/source/{ => Component}/Command-Sets.md (100%) rename docs/source/{ => Component}/Commands.md (100%) rename docs/source/{ => Component}/Communications.md (100%) rename docs/source/{ => Component}/Connection-Screen.md (100%) rename docs/source/{ => Component}/Default-Command-Help.md (100%) rename docs/source/{ => Component}/EvEditor.md (100%) rename docs/source/{ => Component}/EvMenu.md (100%) rename docs/source/{ => Component}/EvMore.md (100%) rename docs/source/{ => Component}/Help-System.md (100%) rename docs/source/{ => Component}/Inputfuncs.md (100%) rename docs/source/{ => Component}/Locks.md (100%) rename docs/source/{ => Component}/MonitorHandler.md (100%) rename docs/source/{ => Component}/Nicks.md (100%) rename docs/source/{ => Component}/Objects.md (100%) rename docs/source/{ => Component}/Portal-And-Server.md (100%) rename docs/source/{ => Component}/Scripts.md (100%) rename docs/source/{ => Component}/Server-Conf.md (100%) rename docs/source/{ => Component}/Sessions.md (100%) rename docs/source/{ => Component}/Signals.md (100%) rename docs/source/{ => Component}/Spawner-and-Prototypes.md (100%) rename docs/source/{ => Component}/Tags.md (100%) rename docs/source/{ => Component}/TickerHandler.md (100%) rename docs/source/{ => Component}/Typeclasses.md (100%) rename docs/source/{ => Component}/Webclient.md (100%) rename docs/source/{ => Concept}/Async-Process.md (100%) rename docs/source/{ => Concept}/Banning.md (100%) rename docs/source/{ => Concept}/Bootstrap-&-Evennia.md (100%) rename docs/source/{ => Concept}/Building-Permissions.md (100%) rename docs/source/{ => Concept}/Command-System.md (100%) rename docs/source/{ => Concept}/Custom-Protocols.md (100%) rename docs/source/{ => Concept}/Guest-Logins.md (100%) rename docs/source/{ => Concept}/Internationalization.md (100%) rename docs/source/{ => Concept}/Messagepath.md (100%) rename docs/source/{ => Concept}/New-Models.md (100%) rename docs/source/{ => Concept}/OOB.md (100%) rename docs/source/{ => Concept}/Soft-Code.md (100%) rename docs/source/{ => Concept}/Text-Encodings.md (100%) rename docs/source/{ => Concept}/TextTags.md (100%) rename docs/source/{ => Concept}/Using-MUX-as-a-Standard.md (100%) rename docs/source/{ => Concept}/Web-Features.md (100%) rename docs/source/{ => Concept}/Zones.md (100%) rename docs/source/{ => Contrib}/A-voice-operated-elevator-using-events.md (100%) rename docs/source/{ => Contrib}/Building-menus.md (100%) rename docs/source/{ => Contrib}/Dialogues-in-events.md (100%) rename docs/source/{ => Contrib}/Dynamic-In-Game-Map.md (100%) rename docs/source/{ => Contrib}/Static-In-Game-Map.md (100%) rename docs/source/{ => Contrib}/Tutorial-World-Introduction.md (100%) delete mode 100644 docs/source/Developer-Central.md delete mode 100644 docs/source/Docs-refactoring.md rename docs/source/{ => Howto}/Add-a-wiki-on-your-website.md (100%) rename docs/source/{ => Howto}/Building-a-mech-tutorial.md (100%) rename docs/source/{ => Howto}/Coding-FAQ.md (100%) rename docs/source/{ => Howto}/Command-Cooldown.md (100%) rename docs/source/{ => Howto}/Command-Duration.md (100%) rename docs/source/{ => Howto}/Command-Prompt.md (100%) rename docs/source/{ => Howto}/Coordinates.md (100%) rename docs/source/{ => Howto}/Customize-channels.md (100%) rename docs/source/{ => Howto}/Default-Exit-Errors.md (100%) rename docs/source/{ => Howto}/Evennia-for-Diku-Users.md (100%) rename docs/source/{ => Howto}/Evennia-for-MUSH-Users.md (100%) rename docs/source/{ => Howto}/Evennia-for-roleplaying-sessions.md (100%) rename docs/source/{ => Howto}/Game-Planning.md (100%) rename docs/source/{ => Howto}/Gametime-Tutorial.md (100%) rename docs/source/{ => Howto}/Help-System-Tutorial.md (100%) rename docs/source/{ => Howto}/Implementing-a-game-rule-system.md (100%) rename docs/source/{ => Howto}/Learn-Python-for-Evennia-The-Hard-Way.md (100%) rename docs/source/{ => Howto}/Manually-Configuring-Color.md (100%) rename docs/source/{ => Howto}/Mass-and-weight-for-objects.md (100%) rename docs/source/{ => Howto}/NPC-shop-Tutorial.md (100%) rename docs/source/{ => Howto/StartingTutorial}/Add-a-simple-new-web-page.md (100%) rename docs/source/{ => Howto/StartingTutorial}/Adding-Command-Tutorial.md (100%) rename docs/source/{ => Howto/StartingTutorial}/Adding-Object-Typeclass-Tutorial.md (100%) rename docs/source/{ => Howto/StartingTutorial}/Building-Quickstart.md (100%) rename docs/source/{ => Howto/StartingTutorial}/Coding-Introduction.md (100%) rename docs/source/{ => Howto/StartingTutorial}/Execute-Python-Code.md (100%) rename docs/source/{ => Howto/StartingTutorial}/First-Steps-Coding.md (100%) rename docs/source/{ => Howto/StartingTutorial}/Parsing-command-arguments,-theory-and-best-practices.md (100%) rename docs/source/{ => Howto/StartingTutorial}/Python-basic-introduction.md (100%) rename docs/source/{ => Howto/StartingTutorial}/Python-basic-tutorial-part-two.md (100%) rename docs/source/{ => Howto/StartingTutorial}/Turn-based-Combat-System.md (100%) rename docs/source/{ => Howto/StartingTutorial}/Tutorial-Searching-For-Objects.md (100%) rename docs/source/{ => Howto/StartingTutorial}/Tutorial-for-basic-MUSH-like-game.md (100%) rename docs/source/{ => Howto/StartingTutorial}/Web-Tutorial.md (100%) rename docs/source/{ => Howto}/Tutorial-Aggressive-NPCs.md (100%) rename docs/source/{ => Howto}/Tutorial-NPCs-listening.md (100%) rename docs/source/{ => Howto}/Tutorial-Tweeting-Game-Stats.md (100%) rename docs/source/{ => Howto}/Tutorial-Vehicles.md (100%) rename docs/source/{ => Howto}/Understanding-Color-Tags.md (100%) rename docs/source/{ => Howto}/Weather-Tutorial.md (100%) rename docs/source/{ => Howto}/Web-Character-Generation.md (100%) rename docs/source/{ => Howto}/Web-Character-View-Tutorial.md (100%) delete mode 100644 docs/source/Python-3.md delete mode 100644 docs/source/Roadmap.md delete mode 100644 docs/source/Screenshot.md rename docs/source/{ => Setup}/Apache-Config.md (100%) rename docs/source/{ => Setup}/Arxcode-installing-help.md (100%) rename docs/source/{ => Setup}/Choosing-An-SQL-Server.md (100%) rename docs/source/{ => Setup}/Client-Support-Grid.md (100%) rename docs/source/{ => Setup}/Evennia-Game-Index.md (100%) rename docs/source/{ => Setup}/Getting-Started.md (100%) rename docs/source/{ => Setup}/Grapevine.md (100%) rename docs/source/{ => Setup}/HAProxy-Config-(Optional).md (100%) rename docs/source/{ => Setup}/How-to-connect-Evennia-to-Twitter.md (100%) rename docs/source/{ => Setup}/IRC.md (100%) rename docs/source/{ => Setup}/Installing-on-Android.md (100%) rename docs/source/{ => Setup}/Online-Setup.md (100%) rename docs/source/{ => Setup}/RSS.md (100%) rename docs/source/{ => Setup}/Running-Evennia-in-Docker.md (100%) rename docs/source/{ => Setup}/Security.md (100%) rename docs/source/{ => Setup}/Start-Stop-Reload.md (100%) delete mode 100644 docs/source/Tutorials.md delete mode 100644 docs/source/Webclient-brainstorm.md delete mode 100644 docs/source/Wiki-Index.md diff --git a/docs/source/API-refactoring.md b/docs/source/API-refactoring.md deleted file mode 100644 index ac9198f04b..0000000000 --- a/docs/source/API-refactoring.md +++ /dev/null @@ -1,46 +0,0 @@ -# API refactoring - -Building up to Evennia 1.0 and beyond, it's time to comb through the Evennia API for old cruft. This -whitepage is for anyone interested to contribute with their views on what part of the API needs -refactoring, cleanup or clarification (or extension!) - -Note that this is not a forum. To keep things clean, each opinion text should ideally present a -clear argument or lay out a suggestion. Asking for clarification and any side-discussions should be -held in chat or forum. - ---- - -### Griatch (Aug 13, 2019) - -This is how to enter an opinion. Use any markdown needed but stay within your section. Also remember -to copy your text to the clipboard before saving since if someone else edited the wiki in the -meantime you'll have to start over. - -### Griatch (Sept 2, 2019) - -I don't agree with removing explicit keywords as suggested by [Johnny on Aug 29 below](API- -refactoring#reduce-usage-of-optionalpositional-arguments-aug-29-2019). Overriding such a method can -still be done by `get(self, **kwargs)` if so desired, making the kwargs explicit helps IMO -readability of the API. If just giving a generic `**kwargs`, one must read the docstring or even the -code to see which keywords are valid. - -On the other hand, I think it makes sense to as a standard offer an extra `**kwargs` at the end of -arg-lists for common methods that are expected to be over-ridden. This make the API more flexible by -hinting to the dev that they could expand their own over-ridden implementation with their own -keyword arguments if so desired. - ---- - -### Johnny - -#### Reduce usage of optional/positional arguments (Aug 29, 2019) -``` -# AttributeHandler -def get(self, key=None, default=None, category=None, return_obj=False, - strattr=False, raise_exception=False, accessing_obj=None, - default_access=True, return_list=False): -``` -Many classes have methods requiring lengthy positional argument lists, which are tedious and error- -prone to extend and override especially in cases where not all arguments are even required. It would -be useful if arguments were reserved for required inputs and anything else relegated to kwargs for -easier passthrough on extension. \ No newline at end of file diff --git a/docs/source/Administrative-Docs.md b/docs/source/Administrative-Docs.md deleted file mode 100644 index 78bfce6238..0000000000 --- a/docs/source/Administrative-Docs.md +++ /dev/null @@ -1,45 +0,0 @@ -# Administrative Docs - -The following pages are aimed at game administrators -- the higher-ups that possess shell access and -are responsible for managing the game. - -### Installation and Early Life - -- [Choosing (and installing) an SQL Server](Choosing-An-SQL-Server) -- [Getting Started - Installing Evennia](Getting-Started) -- [Running Evennia in Docker Containers](Running-Evennia-in-Docker) -- [Starting, stopping, reloading and resetting Evennia](Start-Stop-Reload) -- [Keeping your game up to date](Updating-Your-Game) - - [Resetting your database](Updating-Your-Game#resetting-your-database) -- [Making your game available online](Online-Setup) - - [Hosting options](Online-Setup#hosting-options) - - [Securing your server with SSL/Let's Encrypt](Online-Setup#ssl) -- [Listing your game](Evennia-Game-Index) at the online [Evennia game -index](http://games.evennia.com) - -### Customizing the server - -- [Changing the Settings](Server-Conf#Settings-file) - - [Available Master Settings](https://github.com/evennia/evennia/blob/master/evennia/settings_default.py) -- [Change Evennia's language](Internationalization) (internationalization) -- [Apache webserver configuration](Apache-Config) (optional) -- [Changing text encodings used by the server](Text-Encodings) -- [The Connection Screen](Connection-Screen) -- [Guest Logins](Guest-Logins) -- [How to connect Evennia to IRC channels](IRC) -- [How to connect Evennia to RSS feeds](RSS) -- [How to connect Evennia to Grapevine](Grapevine) -- [How to connect Evennia to Twitter](How-to-connect-Evennia-to-Twitter) - -### Administrating the running game - -- [Supported clients](Client-Support-Grid) (grid of known client issues) -- [Changing Permissions](Building-Permissions) of users -- [Banning](Banning) and deleting users - - [Summary of abuse-handling tools](Banning#summary-of-abuse-handling-tools) in the default cmdset - -### Working with Evennia - -- [Setting up your work environment with version control](Version-Control) -- [First steps coding with Evennia](First-Steps-Coding) -- [Setting up a continuous integration build environment](Continuous-Integration) diff --git a/docs/source/Builder-Docs.md b/docs/source/Builder-Docs.md deleted file mode 100644 index bc3839e0f2..0000000000 --- a/docs/source/Builder-Docs.md +++ /dev/null @@ -1,26 +0,0 @@ -# Builder Docs - -This section contains information useful to world builders. - -### Building basics - -- [Default in-game commands](Default-Command-Help) -- [Building Quick-start](Building-Quickstart) -- [Giving build permissions to others](Building-Permissions) -- [Adding text tags](TextTags) - - [Colored text](TextTags#coloured-text) - - [Clickable links](TextTags#clickable-links) - - [Inline functions](TextTags#inline-functions) -- [Customizing the connection screen](Connection-Screen) - -### Advanced building and World building - -- [Overview of batch processors](Batch-Processors) - - [Batch-command processor](Batch-Command-Processor) - - [Batch-code processor](Batch-Code-Processor) -- [Using the Spawner for individualizing objects](Spawner-and-Prototypes) -- [Adding Zones](Zones) - -### The Tutorial world - -- [Introduction and setup](Tutorial-World-Introduction) \ No newline at end of file diff --git a/docs/source/Continuous-Integration.md b/docs/source/Coding/Continuous-Integration.md similarity index 100% rename from docs/source/Continuous-Integration.md rename to docs/source/Coding/Continuous-Integration.md diff --git a/docs/source/Debugging.md b/docs/source/Coding/Debugging.md similarity index 100% rename from docs/source/Debugging.md rename to docs/source/Coding/Debugging.md diff --git a/docs/source/Directory-Overview.md b/docs/source/Coding/Directory-Overview.md similarity index 100% rename from docs/source/Directory-Overview.md rename to docs/source/Coding/Directory-Overview.md diff --git a/docs/source/Evennia-API.md b/docs/source/Coding/Evennia-API.md similarity index 100% rename from docs/source/Evennia-API.md rename to docs/source/Coding/Evennia-API.md diff --git a/docs/source/Profiling.md b/docs/source/Coding/Profiling.md similarity index 100% rename from docs/source/Profiling.md rename to docs/source/Coding/Profiling.md diff --git a/docs/source/Quirks.md b/docs/source/Coding/Quirks.md similarity index 100% rename from docs/source/Quirks.md rename to docs/source/Coding/Quirks.md diff --git a/docs/source/Setting-up-PyCharm.md b/docs/source/Coding/Setting-up-PyCharm.md similarity index 100% rename from docs/source/Setting-up-PyCharm.md rename to docs/source/Coding/Setting-up-PyCharm.md diff --git a/docs/source/Unit-Testing.md b/docs/source/Coding/Unit-Testing.md similarity index 100% rename from docs/source/Unit-Testing.md rename to docs/source/Coding/Unit-Testing.md diff --git a/docs/source/Updating-Your-Game.md b/docs/source/Coding/Updating-Your-Game.md similarity index 100% rename from docs/source/Updating-Your-Game.md rename to docs/source/Coding/Updating-Your-Game.md diff --git a/docs/source/Using-Travis.md b/docs/source/Coding/Using-Travis.md similarity index 100% rename from docs/source/Using-Travis.md rename to docs/source/Coding/Using-Travis.md diff --git a/docs/source/Version-Control.md b/docs/source/Coding/Version-Control.md similarity index 100% rename from docs/source/Version-Control.md rename to docs/source/Coding/Version-Control.md diff --git a/docs/source/Accounts.md b/docs/source/Component/Accounts.md similarity index 100% rename from docs/source/Accounts.md rename to docs/source/Component/Accounts.md diff --git a/docs/source/Attributes.md b/docs/source/Component/Attributes.md similarity index 100% rename from docs/source/Attributes.md rename to docs/source/Component/Attributes.md diff --git a/docs/source/Batch-Code-Processor.md b/docs/source/Component/Batch-Code-Processor.md similarity index 100% rename from docs/source/Batch-Code-Processor.md rename to docs/source/Component/Batch-Code-Processor.md diff --git a/docs/source/Batch-Command-Processor.md b/docs/source/Component/Batch-Command-Processor.md similarity index 100% rename from docs/source/Batch-Command-Processor.md rename to docs/source/Component/Batch-Command-Processor.md diff --git a/docs/source/Batch-Processors.md b/docs/source/Component/Batch-Processors.md similarity index 100% rename from docs/source/Batch-Processors.md rename to docs/source/Component/Batch-Processors.md diff --git a/docs/source/Bootstrap-Components-and-Utilities.md b/docs/source/Component/Bootstrap-Components-and-Utilities.md similarity index 100% rename from docs/source/Bootstrap-Components-and-Utilities.md rename to docs/source/Component/Bootstrap-Components-and-Utilities.md diff --git a/docs/source/Coding-Utils.md b/docs/source/Component/Coding-Utils.md similarity index 100% rename from docs/source/Coding-Utils.md rename to docs/source/Component/Coding-Utils.md diff --git a/docs/source/Command-Sets.md b/docs/source/Component/Command-Sets.md similarity index 100% rename from docs/source/Command-Sets.md rename to docs/source/Component/Command-Sets.md diff --git a/docs/source/Commands.md b/docs/source/Component/Commands.md similarity index 100% rename from docs/source/Commands.md rename to docs/source/Component/Commands.md diff --git a/docs/source/Communications.md b/docs/source/Component/Communications.md similarity index 100% rename from docs/source/Communications.md rename to docs/source/Component/Communications.md diff --git a/docs/source/Connection-Screen.md b/docs/source/Component/Connection-Screen.md similarity index 100% rename from docs/source/Connection-Screen.md rename to docs/source/Component/Connection-Screen.md diff --git a/docs/source/Default-Command-Help.md b/docs/source/Component/Default-Command-Help.md similarity index 100% rename from docs/source/Default-Command-Help.md rename to docs/source/Component/Default-Command-Help.md diff --git a/docs/source/EvEditor.md b/docs/source/Component/EvEditor.md similarity index 100% rename from docs/source/EvEditor.md rename to docs/source/Component/EvEditor.md diff --git a/docs/source/EvMenu.md b/docs/source/Component/EvMenu.md similarity index 100% rename from docs/source/EvMenu.md rename to docs/source/Component/EvMenu.md diff --git a/docs/source/EvMore.md b/docs/source/Component/EvMore.md similarity index 100% rename from docs/source/EvMore.md rename to docs/source/Component/EvMore.md diff --git a/docs/source/Help-System.md b/docs/source/Component/Help-System.md similarity index 100% rename from docs/source/Help-System.md rename to docs/source/Component/Help-System.md diff --git a/docs/source/Inputfuncs.md b/docs/source/Component/Inputfuncs.md similarity index 100% rename from docs/source/Inputfuncs.md rename to docs/source/Component/Inputfuncs.md diff --git a/docs/source/Locks.md b/docs/source/Component/Locks.md similarity index 100% rename from docs/source/Locks.md rename to docs/source/Component/Locks.md diff --git a/docs/source/MonitorHandler.md b/docs/source/Component/MonitorHandler.md similarity index 100% rename from docs/source/MonitorHandler.md rename to docs/source/Component/MonitorHandler.md diff --git a/docs/source/Nicks.md b/docs/source/Component/Nicks.md similarity index 100% rename from docs/source/Nicks.md rename to docs/source/Component/Nicks.md diff --git a/docs/source/Objects.md b/docs/source/Component/Objects.md similarity index 100% rename from docs/source/Objects.md rename to docs/source/Component/Objects.md diff --git a/docs/source/Portal-And-Server.md b/docs/source/Component/Portal-And-Server.md similarity index 100% rename from docs/source/Portal-And-Server.md rename to docs/source/Component/Portal-And-Server.md diff --git a/docs/source/Scripts.md b/docs/source/Component/Scripts.md similarity index 100% rename from docs/source/Scripts.md rename to docs/source/Component/Scripts.md diff --git a/docs/source/Server-Conf.md b/docs/source/Component/Server-Conf.md similarity index 100% rename from docs/source/Server-Conf.md rename to docs/source/Component/Server-Conf.md diff --git a/docs/source/Sessions.md b/docs/source/Component/Sessions.md similarity index 100% rename from docs/source/Sessions.md rename to docs/source/Component/Sessions.md diff --git a/docs/source/Signals.md b/docs/source/Component/Signals.md similarity index 100% rename from docs/source/Signals.md rename to docs/source/Component/Signals.md diff --git a/docs/source/Spawner-and-Prototypes.md b/docs/source/Component/Spawner-and-Prototypes.md similarity index 100% rename from docs/source/Spawner-and-Prototypes.md rename to docs/source/Component/Spawner-and-Prototypes.md diff --git a/docs/source/Tags.md b/docs/source/Component/Tags.md similarity index 100% rename from docs/source/Tags.md rename to docs/source/Component/Tags.md diff --git a/docs/source/TickerHandler.md b/docs/source/Component/TickerHandler.md similarity index 100% rename from docs/source/TickerHandler.md rename to docs/source/Component/TickerHandler.md diff --git a/docs/source/Typeclasses.md b/docs/source/Component/Typeclasses.md similarity index 100% rename from docs/source/Typeclasses.md rename to docs/source/Component/Typeclasses.md diff --git a/docs/source/Webclient.md b/docs/source/Component/Webclient.md similarity index 100% rename from docs/source/Webclient.md rename to docs/source/Component/Webclient.md diff --git a/docs/source/Async-Process.md b/docs/source/Concept/Async-Process.md similarity index 100% rename from docs/source/Async-Process.md rename to docs/source/Concept/Async-Process.md diff --git a/docs/source/Banning.md b/docs/source/Concept/Banning.md similarity index 100% rename from docs/source/Banning.md rename to docs/source/Concept/Banning.md diff --git a/docs/source/Bootstrap-&-Evennia.md b/docs/source/Concept/Bootstrap-&-Evennia.md similarity index 100% rename from docs/source/Bootstrap-&-Evennia.md rename to docs/source/Concept/Bootstrap-&-Evennia.md diff --git a/docs/source/Building-Permissions.md b/docs/source/Concept/Building-Permissions.md similarity index 100% rename from docs/source/Building-Permissions.md rename to docs/source/Concept/Building-Permissions.md diff --git a/docs/source/Command-System.md b/docs/source/Concept/Command-System.md similarity index 100% rename from docs/source/Command-System.md rename to docs/source/Concept/Command-System.md diff --git a/docs/source/Custom-Protocols.md b/docs/source/Concept/Custom-Protocols.md similarity index 100% rename from docs/source/Custom-Protocols.md rename to docs/source/Concept/Custom-Protocols.md diff --git a/docs/source/Guest-Logins.md b/docs/source/Concept/Guest-Logins.md similarity index 100% rename from docs/source/Guest-Logins.md rename to docs/source/Concept/Guest-Logins.md diff --git a/docs/source/Internationalization.md b/docs/source/Concept/Internationalization.md similarity index 100% rename from docs/source/Internationalization.md rename to docs/source/Concept/Internationalization.md diff --git a/docs/source/Messagepath.md b/docs/source/Concept/Messagepath.md similarity index 100% rename from docs/source/Messagepath.md rename to docs/source/Concept/Messagepath.md diff --git a/docs/source/New-Models.md b/docs/source/Concept/New-Models.md similarity index 100% rename from docs/source/New-Models.md rename to docs/source/Concept/New-Models.md diff --git a/docs/source/OOB.md b/docs/source/Concept/OOB.md similarity index 100% rename from docs/source/OOB.md rename to docs/source/Concept/OOB.md diff --git a/docs/source/Soft-Code.md b/docs/source/Concept/Soft-Code.md similarity index 100% rename from docs/source/Soft-Code.md rename to docs/source/Concept/Soft-Code.md diff --git a/docs/source/Text-Encodings.md b/docs/source/Concept/Text-Encodings.md similarity index 100% rename from docs/source/Text-Encodings.md rename to docs/source/Concept/Text-Encodings.md diff --git a/docs/source/TextTags.md b/docs/source/Concept/TextTags.md similarity index 100% rename from docs/source/TextTags.md rename to docs/source/Concept/TextTags.md diff --git a/docs/source/Using-MUX-as-a-Standard.md b/docs/source/Concept/Using-MUX-as-a-Standard.md similarity index 100% rename from docs/source/Using-MUX-as-a-Standard.md rename to docs/source/Concept/Using-MUX-as-a-Standard.md diff --git a/docs/source/Web-Features.md b/docs/source/Concept/Web-Features.md similarity index 100% rename from docs/source/Web-Features.md rename to docs/source/Concept/Web-Features.md diff --git a/docs/source/Zones.md b/docs/source/Concept/Zones.md similarity index 100% rename from docs/source/Zones.md rename to docs/source/Concept/Zones.md diff --git a/docs/source/A-voice-operated-elevator-using-events.md b/docs/source/Contrib/A-voice-operated-elevator-using-events.md similarity index 100% rename from docs/source/A-voice-operated-elevator-using-events.md rename to docs/source/Contrib/A-voice-operated-elevator-using-events.md diff --git a/docs/source/Building-menus.md b/docs/source/Contrib/Building-menus.md similarity index 100% rename from docs/source/Building-menus.md rename to docs/source/Contrib/Building-menus.md diff --git a/docs/source/Dialogues-in-events.md b/docs/source/Contrib/Dialogues-in-events.md similarity index 100% rename from docs/source/Dialogues-in-events.md rename to docs/source/Contrib/Dialogues-in-events.md diff --git a/docs/source/Dynamic-In-Game-Map.md b/docs/source/Contrib/Dynamic-In-Game-Map.md similarity index 100% rename from docs/source/Dynamic-In-Game-Map.md rename to docs/source/Contrib/Dynamic-In-Game-Map.md diff --git a/docs/source/Static-In-Game-Map.md b/docs/source/Contrib/Static-In-Game-Map.md similarity index 100% rename from docs/source/Static-In-Game-Map.md rename to docs/source/Contrib/Static-In-Game-Map.md diff --git a/docs/source/Tutorial-World-Introduction.md b/docs/source/Contrib/Tutorial-World-Introduction.md similarity index 100% rename from docs/source/Tutorial-World-Introduction.md rename to docs/source/Contrib/Tutorial-World-Introduction.md diff --git a/docs/source/Contributing-Docs.md b/docs/source/Contributing-Docs.md index 078d8bdb6b..75cfe48e7c 100644 --- a/docs/source/Contributing-Docs.md +++ b/docs/source/Contributing-Docs.md @@ -14,9 +14,40 @@ Markdown files are simple text files that can be edited with a normal text edito contain raw HTML directives (but that is very rarely needed). They primarly use the [Markdown][commonmark] syntax. See [the syntax section below](#Editing-syntax) for more help. -> Note: Don't edit the files in `evennia/docs/source/api/`. These are auto-generated and your -changes -> will be lost. +## Source file structure + +The sources are organized into several rough categories, with only a few administrative documents +at the root of `evennia/docs/source/`. The folders are named in singular form since they will +primarily be accessed as link refs (e.g. `Component/Account`) + +- `source/Components/` are docs describing separate Evennia building blocks, that is, things + that you can import and use. This extends and elaborates on what can be found out by reading + the api docs themselves. Example are documentation for `Accounts`, `Objects` and `Commands`. +- `source/Concepts/` describes how larger-scale features of Evennia hang together - things that + can't easily be broken down into one isolated component. This can be general descriptions of + how Models and Typeclasses interact to the path a message takes from the client to the server + and back. +- `source/Setup/` holds detailed docs on installing, running and maintaining the Evennia server and + the infrastructure around it. +- `source/Coding/` has help on how to interact with, use and navigate the Evennia codebase itself. + This also has non-Evennia-specific help on general development concepts and how to set up a sane + development environment. +- `source/Contribs/` holds documentation specifically for packages in the `evennia/contribs/` folder. + Any contrib-specific tutorials will be found here instead of in `Howtos` +- `source/Howtos/` holds docs that describe how to achieve a specific goal, effect or + result in Evennia. This is often on a tutorial or FAQ form and will refer to the rest of the + documentation for further reading. + - `source/Howtos/StartingTutorial/` holds all documents part of the initial tutorial sequence. + + + Other files and folders: + - `source/api/` contains the auto-generated API documentation as `.rst` files. Don't edit these + files manually, your changes will be lost. + - `source/_templates` and `source/_static` should not be modified unless adding a new doc-page + feature or changing the look of the HTML documentation. + - `conf.py` holds the Sphinx configuration. It should usually not be modified except to update + the Evennia version on a new branch. + ## Building the docs locally diff --git a/docs/source/Developer-Central.md b/docs/source/Developer-Central.md deleted file mode 100644 index a6d3e5a757..0000000000 --- a/docs/source/Developer-Central.md +++ /dev/null @@ -1,108 +0,0 @@ -# Developer Central - - -This page serves as a central nexus for information on using Evennia as well as developing the -library itself. - -### General Evennia development information - -- [Introduction to coding with Evennia](Coding-Introduction) -- [Evennia Licensing FAQ](Licensing) -- [Contributing to Evennia](Contributing) -- [Code Style Guide](https://github.com/evennia/evennia/blob/master/CODING_STYLE.md) (Important!) -- [Policy for 'MUX-like' default commands](Using-MUX-as-a-Standard) -- [Setting up a Git environment for coding](Version-Control) -- [Getting started with Travis and Github for continuous integration testing](Using-Travis) -- [Planning your own Evennia game](Game-Planning) -- [First steps coding Evennia](First-Steps-Coding) -- [Translating Evennia](Internationalization#translating-evennia) -- [Evennia Quirks](Quirks) to keep in mind. -- [Directions for configuring PyCharm with Evennia on Windows](Setting-up-PyCharm) - -### Evennia API - -- [Directory Overview](Directory-Overview) -- [evennia - the flat API](Evennia-API) - - [Running and Testing Python code](Execute-Python-Code) - -#### Core components and protocols - -- [Server and Portal](Portal-And-Server) - - [Sessions](Sessions) - - [Configuration and module plugins](Server-Conf) -- [The message path](Messagepath) - - [OOB](OOB) - Out-of-band communication - - [Inputfuncs](Inputfuncs) - - [Adding new protocols (client APIs) and services](Custom-Protocols) -- [Adding new database models](New-Models) -- [Running and writing unit tests](Unit-Testing) -- [Running profiling](Profiling) -- [Debugging your code](Debugging) - -#### In-game Commands - -- [Command System overview](Command-System) -- [Commands](Commands) -- [Command Sets](Command-Sets) -- [Command Auto-help](Help-System#command-auto-help-system) - -#### Typeclasses and related concepts - -- [General about Typeclasses](Typeclasses) -- [Objects](Objects) - - [Characters](Objects#characters) - - [Rooms](Objects#rooms) - - [Exits](Objects#exits) -- [Accounts](Accounts) -- [Communications](Communications) - - [Channels](Communications#channels) -- [Scripts](Scripts) - - [Global Scripts](Scripts#Global-Scripts) - - [TickerHandler](TickerHandler) - - [utils.delay](Coding-Utils#utilsdelay) - - [MonitorHandler](MonitorHandler) -- [Attributes](Attributes) -- [Nicks](Nicks) -- [Tags](Tags) - - [Tags for Aliases and Permissions](Tags#using-aliases-and-permissions) - -#### Web - -- [Web features overview](Web-Features) -- [The Webclient](Webclient) -- [Web tutorials](Web-Tutorial) - -#### Other systems - -- [Locks](Locks) - - [Permissions](Locks#permissions) -- [Help System](Help-System) -- [Signals](Signals) -- [General coding utilities](Coding-Utils) - - [Utils in evennia.utils.utils](api:evennia.utils.utils) -- [Game time](Coding-Utils#game-time) -- [Game Menus](EvMenu) (EvMenu) -- [Text paging/scrolling](EvMore) (EvMore) -- [Text Line Editor](EvEditor) (EvEditor) -- [Text Tables](github:evennia.utils.evtable) (EvTable) -- [Text Form generation](github:evennia.utils.evform) (EvForm) -- [Spawner and Prototypes](Spawner-and-Prototypes) -- [Inlinefuncs](TextTags#inline-functions) -- [Asynchronous execution](Async-Process) - -### Developer brainstorms and whitepages - -- [API refactoring](API-refactoring), discussing what parts of the Evennia API needs a -refactoring/cleanup/simplification -- [Docs refactoring](Docs-refactoring), discussing how to reorganize and structure this wiki/docs -better going forward -- [Webclient brainstorm](Webclient-brainstorm), some ideas for a future webclient gui -- [Roadmap](Roadmap), a tentative list of future major features -- [Change log](https://github.com/evennia/evennia/blob/master/CHANGELOG.md) of big Evennia updates -over time - - -[group]: https://groups.google.com/forum/#!forum/evennia -[online-form]: -https://docs.google.com/spreadsheet/viewform?hl=en_US&formkey=dGN0VlJXMWpCT3VHaHpscDEzY1RoZGc6MQ#gid=0 -[issues]: https://github.com/evennia/evennia/issues \ No newline at end of file diff --git a/docs/source/Docs-refactoring.md b/docs/source/Docs-refactoring.md deleted file mode 100644 index 55dc6cc500..0000000000 --- a/docs/source/Docs-refactoring.md +++ /dev/null @@ -1,117 +0,0 @@ -# Docs refactoring - -This is a whitepage for free discussion about the wiki docs and refactorings needed. - -Note that this is not a forum. To keep things clean, each opinion text should ideally present a -clear argument or lay out a suggestion. Asking for clarification and any side-discussions should be -held in chat or forum. - -### Griatch (Aug 13, 2019) - -This is how to make a discussion entry for the whitepage. Use any markdown formatting you need. Also -remember to copy your work to the clipboard before saving the page since if someone else edited the -page since you started, you'll have to reload and write again. - -#### (Sept 23, 2019) - -[This (now closed) issue by DamnedScholar](https://github.com/evennia/evennia/issues/1431) gives the -following suggestion: -> I think it would be useful for the pages that explain how to use various features of Evennia to -have explicit and easily visible links to the respective API entry or entries. Some pages do, but -not all. I imagine this as a single entry at the top of the page [...]. - -[This (now closed) issue by taladan](https://github.com/evennia/evennia/issues/1578) gives the -following suggestion: -> It would help me (and probably a couple of others) if there is a way to show the file path where a -particular thing exists. Maybe up under the 'last edited' line we could have a line like: -evennia/locks/lockhandler.py - -This would help in development to quickly refer to where a resource is located. - - -### Kovitikus (Sept. 11, 2019) - -[Batch Code](Batch-Code-Processor) should have a link in the developer area. It is currently only -listed in the tutorials section as an afterthought to a tutorial title. - -*** - -In regards to the general structure of each wiki page: I'd like to see a table of contents at the -top of each one, so that it can be quickly navigated and is immediately apparent what sections are -covered on the page. Similar to the current [Getting Started](Getting-Started) page. - -*** - -The structuring of the page should also include a quick reference cheatsheet for certain aspects. -Such as [Tags](Tags) including a quick reference section at the top that lists an example of every -available method you can use in a clear and consistent format, along with a comment. Readers -shouldn't have to decipher the article to gather such basic information and it should instead be -available at first glance. - -Example of a quick reference: - -**Tags** -``` -# Add a tag. -obj.tags.add("label") - -# Remove a tag. -obj.tags.remove("label") - -# Remove all tags. -obj.tags.clear() - -# Search for a tag. Evennia must be imported first. -store_result = evennia.search_tag("label") - -# Return a list of all tags. -obj.tags.all() -``` - -**Aliases** -``` -# Add an alias. -obj.aliases.add("label") - -ETC... -``` - -*** - -In regards to comment structure, I often find that smushing together lines with comments to be too -obscure. White space should be used to clearly delineate what information the comment is for. I -understand that the current format is that a comment references whatever is below it, but newbies -may not know that until they realize it. - -Example of poor formatting: -``` -#comment -command/code -#comment -command/code -``` - -Example of good formatting: -``` -# Comment. -command/code - -# Comment. -command/code -``` - -### Sage (3/28/20) - -If I want to find information on the correct syntax for is_typeclass(), here's what I do: -* Pop over to the wiki. Okay, this is a developer functionality. Let's try that. -* Ctrl+F on Developer page. No results. -* Ctrl+F on API page. No results. Ctrl+F on Flat API page. No results -* Ctrl+F on utils page. No results. -* Ctrl+F on utils.utils page. No results. -* Ctrl+F in my IDE. Results. -* Fortunately, there's only one result for def is_typeclass. If this was at_look, there would be -several results, and I'd have to go through each of those individually, and most of them would just -call return_appearance - -An important part of a refactor, in my opinion, is separating out the "Tutorials" from the -"Reference" documentation. \ No newline at end of file diff --git a/docs/source/Add-a-wiki-on-your-website.md b/docs/source/Howto/Add-a-wiki-on-your-website.md similarity index 100% rename from docs/source/Add-a-wiki-on-your-website.md rename to docs/source/Howto/Add-a-wiki-on-your-website.md diff --git a/docs/source/Building-a-mech-tutorial.md b/docs/source/Howto/Building-a-mech-tutorial.md similarity index 100% rename from docs/source/Building-a-mech-tutorial.md rename to docs/source/Howto/Building-a-mech-tutorial.md diff --git a/docs/source/Coding-FAQ.md b/docs/source/Howto/Coding-FAQ.md similarity index 100% rename from docs/source/Coding-FAQ.md rename to docs/source/Howto/Coding-FAQ.md diff --git a/docs/source/Command-Cooldown.md b/docs/source/Howto/Command-Cooldown.md similarity index 100% rename from docs/source/Command-Cooldown.md rename to docs/source/Howto/Command-Cooldown.md diff --git a/docs/source/Command-Duration.md b/docs/source/Howto/Command-Duration.md similarity index 100% rename from docs/source/Command-Duration.md rename to docs/source/Howto/Command-Duration.md diff --git a/docs/source/Command-Prompt.md b/docs/source/Howto/Command-Prompt.md similarity index 100% rename from docs/source/Command-Prompt.md rename to docs/source/Howto/Command-Prompt.md diff --git a/docs/source/Coordinates.md b/docs/source/Howto/Coordinates.md similarity index 100% rename from docs/source/Coordinates.md rename to docs/source/Howto/Coordinates.md diff --git a/docs/source/Customize-channels.md b/docs/source/Howto/Customize-channels.md similarity index 100% rename from docs/source/Customize-channels.md rename to docs/source/Howto/Customize-channels.md diff --git a/docs/source/Default-Exit-Errors.md b/docs/source/Howto/Default-Exit-Errors.md similarity index 100% rename from docs/source/Default-Exit-Errors.md rename to docs/source/Howto/Default-Exit-Errors.md diff --git a/docs/source/Evennia-for-Diku-Users.md b/docs/source/Howto/Evennia-for-Diku-Users.md similarity index 100% rename from docs/source/Evennia-for-Diku-Users.md rename to docs/source/Howto/Evennia-for-Diku-Users.md diff --git a/docs/source/Evennia-for-MUSH-Users.md b/docs/source/Howto/Evennia-for-MUSH-Users.md similarity index 100% rename from docs/source/Evennia-for-MUSH-Users.md rename to docs/source/Howto/Evennia-for-MUSH-Users.md diff --git a/docs/source/Evennia-for-roleplaying-sessions.md b/docs/source/Howto/Evennia-for-roleplaying-sessions.md similarity index 100% rename from docs/source/Evennia-for-roleplaying-sessions.md rename to docs/source/Howto/Evennia-for-roleplaying-sessions.md diff --git a/docs/source/Game-Planning.md b/docs/source/Howto/Game-Planning.md similarity index 100% rename from docs/source/Game-Planning.md rename to docs/source/Howto/Game-Planning.md diff --git a/docs/source/Gametime-Tutorial.md b/docs/source/Howto/Gametime-Tutorial.md similarity index 100% rename from docs/source/Gametime-Tutorial.md rename to docs/source/Howto/Gametime-Tutorial.md diff --git a/docs/source/Help-System-Tutorial.md b/docs/source/Howto/Help-System-Tutorial.md similarity index 100% rename from docs/source/Help-System-Tutorial.md rename to docs/source/Howto/Help-System-Tutorial.md diff --git a/docs/source/Implementing-a-game-rule-system.md b/docs/source/Howto/Implementing-a-game-rule-system.md similarity index 100% rename from docs/source/Implementing-a-game-rule-system.md rename to docs/source/Howto/Implementing-a-game-rule-system.md diff --git a/docs/source/Learn-Python-for-Evennia-The-Hard-Way.md b/docs/source/Howto/Learn-Python-for-Evennia-The-Hard-Way.md similarity index 100% rename from docs/source/Learn-Python-for-Evennia-The-Hard-Way.md rename to docs/source/Howto/Learn-Python-for-Evennia-The-Hard-Way.md diff --git a/docs/source/Manually-Configuring-Color.md b/docs/source/Howto/Manually-Configuring-Color.md similarity index 100% rename from docs/source/Manually-Configuring-Color.md rename to docs/source/Howto/Manually-Configuring-Color.md diff --git a/docs/source/Mass-and-weight-for-objects.md b/docs/source/Howto/Mass-and-weight-for-objects.md similarity index 100% rename from docs/source/Mass-and-weight-for-objects.md rename to docs/source/Howto/Mass-and-weight-for-objects.md diff --git a/docs/source/NPC-shop-Tutorial.md b/docs/source/Howto/NPC-shop-Tutorial.md similarity index 100% rename from docs/source/NPC-shop-Tutorial.md rename to docs/source/Howto/NPC-shop-Tutorial.md diff --git a/docs/source/Add-a-simple-new-web-page.md b/docs/source/Howto/StartingTutorial/Add-a-simple-new-web-page.md similarity index 100% rename from docs/source/Add-a-simple-new-web-page.md rename to docs/source/Howto/StartingTutorial/Add-a-simple-new-web-page.md diff --git a/docs/source/Adding-Command-Tutorial.md b/docs/source/Howto/StartingTutorial/Adding-Command-Tutorial.md similarity index 100% rename from docs/source/Adding-Command-Tutorial.md rename to docs/source/Howto/StartingTutorial/Adding-Command-Tutorial.md diff --git a/docs/source/Adding-Object-Typeclass-Tutorial.md b/docs/source/Howto/StartingTutorial/Adding-Object-Typeclass-Tutorial.md similarity index 100% rename from docs/source/Adding-Object-Typeclass-Tutorial.md rename to docs/source/Howto/StartingTutorial/Adding-Object-Typeclass-Tutorial.md diff --git a/docs/source/Building-Quickstart.md b/docs/source/Howto/StartingTutorial/Building-Quickstart.md similarity index 100% rename from docs/source/Building-Quickstart.md rename to docs/source/Howto/StartingTutorial/Building-Quickstart.md diff --git a/docs/source/Coding-Introduction.md b/docs/source/Howto/StartingTutorial/Coding-Introduction.md similarity index 100% rename from docs/source/Coding-Introduction.md rename to docs/source/Howto/StartingTutorial/Coding-Introduction.md diff --git a/docs/source/Execute-Python-Code.md b/docs/source/Howto/StartingTutorial/Execute-Python-Code.md similarity index 100% rename from docs/source/Execute-Python-Code.md rename to docs/source/Howto/StartingTutorial/Execute-Python-Code.md diff --git a/docs/source/First-Steps-Coding.md b/docs/source/Howto/StartingTutorial/First-Steps-Coding.md similarity index 100% rename from docs/source/First-Steps-Coding.md rename to docs/source/Howto/StartingTutorial/First-Steps-Coding.md diff --git a/docs/source/Parsing-command-arguments,-theory-and-best-practices.md b/docs/source/Howto/StartingTutorial/Parsing-command-arguments,-theory-and-best-practices.md similarity index 100% rename from docs/source/Parsing-command-arguments,-theory-and-best-practices.md rename to docs/source/Howto/StartingTutorial/Parsing-command-arguments,-theory-and-best-practices.md diff --git a/docs/source/Python-basic-introduction.md b/docs/source/Howto/StartingTutorial/Python-basic-introduction.md similarity index 100% rename from docs/source/Python-basic-introduction.md rename to docs/source/Howto/StartingTutorial/Python-basic-introduction.md diff --git a/docs/source/Python-basic-tutorial-part-two.md b/docs/source/Howto/StartingTutorial/Python-basic-tutorial-part-two.md similarity index 100% rename from docs/source/Python-basic-tutorial-part-two.md rename to docs/source/Howto/StartingTutorial/Python-basic-tutorial-part-two.md diff --git a/docs/source/Turn-based-Combat-System.md b/docs/source/Howto/StartingTutorial/Turn-based-Combat-System.md similarity index 100% rename from docs/source/Turn-based-Combat-System.md rename to docs/source/Howto/StartingTutorial/Turn-based-Combat-System.md diff --git a/docs/source/Tutorial-Searching-For-Objects.md b/docs/source/Howto/StartingTutorial/Tutorial-Searching-For-Objects.md similarity index 100% rename from docs/source/Tutorial-Searching-For-Objects.md rename to docs/source/Howto/StartingTutorial/Tutorial-Searching-For-Objects.md diff --git a/docs/source/Tutorial-for-basic-MUSH-like-game.md b/docs/source/Howto/StartingTutorial/Tutorial-for-basic-MUSH-like-game.md similarity index 100% rename from docs/source/Tutorial-for-basic-MUSH-like-game.md rename to docs/source/Howto/StartingTutorial/Tutorial-for-basic-MUSH-like-game.md diff --git a/docs/source/Web-Tutorial.md b/docs/source/Howto/StartingTutorial/Web-Tutorial.md similarity index 100% rename from docs/source/Web-Tutorial.md rename to docs/source/Howto/StartingTutorial/Web-Tutorial.md diff --git a/docs/source/Tutorial-Aggressive-NPCs.md b/docs/source/Howto/Tutorial-Aggressive-NPCs.md similarity index 100% rename from docs/source/Tutorial-Aggressive-NPCs.md rename to docs/source/Howto/Tutorial-Aggressive-NPCs.md diff --git a/docs/source/Tutorial-NPCs-listening.md b/docs/source/Howto/Tutorial-NPCs-listening.md similarity index 100% rename from docs/source/Tutorial-NPCs-listening.md rename to docs/source/Howto/Tutorial-NPCs-listening.md diff --git a/docs/source/Tutorial-Tweeting-Game-Stats.md b/docs/source/Howto/Tutorial-Tweeting-Game-Stats.md similarity index 100% rename from docs/source/Tutorial-Tweeting-Game-Stats.md rename to docs/source/Howto/Tutorial-Tweeting-Game-Stats.md diff --git a/docs/source/Tutorial-Vehicles.md b/docs/source/Howto/Tutorial-Vehicles.md similarity index 100% rename from docs/source/Tutorial-Vehicles.md rename to docs/source/Howto/Tutorial-Vehicles.md diff --git a/docs/source/Understanding-Color-Tags.md b/docs/source/Howto/Understanding-Color-Tags.md similarity index 100% rename from docs/source/Understanding-Color-Tags.md rename to docs/source/Howto/Understanding-Color-Tags.md diff --git a/docs/source/Weather-Tutorial.md b/docs/source/Howto/Weather-Tutorial.md similarity index 100% rename from docs/source/Weather-Tutorial.md rename to docs/source/Howto/Weather-Tutorial.md diff --git a/docs/source/Web-Character-Generation.md b/docs/source/Howto/Web-Character-Generation.md similarity index 100% rename from docs/source/Web-Character-Generation.md rename to docs/source/Howto/Web-Character-Generation.md diff --git a/docs/source/Web-Character-View-Tutorial.md b/docs/source/Howto/Web-Character-View-Tutorial.md similarity index 100% rename from docs/source/Web-Character-View-Tutorial.md rename to docs/source/Howto/Web-Character-View-Tutorial.md diff --git a/docs/source/Python-3.md b/docs/source/Python-3.md deleted file mode 100644 index 3a8731c459..0000000000 --- a/docs/source/Python-3.md +++ /dev/null @@ -1,87 +0,0 @@ -# Python 3 - -> *Note: Evennia only supports Python 2.7+ at this time. This page gathers various development -information relevant to server developers.* - -Django can work with Python 2 and 3 already, though changes may be required to how the Evennia code -uses it. Twisted has much Python 3 compatibility, but not all modules within it have been ported -yet. The -[twisted.python.dist3](https://twistedmatrix.com/documents/current/api/twisted.python.dist3.html) -module gives some information about what's ported, and I'm compiling a list of missing modules with -related bug reports which can be found below. The list is based on a search for import statements in -the Evennia source code, please add anything that's missing. - -Part of this process is expected to be writing more tests for Evennia. One encouraging recent port -to Python 3 in Twisted is its Trial test framework, which may need to be used by Evennia to ensure -it still works correctly with Twisted on Python 3. - -# "Strings" -Broadly (and perhaps over-simplified): - -* Twisted [expects -bytes](http://twistedmatrix.com/trac/wiki/FrequentlyAskedQuestions#WhydontTwistedsnetworkmethodssupportUnicodeobjectsaswellasstrings) -* Django [expects "" to be unicode](https://docs.djangoproject.com/en/1.8/topics/python3/#unicode- -literals) - -I think we should use (roughly speaking) "" for unicode and b"" for bytes everywhere, but I need to -look at the impacts of this more closely. - -# Links - -* http://twistedmatrix.com/documents/current/core/howto/python3.html -* https://twistedmatrix.com/trac/wiki/Plan/Python3 -* [Twisted Python3 -bugs](https://twistedmatrix.com/trac/query?status=assigned&status=new&status=reopened&group=status&milestone=Python-3.x) - -# Twisted module status - -x = not ported to Python 3 -/ = ported to Python 3 - -* twisted.application.internet / -* twisted.application.service / -* twisted.conch x (not used directly) - * ~https://twistedmatrix.com/trac/ticket/5102~ / - * ~https://twistedmatrix.com/trac/ticket/4993~ / -* twisted.conch.insults.insults x -* twisted.conch.interfaces x -* twisted.conch.manhole x -* twisted.conch.manhole_ssh x -* twisted.conch.ssh.common x -* twisted.conch.ssh.keys x - * ~https://twistedmatrix.com/trac/ticket/7998~ / - * "twisted.conch.ssh.keys should be ported to Python 3" -* twisted.conch.ssh.userauth x -* twisted.conch.telnet x -* twisted.cred.checkers / -* twisted.cred.portal / -* twisted.internet.defer / -* twisted.internet.interfaces / -* twisted.internet.protocol / -* twisted.internet.reactor / -* twisted.internet.ssl / -* twisted.internet.task / -* twisted.internet.threads / -* twisted.protocols.amp x - * ~https://twistedmatrix.com/trac/ticket/6833~ / - * "Port twisted.protocols.amp to Python 3" -* twisted.protocols.policies / -* twisted.python.components / -* twisted.python.log / -* twisted.python.threadpool / -* twisted.web.http (x) - * Partial support. Sufficient? -* twisted.web.resource / -* twisted.web.server (x) - * Partial support. Sufficient? -* twisted.web.static / -* twisted.web.proxy / -* twisted.web.wsgi x - * ~https://twistedmatrix.com/trac/ticket/7993~ / - * "'twisted.web.wsgi' should be ported to Python 3" - * Seems to be making good progress -* twisted.words.protocols.irc x - * https://twistedmatrix.com/trac/ticket/6320 - * "Python 3 support for twisted.words.protocols.irc" - * ~https://twistedmatrix.com/trac/ticket/6564~ - * "Replace usage of builtin reduce in twisted.words" \ No newline at end of file diff --git a/docs/source/Roadmap.md b/docs/source/Roadmap.md deleted file mode 100644 index 5dde75a599..0000000000 --- a/docs/source/Roadmap.md +++ /dev/null @@ -1,5 +0,0 @@ -# Roadmap - - -*As of Autumn 2016, Evennia's development roadmap is tracked through the [Evennia Projects -Page](https://github.com/evennia/evennia/projects).* \ No newline at end of file diff --git a/docs/source/Screenshot.md b/docs/source/Screenshot.md deleted file mode 100644 index dfe4de763b..0000000000 --- a/docs/source/Screenshot.md +++ /dev/null @@ -1,20 +0,0 @@ -# Screenshot - - -![evennia_screenshot2017](https://user- -images.githubusercontent.com/294267/30773728-ea45afb6-a076-11e7-8820-49be2168a6b8.png) -*(right-click and choose your browser's equivalent of "view image" to see it full size)* - -This screenshot shows a vanilla [install](Getting-Started) of the just started Evennia MUD server. -In the bottom window we can see the log messages from the running server. - -In the top left window we see the default website of our new game displayed in a web browser (it has -shrunk to accomodate the smaller screen). Evennia contains its own webserver to serve this page. The -default site shows some brief info about the database. From here you can also reach Django's *admin -interface* for editing the database online. - -To the upper right is the included web-browser client showing a connection to the server on port -4001. This allows users to access the game without downloading a mud client separately. - -Bottom right we see a login into the stock game using a third-party MUD client -([Mudlet](http://www.mudlet.org)). This connects to the server via the telnet protocol on port 4000. \ No newline at end of file diff --git a/docs/source/Apache-Config.md b/docs/source/Setup/Apache-Config.md similarity index 100% rename from docs/source/Apache-Config.md rename to docs/source/Setup/Apache-Config.md diff --git a/docs/source/Arxcode-installing-help.md b/docs/source/Setup/Arxcode-installing-help.md similarity index 100% rename from docs/source/Arxcode-installing-help.md rename to docs/source/Setup/Arxcode-installing-help.md diff --git a/docs/source/Choosing-An-SQL-Server.md b/docs/source/Setup/Choosing-An-SQL-Server.md similarity index 100% rename from docs/source/Choosing-An-SQL-Server.md rename to docs/source/Setup/Choosing-An-SQL-Server.md diff --git a/docs/source/Client-Support-Grid.md b/docs/source/Setup/Client-Support-Grid.md similarity index 100% rename from docs/source/Client-Support-Grid.md rename to docs/source/Setup/Client-Support-Grid.md diff --git a/docs/source/Evennia-Game-Index.md b/docs/source/Setup/Evennia-Game-Index.md similarity index 100% rename from docs/source/Evennia-Game-Index.md rename to docs/source/Setup/Evennia-Game-Index.md diff --git a/docs/source/Getting-Started.md b/docs/source/Setup/Getting-Started.md similarity index 100% rename from docs/source/Getting-Started.md rename to docs/source/Setup/Getting-Started.md diff --git a/docs/source/Grapevine.md b/docs/source/Setup/Grapevine.md similarity index 100% rename from docs/source/Grapevine.md rename to docs/source/Setup/Grapevine.md diff --git a/docs/source/HAProxy-Config-(Optional).md b/docs/source/Setup/HAProxy-Config-(Optional).md similarity index 100% rename from docs/source/HAProxy-Config-(Optional).md rename to docs/source/Setup/HAProxy-Config-(Optional).md diff --git a/docs/source/How-to-connect-Evennia-to-Twitter.md b/docs/source/Setup/How-to-connect-Evennia-to-Twitter.md similarity index 100% rename from docs/source/How-to-connect-Evennia-to-Twitter.md rename to docs/source/Setup/How-to-connect-Evennia-to-Twitter.md diff --git a/docs/source/IRC.md b/docs/source/Setup/IRC.md similarity index 100% rename from docs/source/IRC.md rename to docs/source/Setup/IRC.md diff --git a/docs/source/Installing-on-Android.md b/docs/source/Setup/Installing-on-Android.md similarity index 100% rename from docs/source/Installing-on-Android.md rename to docs/source/Setup/Installing-on-Android.md diff --git a/docs/source/Online-Setup.md b/docs/source/Setup/Online-Setup.md similarity index 100% rename from docs/source/Online-Setup.md rename to docs/source/Setup/Online-Setup.md diff --git a/docs/source/RSS.md b/docs/source/Setup/RSS.md similarity index 100% rename from docs/source/RSS.md rename to docs/source/Setup/RSS.md diff --git a/docs/source/Running-Evennia-in-Docker.md b/docs/source/Setup/Running-Evennia-in-Docker.md similarity index 100% rename from docs/source/Running-Evennia-in-Docker.md rename to docs/source/Setup/Running-Evennia-in-Docker.md diff --git a/docs/source/Security.md b/docs/source/Setup/Security.md similarity index 100% rename from docs/source/Security.md rename to docs/source/Setup/Security.md diff --git a/docs/source/Start-Stop-Reload.md b/docs/source/Setup/Start-Stop-Reload.md similarity index 100% rename from docs/source/Start-Stop-Reload.md rename to docs/source/Setup/Start-Stop-Reload.md diff --git a/docs/source/Tutorials.md b/docs/source/Tutorials.md deleted file mode 100644 index 7c1520a5f3..0000000000 --- a/docs/source/Tutorials.md +++ /dev/null @@ -1,156 +0,0 @@ -# Tutorials - - -Before continuing to read these tutorials (and especially before you start to code or build your -game in earnest) it's strongly recommended that you read the [Evennia coding introduction](Coding- -Introduction) as well as the [Planning your own game](Game-Planning) pages first. - -Please note that it's not within the scope of our tutorials to teach you basic Python. If you are -new to the language, expect to have to look up concepts you are unfamiliar with. Usually a quick -internet search will give you all info you need. Furthermore, our tutorials tend to focus on -implementation and concepts. As such they give only brief explanations to use Evennia features while -providing ample links to the relevant detailed documentation. - -The main information resource for builders is the [Builder Documentation](Builder-Docs). Coders -should refer to the [Developer Central](Developer-Central) for further information. - -### Building - -_Help with populating your game world._ - -- [Tutorial: Building Quick-start](Building-Quickstart) - helps you build your first rocks and -crates using Evennia's defaults. -- [Tutorial: Understanding Color Tags](Understanding-Color-Tags)- explains how you color your game's -text. -- [Introduction: The Tutorial World](Tutorial-World-Introduction) - this introduces the full (if -small) solo-adventure game that comes with the Evennia distribution. It is useful both as an example -of building and of coding. -- [Tutorial: Building a Giant Mech](Building-a-mech-tutorial) - this starts as a building tutorial -and transitions into writing code. - -### General Development tutorials - -_General code practices for newbie game developers._ - -To use Evennia, you will need basic understanding of Python -[modules](http://docs.python.org/3.7/tutorial/modules.html), -[variables](http://www.tutorialspoint.com/python/python_variable_types.htm), [conditional -statements](http://docs.python.org/tutorial/controlflow.html#if-statements), -[loops](http://docs.python.org/tutorial/controlflow.html#for-statements), -[functions](http://docs.python.org/tutorial/controlflow.html#defining-functions), [lists, -dictionaries, list comprehensions](http://docs.python.org/tutorial/datastructures.html) and [string -formatting](http://docs.python.org/tutorial/introduction.html#strings). You should also have a basic -understanding of [object-oriented -programming](http://www.tutorialspoint.com/python/python_classes_objects.htm) and what Python -[Classes](http://docs.python.org/tutorial/classes.html) are. - -- [Python tutorials for beginners](https://wiki.python.org/moin/BeginnersGuide/NonProgrammers) - -external link with tutorials for those not familiar with coding in general or Python in particular. -- [Tutorial: Version Control](Version-Control) - use GIT to organize your code both for your own -game project and for contributing to Evennia. -- MIT offers free courses in many subjects. Their [Introduction to Computer Science and -Programming](https://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-00sc- -introduction-to-computer-science-and-programming-spring-2011/) uses Python as its language of -choice. Longer path, but more in-depth. Definitely worth a look. - -### Coding - First Step tutorials - -_Starting tutorials for you who are new to developing with Evennia._ - -- [Python basic introduction](Python-basic-introduction) (part 1) - Python intro using Evennia. -- [Python basic introduction](Python-basic-tutorial-part-two) (part 2) - More on objects, classes -and finding where things are. -- [Tutorial: First Steps Coding](First-Steps-Coding) - learn each basic feature on their own through -step-by-step instruction. -- [Tutorial: A small first game](Tutorial-for-basic-MUSH-like-game) - learn basic features as part -of building a small but working game from scratch. -- [Tutorial: Adding new commands](Adding-Command-Tutorial) - focuses specifically on how to add new -commands. -- [Tutorial: Parsing command argument](Parsing-command-arguments,-theory-and-best-practices). -- [Tutorial: Adding new objects](Adding-Object-Typeclass-Tutorial) - focuses specifically on how to -add new objects. -- [Tutorial: Searching objects in the database](Tutorial-Searching-For-Objects) - how to find -existing objects so you can operate on them. - - -### Custom objects and typeclasses - -_Examples of designing new objects for your game world_ - -- [Tutorial: Rooms with Weather](Weather-Tutorial) -- [Tutorial: Aggressive NPC's](Tutorial-Aggressive-NPCs) -- [Tutorial: Listening NPC's](Tutorial-NPCs-listening) -- [Tutorial: Creating a vehicle](Tutorial-Vehicles) -- [Tutorial: Making an NPC shop](NPC-shop-Tutorial) (also advanced [EvMenu](EvMenu) usage) -- [Tutorial: Implementing a Static In Game Map](Static-In-Game-Map) (also [Batch Code](Batch-Code- -Processor) usage) -- [Tutorial: Implementing a Dynamic In Game Map](Dynamic-In-Game-Map) -- [Tutorial: Writing your own unit tests](Unit-Testing#testing-for-game-development-mini-tutorial) - -### Game mechanics tutorials - -_Creating the underlying game mechanics of game play._ - -- [Hints: Implementing a game rule system](Implementing-a-game-rule-system) -- [Tutorial: Implementing a Combat system](Turn-based-Combat-System) -- [Tutorial: Evennia for running tabletop rpgs](Evennia-for-roleplaying-sessions) - -### Miscellaneous system tutorials - -_Design various game systems and achieve particular effects._ - -- [FAQ](Coding-FAQ): A place for users to enter their own hints on achieving various goals in -Evennia. -- [Tutorial: Adding a Command prompt](Command-Prompt) -- [Tutorial: Creating a Zoning system](Zones) -- [Tutorial: Letting players manually configure color settings](Manually-Configuring-Color) -- [Hints: Asking the user a question and dealing with the result](EvMenu#ask-for-simple-input) -- [Hints: Designing commands that take time to finish](Command-Duration) -- [Hints: Adding cooldowns to commands](Command-Cooldown) -- [Tutorial: Mass and weight for objects](Mass-and-weight-for-objects) -- [Hints: Show a different message when trying a non-existent exit](Default-Exit-Errors) -- [Tutorial: Make automatic tweets of game statistics](Tutorial-Tweeting-Game-Stats) -- [Tutorial: Handling virtual time in your game](Gametime-Tutorial) -- [Tutorial: Setting up a coordinate system for rooms](Coordinates) -- [Tutorial: customize the way channels and channel commands work in your game](Customize-channels) -- [Tutorial: Adding unit tests to your game project](Unit-Testing#testing-for-game-development-mini- -tutorial) - -### Contrib - -_This section contains tutorials linked with contribs. These contribs can be used in your game, but -you'll need to install them explicitly. They add common features that can earn you time in -implementation._ - -- [list of contribs](https://github.com/evennia/evennia/blob/master/evennia/contrib/README.md) - -- [In-game Python: dialogues with characters](Dialogues-in-events). -- [In-game Python: a voice-operated elevator](A-voice-operated-elevator-using-events). - -### Web tutorials - -_Expanding Evennia's web presence._ - -- [Tutorial: Add a new web page](Add-a-simple-new-web-page) - simple example to see how Django pages -hang together. -- [Tutorial: Website customization](Web-Tutorial) - learn how to start customizing your game's web -presence. -- [Tutorial: Bootstrap & Evennia](Bootstrap-&-Evennia) - Learn more about Bootstrap, the current CSS -framework Evennia is using -- [Tutorial: Build a web page displaying a game character](Web-Character-View-Tutorial) - make a way -to view your character on the web page. -- [Tutorial: access your help system from your website](Help-System-Tutorial) -- [Tutorial: add a wiki on your website](Add-a-wiki-on-your-website) -- [Tutorial: Web Character Generation](Web-Character-Generation/) - make a web-based character -application form. -- [Tutorial: Bootstrap Components and Utilities](Bootstrap-Components-and-Utilities) - Describes -some common Bootstrap Components and Utilities that might help in designing for Evennia - -### Evennia for [Engine]-Users - -_Hints for new users more familiar with other game engines._ - -- [Evennia for Diku Users](Evennia-for-Diku-Users) - read up on the differences between Diku style -muds and Evennia. -- [Evennia for MUSH Users](Evennia-for-MUSH-Users) - an introduction to Evennia for those accustomed -to MUSH-style servers. \ No newline at end of file diff --git a/docs/source/Webclient-brainstorm.md b/docs/source/Webclient-brainstorm.md deleted file mode 100644 index da9aa8c96a..0000000000 --- a/docs/source/Webclient-brainstorm.md +++ /dev/null @@ -1,357 +0,0 @@ -# Webclient brainstorm - -# Ideas for a future webclient gui - -*This is a brainstorming whitepage. Add your own comments in a named section below.* - -## From Chat on 2019/09/02 -``` - Griatch (IRC)APP @friarzen: Could one (with goldenlayout) programmatically provide pane positions -and sizes? -I recall it was not trivial for the old split.js solution. - friarzen take a look at the goldenlayout_default_config.js -It is kinda cryptic but that is the layout json. - Griatch (IRC)APP @friarzen: Hm, so dynamically replacing the goldenlayout_config in the global -scope at the right - thing would do it? - friarzen yep - friarzen the biggest pain in the butt is that goldenlayout_config needs to be set before the -goldenlayout init() -is called, which isn't trivial with the current structure, but it isn't impossible. - Griatch (IRC)APP One could in principle re-run init() at a later date though, right? - friarzen Hmm...not sure I've ever tried it... seems doable off the top of my head... -right now, that whole file exists to be overridden on page load as a separate