From 4be51a0bb5127f4967ac0c23f97c588c31535c8b Mon Sep 17 00:00:00 2001 From: alcapurrias <63966511+alcapurrias@users.noreply.github.com> Date: Sat, 16 Mar 2024 14:10:54 -0500 Subject: [PATCH] Update README.md Added customization directions with note for gulp not found error message --- doc/ADMIN.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 doc/ADMIN.md diff --git a/doc/ADMIN.md b/doc/ADMIN.md new file mode 100644 index 0000000..0c08ebd --- /dev/null +++ b/doc/ADMIN.md @@ -0,0 +1,9 @@ +## Customising assets and locale + +* To add custom CSS for all users, edit `__INSTALL_DIR__/custom/assets/instance.css`. +* To add static assets (such as images for the splash screen), place them in the `__INSTALL_DIR__/custom/assets/` directory. They'll then be available on . +* To add custom locales, place them in the `__INSTALL_DIR__/custom/locales/` directory. If you name your custom locale the same as an existing locale, it will overwrite it. If you give it a unique name, it will be added to the list. Also make sure that the first part of the filename matches the locale you're basing it on. (Example: en-FOO.yml) +* To add custom error images, place them in the `__INSTALL_DIR__/custom/assets/badges` directory, replacing the files already there. +* To add custom sounds, place only mp3 files in the `__INSTALL_DIR__/custom/assets/sounds` directory. +* To update custom assets without rebuilding, just run `yarn run gulp`. + * If a `gulp not found` error is received, run `yarn global add gulp-cli` then `yarn install` in `__INSTALL_DIR__` and try `yarn run gulp` again.