Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Roadmap #307

Merged
merged 9 commits into from
Nov 1, 2024
Merged

Roadmap #307

merged 9 commits into from
Nov 1, 2024

Conversation

Farrellka-dev
Copy link
Contributor

image

Описание обновления:

Сделал роадмап.

Медиа
image

Проверки

  • PR завершён и мне не нужна помощь чтобы его закончить.
  • Я внимательно просмотрел все свои изменения и багов в них не нашёл.
  • Я запускал локальный сервер со своими изменениями и всё протестировал.
  • Я добавил скриншот/видео демонстрации PR в игре, или этот PR этого не требует.
  • Я не добавлял контент нарушающий чужие авторские права.
  • Я добавил свой контент только в папку _LostParadise(только если вы не меняете оригинальный код).
  • Я не добавлял переводы в прототипы, а сделал их с помощью скрипта translations.bat в Tools/SS14_RU.

Изменения

🆑 Farrellka

  • add: Добавлен план разработки Lost-Paradise в меню игры!

@Farrellka-dev Farrellka-dev requested a review from BL02DL as a code owner October 28, 2024 07:50
Copy link
Contributor

coderabbitai bot commented Oct 28, 2024

Walkthrough

В данном запросе на изменение добавлены новые элементы интерфейса и функциональность, связанные с отображением дорожной карты в клиенте Lost Paradise. В классе LinkBanner добавлена кнопка для переключения интерфейса дорожной карты, а в EscapeMenu — кнопка для доступа к ней. Созданы новые классы RoadmapControl и RoadmapUI для управления отображением дорожной карты, а также добавлен класс RoadmapSystem для управления обновлениями фаз дорожной карты на сервере. Также были добавлены новые локализации и конфигурации для дорожной карты.

Changes

Файл Изменения
Content.Client/Info/LinkBanner.cs Добавлена кнопка server-info-roadmap-button, изменены директивы using.
Content.Client/Options/UI/EscapeMenu.xaml Добавлена кнопка RoadmapButton с доступом Public и стилем Caution.
Content.Client/UserInterface/Systems/EscapeMenu/EscapeUIController.cs Обновлен метод OnStateEntered, добавлены кнопки OpenDiscordButton и OpenBoostyButton.
Content.Client/_LostParadise/Roadmap/RoadmapControl.cs Добавлен класс RoadmapControl, инициализация с RoadmapPrototype, метод SetupUI.
Content.Client/_LostParadise/Roadmap/RoadmapUI.cs Добавлен класс RoadmapUI, методы ToggleRoadmap и RefreshUI.
Content.Server/_LostParadise/Roadmap/RoadmapSystem.cs Добавлен класс RoadmapSystem, методы Initialize и OnPhaseUpdate.
Content.Shared/_LostParadise/Roadmap/RoadmapComponent.cs Добавлен класс RoadmapComponent, свойства CurrentPhase и Progress.
Content.Shared/_LostParadise/Roadmap/RoadmapPrototype.cs Добавлен класс RoadmapPrototype, свойства ID, Name, Description, Progress, Status, Order.
Content.Shared/_LostParadise/Roadmap/RoadmapUpdateEvent.cs Добавлен класс RoadmapUpdateEvent, свойства RoadmapId и NewProgress.
Resources/Locale/ru-RU/_LostParadise/roadmap/roadmap.ftl Добавлены новые строки локализации для дорожной карты.
Resources/Prototypes/_LostParadise/Roadmap/roadmap.yml Добавлены новые записи для дорожной карты с атрибутами type, id, name, description, progress, status, order.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EscapeMenu
    participant RoadmapUI
    participant RoadmapControl
    participant RoadmapSystem

    User->>EscapeMenu: Нажимает RoadmapButton
    EscapeMenu->>RoadmapUI: ToggleRoadmap()
    RoadmapUI->>RoadmapControl: RefreshUI()
    RoadmapControl->>User: Отображает дорожную карту
    RoadmapSystem->>RoadmapControl: Обновления фаз
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added Статус: Требуется одобрение Ожидание разработчиков для принятия решений Изменения: C# Изменяет какие-либо файлы .cs Изменения: Локализация Изменяет какие-либо файлы .ftl Изменения: Интерфейс Изменяет какие-либо файлы .xaml Изменения: YML Изменяет какие-либо файлы .yml labels Oct 28, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 22

🧹 Outside diff range comments (1)
Content.Client/UserInterface/Systems/EscapeMenu/EscapeUIController.cs (1)

Line range hint 108-116: Предложение по улучшению управления URL

Рекомендуется перенести URL-адреса Discord и Boosty в конфигурацию, аналогично реализации WikiButton. Это упростит управление ссылками и их обновление в будущем.

Предлагаемые изменения:

  1. Добавьте новые параметры в CCVars:
public static string InfoLinksDiscord = "https://wiki.lost-paradise.space/discord";
public static string InfoLinksBoosty = "https://boosty.to/lost-paradise";
  1. Измените обработчики кнопок:
-_uri.OpenUri("https://wiki.lost-paradise.space/discord");
+_uri.OpenUri(_cfg.GetCVar(CCVars.InfoLinksDiscord));

-_uri.OpenUri("https://boosty.to/lost-paradise");
+_uri.OpenUri(_cfg.GetCVar(CCVars.InfoLinksBoosty));
📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 894b0df and fd9df29.

📒 Files selected for processing (11)
  • Content.Client/Info/LinkBanner.cs (2 hunks)
  • Content.Client/Options/UI/EscapeMenu.xaml (1 hunks)
  • Content.Client/UserInterface/Systems/EscapeMenu/EscapeUIController.cs (2 hunks)
  • Content.Client/_LostParadise/Roadmap/RoadmapControl.cs (1 hunks)
  • Content.Client/_LostParadise/Roadmap/RoadmapUI.cs (1 hunks)
  • Content.Server/_LostParadise/Roadmap/RoadmapSystem.cs (1 hunks)
  • Content.Shared/_LostParadise/Roadmap/RoadmapComponent.cs (1 hunks)
  • Content.Shared/_LostParadise/Roadmap/RoadmapPrototype.cs (1 hunks)
  • Content.Shared/_LostParadise/Roadmap/RoadmapUpdateEvent.cs (1 hunks)
  • Resources/Locale/ru-RU/_LostParadise/roadmap/roadmap.ftl (1 hunks)
  • Resources/Prototypes/_LostParadise/Roadmap/roadmap.yml (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
Resources/Locale/ru-RU/_LostParadise/roadmap/roadmap.ftl (1)

Pattern **/*.ftl: Все повторяющиеся переводы должны быть написаны так:
Оригинальный перевод - id1 = text1
Повторяющийся, но с изменениями id2 = { id1 }
и если требуется .desc должен прописываться как { id1.desc }

А многострочные переводы начинающиеся со спецсимвола должны идти сначала id = спецсимвол текст и потом следующая строчка. Пример
id = спецсимвол текст
текст
спецсимвол текст

Все переводы начинающиеся с ent- должны быть с большой буквы после =. Даже после .desc и .suffix

Resources/Prototypes/_LostParadise/Roadmap/roadmap.yml (1)

Pattern **/*.yml: так же в прототипах запрещены любые переводы на русский. Только на английском или ссылкой на перевод.

Все добавляемые прототипы должны быть в нашей папке.

Никогда не предлагать ничего по отступам

При удалении дополнительного дополнения по типу prob:, можно оставить оригинальную часть с - id:.

🪛 yamllint
Resources/Prototypes/_LostParadise/Roadmap/roadmap.yml

[error] 1-1: trailing spaces

(trailing-spaces)


[error] 27-27: no new line character at the end of file

(new-line-at-end-of-file)

🔇 Additional comments (11)
Resources/Locale/ru-RU/_LostParadise/roadmap/roadmap.ftl (3)

1-2: Корректный перевод элементов меню!

Переводы логически связаны и грамматически верны.


3-5: Корректный перевод индикаторов статуса!

Все статусы переведены в правильном падеже и соответствуют контексту использования.


6-7: Корректный перевод заголовков!

Переводы лаконичны и точно отражают назначение элементов интерфейса.

Content.Shared/_LostParadise/Roadmap/RoadmapComponent.cs (1)

7-9: Компонент корректно зарегистрирован и объявлен.

Класс правильно помечен атрибутом [RegisterComponent] и наследуется от базового класса Component. Модификатор sealed предотвращает наследование, что является хорошей практикой для компонентов.

Content.Shared/_LostParadise/Roadmap/RoadmapPrototype.cs (1)

1-8: LGTM: Корректное объявление прототипа

Правильное использование атрибута Prototype и наследование от IPrototype. Namespace соответствует структуре проекта.

Content.Server/_LostParadise/Roadmap/RoadmapSystem.cs (2)

1-9: Импорты и пространство имён корректны!

Все необходимые зависимости присутствуют и правильно организованы.


14-19: Инициализация реализована корректно!

Метод правильно вызывает базовую инициализацию и подписывается на необходимое событие.

Content.Client/Options/UI/EscapeMenu.xaml (1)

9-9: Корректная реализация кнопки дорожной карты

Кнопка правильно интегрирована в меню и следует установленным паттернам: публичный доступ, локализация текста и согласованное размещение в иерархии меню.

Content.Client/Info/LinkBanner.cs (1)

52-58: 🧹 Nitpick (assertive)

Проверьте необходимость использования StyleBase.ButtonCaution

Стиль кнопки установлен как ButtonCaution, что обычно используется для действий, требующих особого внимания пользователя. Убедитесь, что это соответствует UX-требованиям.

Также рекомендуется:

  1. Добавить комментарий, объясняющий причину использования предупреждающего стиля
  2. Рассмотреть возможность вынесения обработчика нажатия в отдельный метод для улучшения читаемости
 var roadmapButton = new Button
 {
     Text = Loc.GetString("server-info-roadmap-button"),
-    StyleClasses = { StyleBase.ButtonCaution },
 };
-roadmapButton.OnPressed += _ => UserInterfaceManager.GetUIController<RoadmapUI>().ToggleRoadmap();
+roadmapButton.OnPressed += OnRoadmapButtonPressed;
 buttons.AddChild(roadmapButton);
+
+private void OnRoadmapButtonPressed(BaseButton.ButtonEventArgs args)
+{
+    UserInterfaceManager.GetUIController<RoadmapUI>().ToggleRoadmap();
+}

Давайте проверим использование этого стиля в других местах:

Content.Client/_LostParadise/Roadmap/RoadmapControl.cs (1)

1-25: Корректная инициализация класса и конструктора!

Структура класса хорошо организована, зависимости правильно внедрены через конструктор, а инициализация ProgressBar выполнена корректно.

Content.Client/UserInterface/Systems/EscapeMenu/EscapeUIController.cs (1)

67-71: Корректная реализация обработчика RoadmapButton

Реализация соответствует общему паттерну обработки кнопок в меню. Правильно организовано закрытие текущего окна перед отображением нового интерфейса.

@Farrellka-dev
Copy link
Contributor Author

не готова

@Evgencheg Evgencheg added Статус: Требуется изменения Ожидание выполнения требований к изменениям разработчиков Статус: Не мержить НЕ МЕРЖИТЬ! Приоритет: 2-Высокий Решить в обязательном порядке Размер: 3-Средний Для средних ПР'ов/баг репортов labels Oct 28, 2024
@Farrellka-dev
Copy link
Contributor Author

я не могу понять, там в тестах ошибка какая-то, которая к моему роадмапу вообще ну никак не относится...

@Evgencheg Evgencheg merged commit bb53a70 into Lost-Paradise-Project:master Nov 1, 2024
11 checks passed
@Farrellka-dev Farrellka-dev deleted the roadmap4 branch November 10, 2024 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Изменения: C# Изменяет какие-либо файлы .cs Изменения: YML Изменяет какие-либо файлы .yml Изменения: Интерфейс Изменяет какие-либо файлы .xaml Изменения: Локализация Изменяет какие-либо файлы .ftl Приоритет: 2-Высокий Решить в обязательном порядке Размер: 3-Средний Для средних ПР'ов/баг репортов Статус: Не мержить НЕ МЕРЖИТЬ! Статус: Требуется изменения Ожидание выполнения требований к изменениям разработчиков Статус: Требуется одобрение Ожидание разработчиков для принятия решений
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants