Added README.md files to the game_template directories.
This commit is contained in:
parent
981cecbc6f
commit
d2205da980
4 changed files with 78 additions and 0 deletions
14
evennia/game_template/commands/README.md
Normal file
14
evennia/game_template/commands/README.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
# commands/
|
||||||
|
|
||||||
|
This folder holds modules for implementing one's own commands and
|
||||||
|
command sets. All the modules' classes are essentially empty and just
|
||||||
|
imports the default implementations from Evennia; so adding anything
|
||||||
|
to them will start overloading the defaults.
|
||||||
|
|
||||||
|
You can change the organisation of this directory as you see fit, just
|
||||||
|
remember that if you change any of the default command set classes'
|
||||||
|
locations, you need to add the appropriate paths to
|
||||||
|
`server/conf/settings.py` so that Evennia knows where to find them.
|
||||||
|
Also remember that if you create new sub directories you must put
|
||||||
|
(optionally empty) `__init__.py` files in there so that Python can
|
||||||
|
find your modules.
|
||||||
38
evennia/game_template/server/README.md
Normal file
38
evennia/game_template/server/README.md
Normal file
|
|
@ -0,0 +1,38 @@
|
||||||
|
# server/
|
||||||
|
|
||||||
|
This directory holds files used by and configuring the Evennia server
|
||||||
|
itself.
|
||||||
|
|
||||||
|
Out of all the subdirectories in the game directory, Evennia does
|
||||||
|
expect this directory to exist, so you should normally not delete,
|
||||||
|
rename or change its folder structure.
|
||||||
|
|
||||||
|
When running you will find four new files appear in this directory:
|
||||||
|
|
||||||
|
- `server.pid` and `portal.pid`: These hold the process IDs of the
|
||||||
|
Portal and Server, so that they can be managed by the launcher. If
|
||||||
|
Evennia is shut down uncleanly (e.g. by a crash or via a kill
|
||||||
|
signal), these files might erroneously remain behind. If so Evennia
|
||||||
|
will tell you they are "stale" and they can be deleted manually.
|
||||||
|
- `server.restart` and `portal.restart`: These hold flags to tell the
|
||||||
|
server processes if it should die or start again. You never need to
|
||||||
|
modify those files.
|
||||||
|
- `evennia.db3`: This will only appear if you are using the default
|
||||||
|
SQLite3 database; it a binary file that holds the entire game
|
||||||
|
database; deleting this file will effectively reset the game for
|
||||||
|
you and you can start fresh with `evennia migrate` (useful during
|
||||||
|
development).
|
||||||
|
|
||||||
|
## server/conf/
|
||||||
|
|
||||||
|
This subdirectory holds the configuration modules for the server. With
|
||||||
|
them you can change how Evennia operates and also plug in your own
|
||||||
|
functionality to replace the default. You usually need to restart the
|
||||||
|
server to apply changes done here. The most importand file is the file
|
||||||
|
`settings.py´ which is the main configuration file of Evennia.
|
||||||
|
|
||||||
|
## server/logs/
|
||||||
|
|
||||||
|
This subdirectory holds various log files created by the running
|
||||||
|
Evennia server. It is also the default location for storing any custom
|
||||||
|
log files you might want to output using Evennia's logging mechanisms.
|
||||||
16
evennia/game_template/typeclasses/README.md
Normal file
16
evennia/game_template/typeclasses/README.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
# typeclasses/
|
||||||
|
|
||||||
|
This directory holds the modules for overloading all the typeclasses
|
||||||
|
representing the game entities and many systems of the game. Other
|
||||||
|
server functionality not covered here is usually modified by the
|
||||||
|
modules in `server/conf/`.
|
||||||
|
|
||||||
|
Each module holds empty classes that just imports Evennia's defaults.
|
||||||
|
Any modifications done to these classes will overload the defaults.
|
||||||
|
|
||||||
|
You can change the structure of this directory (even rename the
|
||||||
|
directory itself) as you please, but if you do you must add the
|
||||||
|
appropriate new paths to your settings.py file so Evennia knows where
|
||||||
|
to look. Also remember that for Python to find your modules, it
|
||||||
|
requires you to add an empty `__init__.py` file in any new sub
|
||||||
|
directories you create.
|
||||||
10
evennia/game_template/world/README.md
Normal file
10
evennia/game_template/world/README.md
Normal file
|
|
@ -0,0 +1,10 @@
|
||||||
|
# world/
|
||||||
|
|
||||||
|
This folder is meant as a miscellanous folder for all that other stuff
|
||||||
|
related to the game. Code which are not commands or typeclasses go
|
||||||
|
here, like custom economy systems, combat code, batch-files etc.
|
||||||
|
|
||||||
|
You can restructure and even rename this folder as best fits your
|
||||||
|
sense of organisation. Just remember that if you add new sub
|
||||||
|
directories, you must add (optionally empty) `__init__.py` files in
|
||||||
|
them for Python to be able to find the modules within.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue