VIBE - Valikzant's Immersive Backstory Encyclopedia

О проекте

VIBE (Вайб) — это готовый инструмент или же сайт для размещения и удобной кастомизации информации о персонажах/вселенных.

Инструмент может быть размещен на вашем собственном хостинге или при помощи Github Pages(Как этот).

Если я хочу добавить информацию о своём персонаже?

1. Создайте Fork репозитория.
2. Добавьте необходимые файлы о вашем персонаже/вселенной.
3. Проверьте, что ваши изменения не затрагивают системные файлы или секции, которые явно помечены, как 'СЕКЦИЯ НЕ ТРЕБУЕТ ИЗМЕНЕНИЙ.'
4. Пересмотрите добавленный контент, не нарушает ли он правила Github или, как минимум, не содержит NSFW контент и приятен глазу.
5. Создайте Pull Request из вашего Fork в оригинальный репозиторий с указанием всех изменений.

Ваша личная страница персонажа/вселенной персонажа может также иметь собственные основные/фоновые цвета, которые будут доступны в секции кастомизации для пользователя/читателя страницы или автоматически применяться, если пользователь выключил сохранение кастомизации. Это можно сделать в секции HTML страницы '<script>', изменяя переменные C_HUES и C_THEMES. (Цвета указываются в формате RGB).

Контент, что вы разместите на странице, будет под авторством того, кого вы укажете в секции страницы 'Об авторе'.

Если я хочу использовать сам инструмент в своих целях?

1. Создайте Fork репозитория проекта.
2. Удалите уже имеющийся контент (Персонажи/Вселенные и тд. Достаточно в папке CHARACTERS удалить всё, кроме папки OTHER и index-файла)
3. Делайте что угодно, добавляйте свои функции, что душе хочется, соблюдая правила лицензии проекта и правила Github.

За вами остается право изменения названия, а также размещения ссылок на другие проекты(Как и основной), использующие этот же инструмент.

Если я хочу добавить изменения в систему проекта?

1. Создайте Fork репозитория проекта.
2. Внесите изменения в файлы, на ваш взгляд, в которых, требуются изменения или улучшения.
3. Убедитесь, что с вашими изменениями проект исправно запускается на серверах (Например на GitHub Pages), а также выполняет свои функции (Как старые, так и новые, если есть).
4. Создайте Pull Request с указанием всех изменений/исправлений/улучшений.

Контакты

Если у вас есть вопросы или предложения, пожалуйста, свяжитесь с автором (со мной):

• Valikzant - @Valikzant (Youtube, Discord) - valikzant@mail.ru