diff --git a/evennia/game_template/web/static_overrides/README.md b/evennia/game_template/web/static_overrides/README.md index 0bc428b141..ab9a09eb9f 100644 --- a/evennia/game_template/web/static_overrides/README.md +++ b/evennia/game_template/web/static_overrides/README.md @@ -1,7 +1,13 @@ -If you want to override one of the static files (such as a CSS or JS file) used by Evennia or a Django app installed in your Evennia project, copy it into this folder, and it will be placed in the static folder when you run: +If you want to override one of the static files (such as a CSS or JS file) used by Evennia or a Django app installed in your Evennia project, +copy it into this directory's corresponding subdirectory, and it will be placed in the static folder when you run: python manage.py collectstatic ...or when you reload the server via the command line. Do note you may have to reproduce any preceeding directory structures for the file to end up in the right place. + +Also note that you may need to clear out existing static files for your new ones to be gathered in some cases. Deleting files in static/ +will force them to be recollected. + +To see what files can be overridden, find where your evennia package is installed, and look in `evennia/web/static/` diff --git a/evennia/game_template/web/static_overrides/evennia_general/css/README.md b/evennia/game_template/web/static_overrides/evennia_general/css/README.md new file mode 100644 index 0000000000..04db92fb7e --- /dev/null +++ b/evennia/game_template/web/static_overrides/evennia_general/css/README.md @@ -0,0 +1,3 @@ +You can replace the CSS files for Evennia's homepage here. + +You can find the original files in `evennia/web/static/evennia_general/css/` diff --git a/evennia/game_template/web/static_overrides/evennia_general/images/README.md b/evennia/game_template/web/static_overrides/evennia_general/images/README.md new file mode 100644 index 0000000000..770067730a --- /dev/null +++ b/evennia/game_template/web/static_overrides/evennia_general/images/README.md @@ -0,0 +1,3 @@ +You can replace the image files for Evennia's home page here. + +You can find the original files in `evennia/web/static/evennia_general/images/` diff --git a/evennia/game_template/web/template_overrides/README.md b/evennia/game_template/web/template_overrides/README.md index 8fb5f1fdb8..4a8a864971 100644 --- a/evennia/game_template/web/template_overrides/README.md +++ b/evennia/game_template/web/template_overrides/README.md @@ -1,4 +1,4 @@ Place your own version of templates into this file to override the default ones. -For instance, if there's a template at: `src/web/templates/evennia_general/index.html` -and you want to replace it, create the file `game/gamesrc/web/template_overrides/evennia_general/index.html` -and it will be loaded instead. \ No newline at end of file +For instance, if there's a template at: `evennia/web/templates/evennia_general/index.html` +and you want to replace it, create the file `template_overrides/evennia_general/index.html` +and it will be loaded instead. diff --git a/evennia/game_template/web/template_overrides/evennia_general/README.md b/evennia/game_template/web/template_overrides/evennia_general/README.md new file mode 100644 index 0000000000..0ed259de35 --- /dev/null +++ b/evennia/game_template/web/template_overrides/evennia_general/README.md @@ -0,0 +1,3 @@ +Replace Evennia's Django templates with your own here. + +You can find the original files in evennia/web/templates/evennia_general diff --git a/evennia/game_template/web/template_overrides/prosimii/README.md b/evennia/game_template/web/template_overrides/prosimii/README.md new file mode 100644 index 0000000000..1a47fabaf4 --- /dev/null +++ b/evennia/game_template/web/template_overrides/prosimii/README.md @@ -0,0 +1,4 @@ +You can replace the theme templates for the default theme 'prosimii' here. You may wish to create a different +theme instead, however, and update your settings accordingly. + +You can find the original files in `evennia/web/templates/prosimii/` diff --git a/evennia/game_template/web/template_overrides/prosimii/flatpages/README.md b/evennia/game_template/web/template_overrides/prosimii/flatpages/README.md new file mode 100644 index 0000000000..0fd3c1ff6b --- /dev/null +++ b/evennia/game_template/web/template_overrides/prosimii/flatpages/README.md @@ -0,0 +1,3 @@ +Flatpages require a default.html template, which can be overwritten by placing it in this folder. + +You can find the original files in `evennia/web/templates/evennia_general/prosimii/flatpages/` diff --git a/evennia/game_template/web/template_overrides/prosimii/registration/README.md b/evennia/game_template/web/template_overrides/prosimii/registration/README.md new file mode 100644 index 0000000000..7b668922f2 --- /dev/null +++ b/evennia/game_template/web/template_overrides/prosimii/registration/README.md @@ -0,0 +1,3 @@ +The templates involving login/logout can be overwritten here. + +You can find the original files in `evennia/web/templates/prosimii/registration/`