Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Relinked with correct relative links

Browse source
This commit is contained in:
Griatch 2020-06-19 15:56:02 +02:00
parent 3e8017a874
commit 061dfbffaa
91 changed files with 633 additions and 631 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/Coding/Continuous-Integration.md
View file

@ -27,7 +27,7 @@ Among those you will need:
* A Continuous Integration Environment.
* I recommend [TeamCity](https://www.jetbrains.com/teamcity/) which has an in-depth [Setup
Guide](https://confluence.jetbrains.com/display/TCD8/Installing+and+Configuring+the+TeamCity+Server)
* [Source Control](Coding/Version-Control)
* [Source Control](Version-Control)
* This could be Git or SVN or any other available SC.
## Linux TeamCity Setup

12
docs/source/Coding/Directory-Overview.md
View file

@ -10,7 +10,7 @@ assume it's called `mygame`. Apart from the `server/` subfolder within, you coul
folder if you preferred a different code structure for your game.
- `mygame/`
- `commands/` - Overload default [Commands](Component/Commands) or add your own Commands/[Command
- `commands/` - Overload default [Commands](../Component/Commands) or add your own Commands/[Command
sets](Command-Sets) here.
- `server`/ - The structure of this folder should not change since Evennia expects it.
- [`conf/`](https://github.com/evennia/evennia/tree/master/evennia/game_template/server) - All
@ -19,7 +19,7 @@ server configuration files sits here. The most important file is `settings.py`.
- `typeclasses/` - this folder contains empty templates for overloading default game entities of
Evennia. Evennia will automatically use the changes in those templates for the game entities it
creates.
- `web/` - This holds the [Web features](Concept/Web-Features) of your game.
- `web/` - This holds the [Web features](../Concept/Web-Features) of your game.
- `world/` - this is a "miscellaneous" folder holding everything related to the world you are
building, such as build scripts and rules modules that don't fit with one of the other folders.
@ -30,18 +30,18 @@ top level of it contains Python package specific stuff such as a readme file, `s
also has two subfolders`bin/` and `evennia/` (again).
The `bin/` directory holds OS-specific binaries that will be used when installing Evennia with `pip`
as per the [Getting started](Setup/Getting-Started) instructions. The library itself is in the `evennia`
as per the [Getting started](../Setup/Getting-Started) instructions. The library itself is in the `evennia`
subfolder. From your code you will access this subfolder simply by `import evennia`.
- evennia
- [`__init__.py`](Evennia-API) - The "flat API" of Evennia resides here.
- [`commands/`](Commands) - The command parser and handler.
- `default/` - The [default commands](Component/Default-Command-Help) and cmdsets.
- `default/` - The [default commands](../Component/Default-Command-Help) and cmdsets.
- [`comms/`](Communications) - Systems for communicating in-game.
- `contrib/` - Optional plugins too game-specific for core Evennia.
- `game_template/` - Copied to become the "game directory" when using `evennia --init`.
- [`help/`](Help-System) - Handles the storage and creation of help entries.
- `locale/` - Language files ([i18n](Concept/Internationalization)).
- `locale/` - Language files ([i18n](../Concept/Internationalization)).
- [`locks/`](Locks) - Lock system for restricting access to in-game entities.
- [`objects/`](Objects) - In-game entities (all types of items and Characters).
- [`prototypes/`](Spawner-and-Prototypes) - Object Prototype/spawning system and OLC menu
@ -62,7 +62,7 @@ required by Python so as to be able to find and import modules in other director
run Evennia at least once you will find that there will also be `.pyc` files appearing, these are
pre-compiled binary versions of the `.py` files to speed up execution.
The root of the `evennia` folder has an `__init__.py` file containing the "[flat API](Coding/Evennia-API)".
The root of the `evennia` folder has an `__init__.py` file containing the "[flat API](../Evennia-API)".
This holds shortcuts to various subfolders in the evennia library. It is provided to make it easier
to find things; it allows you to just import `evennia` and access things from that rather than
having to import from their actual locations inside the source tree.

2
docs/source/Coding/Profiling.md
View file

@ -52,7 +52,7 @@ profiler through the launcher:
This will start Evennia with the Server component running (in daemon mode) under cProfile. You could
instead try `--profile` with the `portal` argument to profile the Portal (you would then need to
[start the Server separately](Setup/Start-Stop-Reload)).
[start the Server separately](../Setup/Start-Stop-Reload)).
Please note that while the profiler is running, your process will use a lot more memory than usual.
Memory usage is even likely to climb over time. So don't leave it running perpetually but monitor it

4
docs/source/Coding/Quirks.md
View file

@ -64,7 +64,7 @@ update the database you'd need to explicitly re-assign the updated data to the `
### Commands are matched by name *or* alias
When merging [command sets](Component/Commands) it's important to remember that command objects are identified
When merging [command sets](../Component/Commands) it's important to remember that command objects are identified
*both* by key *or* alias. So if you have a command with a key `look` and an alias `ls`, introducing
another command with a key `ls` will be assumed by the system to be *identical* to the first one.
This usually means merging cmdsets will overload one of them depending on priority. Whereas this is
@ -110,7 +110,7 @@ Try to avoid doing so.
distributions (notably Ubuntu 16.04 LTS). Zope is a dependency of Twisted. The error manifests in
the server not starting with an error that `zope.interface` is not found even though `pip list`
shows it's installed. The reason is a missing empty `__init__.py` file at the root of the zope
package. If the virtualenv is named "evenv" as suggested in the [Getting Started](Setup/Getting-Started)
package. If the virtualenv is named "evenv" as suggested in the [Getting Started](../Setup/Getting-Started)
instructions, use the following command to fix it:
```shell

2
docs/source/Coding/Unit-Testing.md
View file

@ -153,7 +153,7 @@ class in the same module to get access to the command-specific utilities mention
### Unit testing contribs with custom models
A special case is if you were to create a contribution to go to the `evennia/contrib` folder that
uses its [own database models](Concept/New-Models). The problem with this is that Evennia (and Django) will
uses its [own database models](../Concept/New-Models). The problem with this is that Evennia (and Django) will
only recognize models in `settings.INSTALLED_APPS`. If a user wants to use your contrib, they will
be required to add your models to their settings file. But since contribs are optional you cannot
add the model to Evennia's central `settings_default.py` file - this would always create your

6
docs/source/Coding/Updating-Your-Game.md
View file

@ -2,7 +2,7 @@
Fortunately, it's extremely easy to keep your Evennia server up-to-date. If you haven't already, see
the [Getting Started guide](Setup/Getting-Started) and get everything running.
the [Getting Started guide](../Setup/Getting-Started) and get everything running.
### Updating with the latest Evennia code changes
@ -72,13 +72,13 @@ When the database schema changes, you just go to your game folder and run
evennia migrate
> Hint: If the `evennia` command is not found, you most likely need to activate your
[virtualenv](Glossary#virtualenv).
[virtualenv](../Glossary#virtualenv).
## Resetting your database
Should you ever want to start over completely from scratch, there is no need to re-download Evennia
or anything like that. You just need to clear your database. Once you are done, you just rebuild it
from scratch as described in [step 2](Setup/Getting-Started#step-2-setting-up-your-game) of the [Getting
from scratch as described in [step 2](../Setup/Getting-Started#step-2-setting-up-your-game) of the [Getting
Started guide](Getting-Started).
First stop a running server with

2
docs/source/Coding/Version-Control.md
View file

@ -324,7 +324,7 @@ developer mailing list or IRC chat to see beforehand if your feature is deemed s
as a core feature in the engine. When it comes to bug-fixes, other developers may also have good
input on how to go about resolving the issue.
To contribute you need to have [forked Evennia](Coding/Version-Control#forking-evennia) first. As described
To contribute you need to have [forked Evennia](Version-Control#forking-evennia) first. As described
above you should do your modification in a separate local branch (not in the master branch). This
branch is what you then present to us (as a *Pull request*, PR, see below). We can then merge your
change into the upstream master and you then do `git pull` to update master usual. Now that the