From 34090bc1a84aed52941767b3ae860fcf814812b3 Mon Sep 17 00:00:00 2001 From: Dexler <69513582+DexlerXD@users.noreply.github.com> Date: Wed, 21 Aug 2024 21:33:58 +0300 Subject: [PATCH 1/5] Docs reorg && new pages --- docs/ecs.md | 0 docs/index.md | 4 +- .../mapping.md" | 0 .../creating-simple-system.md" | 2 + .../dev-introduction.md" | 43 +++++++++++++++++++ .../ecs.md" | 2 + mkdocs.yml | 1 + 7 files changed, 51 insertions(+), 1 deletion(-) delete mode 100644 docs/ecs.md rename docs/mapping.md => "docs/\320\234\320\260\320\277\320\277\320\270\320\275\320\263/mapping.md" (100%) create mode 100644 "docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/creating-simple-system.md" create mode 100644 "docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/dev-introduction.md" create mode 100644 "docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/ecs.md" diff --git a/docs/ecs.md b/docs/ecs.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/index.md b/docs/index.md index 69df33d..0661404 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,4 +9,6 @@ Вики находится на этапе заполнения, поэтому большая часть информации тут отсутствует. Её можно найти в документации от официальных разработчиков SS14 [(вот здесь)](https://docs.spacestation14.com). ## Для начинающих -[**Сборка и запуск локального сервера**](localhost.md) \ No newline at end of file +[**Сборка и запуск локального сервера**](localhost.md) + +[**Введение в разработку**](dev-introduction.md) \ No newline at end of file diff --git a/docs/mapping.md "b/docs/\320\234\320\260\320\277\320\277\320\270\320\275\320\263/mapping.md" similarity index 100% rename from docs/mapping.md rename to "docs/\320\234\320\260\320\277\320\277\320\270\320\275\320\263/mapping.md" diff --git "a/docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/creating-simple-system.md" "b/docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/creating-simple-system.md" new file mode 100644 index 0000000..956949e --- /dev/null +++ "b/docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/creating-simple-system.md" @@ -0,0 +1,2 @@ +# Создание простейшей системы с компонентом + \ No newline at end of file diff --git "a/docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/dev-introduction.md" "b/docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/dev-introduction.md" new file mode 100644 index 0000000..331632d --- /dev/null +++ "b/docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/dev-introduction.md" @@ -0,0 +1,43 @@ +# Введение в разработку + +Разработка Space Station 14 ведётся в основном на фреймворке .NET и, соответственно, на языке программирования C#. + +Это означает, что для введения в код SS14 нужно **хотя бы** знать основы C#, а также понимать, что такое **ООП (Объектно-Ориентированное Программирование)** на базовом уровне. + +## Ресурсы для изучения +### [**METANIT**](https://metanit.com/sharp/tutorial/) +Очень хороший и доступный ресурс для начинающих программистов (и не только), объясняет многие вещи с практическими примерами, лично я (**автор этой страницы - Dexler**) начинал свой путь отсюда. + +### [**Официальное руководство по C# от Microsoft**](https://learn.microsoft.com/ru-ru/dotnet/csharp/) +Официальный источник информации (та самая **БАЗА**). Максимально подобно объясняет, что и как работает в C#. Для начинающих может быть тяжело из-за иногда не самых простых примеров и стиля подачи информации. + +Также стоит отметить, что не все страницы переведены на русский язык. + +### [**SoloLearn**](https://www.sololearn.com/ru/) +Один из популярных вариантов изучения языков программирования "игровым способом". По сути, изучение материала вёдется по аналогии с сервисом Duolingo. +!!! warning "" + Без изучения вышеперечисленных ресурсов вы никуда с SoloLearn не уйдете. Данный ресурс может пригодиться для раннего изучения .NET, но не более. + +## Полезный софт +Для полноценной работы над проектом вам необходима рабочая среда. +Ниже предоставлены популярные IDE/редакторы кода, которые используются для работы. + +[**Visual Studio 2022**](https://visualstudio.microsoft.com/ru/vs/community/) + +[**Visual Studio Code**](https://code.visualstudio.com/) + +[**VSCodium (open-source версия VSCode)**](https://vscodium.com/) + +[**JetBrains Rider (платно)**](https://www.jetbrains.com/rider/) + +Также, для того, чтобы публиковать свои изменения и держать наш репозиторий под контролем, мы используем систему управления версиями - [**Git**](https://git-scm.com/). + +[**Шпаргалка по Git'у**](https://training.github.com/downloads/ru/github-git-cheat-sheet/). + +А удалённо репозитории хранятся, в основном (как, например, наш репозиторий SS220), на сервисе [**GitHub**](https://github.com/). + +## Начало пути +Для работы с билдом вам нужна будет [**локальная версия нашего репозитория и локальный сервер при нем**](localhost.md]). + +- [ECS](ecs.md) +- [Создание простейшей системы с компонентом](creating-simple-system.md) \ No newline at end of file diff --git "a/docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/ecs.md" "b/docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/ecs.md" new file mode 100644 index 0000000..8de3f83 --- /dev/null +++ "b/docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/ecs.md" @@ -0,0 +1,2 @@ +# ECS + \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 85cfc1a..5fae6c7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -29,6 +29,7 @@ plugins: - git-revision-date-localized: enable_creation_date: true fallback_to_build_date: true + - git-authors extra: social: From 689760e62c6a1b60337f235c13071d3c8722b4ae Mon Sep 17 00:00:00 2001 From: Dexler <69513582+DexlerXD@users.noreply.github.com> Date: Wed, 21 Aug 2024 22:05:14 +0300 Subject: [PATCH 2/5] Reorg navigation --- .../development/creating-simple-system.md | 0 .../development/dev-introduction.md | 0 .../ecs.md" => docs/development/ecs.md | 0 .../disdocs/sierra/backstory-gen.md | 0 .../index.md" => docs/disdocs/sierra/index.md | 0 .../disdocs/sierra/planet-gen.md | 0 .../mapping.md" => docs/mapping/mapping.md | 0 mkdocs.yml | 17 ++++++++++++++++- 8 files changed, 16 insertions(+), 1 deletion(-) rename "docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/creating-simple-system.md" => docs/development/creating-simple-system.md (100%) rename "docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/dev-introduction.md" => docs/development/dev-introduction.md (100%) rename "docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/ecs.md" => docs/development/ecs.md (100%) rename "docs/\320\224\320\270\320\267\320\264\320\276\320\272\320\270/\320\230\321\201\321\201\320\273\320\265\320\264\320\276\320\262\320\260\321\202\320\265\320\273\320\270 \321\201 \320\241\320\270\320\265\321\200\321\200\321\213(Infinity)/backstory-gen.md" => docs/disdocs/sierra/backstory-gen.md (100%) rename "docs/\320\224\320\270\320\267\320\264\320\276\320\272\320\270/\320\230\321\201\321\201\320\273\320\265\320\264\320\276\320\262\320\260\321\202\320\265\320\273\320\270 \321\201 \320\241\320\270\320\265\321\200\321\200\321\213(Infinity)/index.md" => docs/disdocs/sierra/index.md (100%) rename "docs/\320\224\320\270\320\267\320\264\320\276\320\272\320\270/\320\230\321\201\321\201\320\273\320\265\320\264\320\276\320\262\320\260\321\202\320\265\320\273\320\270 \321\201 \320\241\320\270\320\265\321\200\321\200\321\213(Infinity)/planet-gen.md" => docs/disdocs/sierra/planet-gen.md (100%) rename "docs/\320\234\320\260\320\277\320\277\320\270\320\275\320\263/mapping.md" => docs/mapping/mapping.md (100%) diff --git "a/docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/creating-simple-system.md" b/docs/development/creating-simple-system.md similarity index 100% rename from "docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/creating-simple-system.md" rename to docs/development/creating-simple-system.md diff --git "a/docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/dev-introduction.md" b/docs/development/dev-introduction.md similarity index 100% rename from "docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/dev-introduction.md" rename to docs/development/dev-introduction.md diff --git "a/docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/ecs.md" b/docs/development/ecs.md similarity index 100% rename from "docs/\320\240\320\260\320\267\321\200\320\260\320\261\320\276\321\202\320\272\320\260/ecs.md" rename to docs/development/ecs.md diff --git "a/docs/\320\224\320\270\320\267\320\264\320\276\320\272\320\270/\320\230\321\201\321\201\320\273\320\265\320\264\320\276\320\262\320\260\321\202\320\265\320\273\320\270 \321\201 \320\241\320\270\320\265\321\200\321\200\321\213(Infinity)/backstory-gen.md" b/docs/disdocs/sierra/backstory-gen.md similarity index 100% rename from "docs/\320\224\320\270\320\267\320\264\320\276\320\272\320\270/\320\230\321\201\321\201\320\273\320\265\320\264\320\276\320\262\320\260\321\202\320\265\320\273\320\270 \321\201 \320\241\320\270\320\265\321\200\321\200\321\213(Infinity)/backstory-gen.md" rename to docs/disdocs/sierra/backstory-gen.md diff --git "a/docs/\320\224\320\270\320\267\320\264\320\276\320\272\320\270/\320\230\321\201\321\201\320\273\320\265\320\264\320\276\320\262\320\260\321\202\320\265\320\273\320\270 \321\201 \320\241\320\270\320\265\321\200\321\200\321\213(Infinity)/index.md" b/docs/disdocs/sierra/index.md similarity index 100% rename from "docs/\320\224\320\270\320\267\320\264\320\276\320\272\320\270/\320\230\321\201\321\201\320\273\320\265\320\264\320\276\320\262\320\260\321\202\320\265\320\273\320\270 \321\201 \320\241\320\270\320\265\321\200\321\200\321\213(Infinity)/index.md" rename to docs/disdocs/sierra/index.md diff --git "a/docs/\320\224\320\270\320\267\320\264\320\276\320\272\320\270/\320\230\321\201\321\201\320\273\320\265\320\264\320\276\320\262\320\260\321\202\320\265\320\273\320\270 \321\201 \320\241\320\270\320\265\321\200\321\200\321\213(Infinity)/planet-gen.md" b/docs/disdocs/sierra/planet-gen.md similarity index 100% rename from "docs/\320\224\320\270\320\267\320\264\320\276\320\272\320\270/\320\230\321\201\321\201\320\273\320\265\320\264\320\276\320\262\320\260\321\202\320\265\320\273\320\270 \321\201 \320\241\320\270\320\265\321\200\321\200\321\213(Infinity)/planet-gen.md" rename to docs/disdocs/sierra/planet-gen.md diff --git "a/docs/\320\234\320\260\320\277\320\277\320\270\320\275\320\263/mapping.md" b/docs/mapping/mapping.md similarity index 100% rename from "docs/\320\234\320\260\320\277\320\277\320\270\320\275\320\263/mapping.md" rename to docs/mapping/mapping.md diff --git a/mkdocs.yml b/mkdocs.yml index 5fae6c7..21a4265 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,4 +40,19 @@ markdown_extensions: - admonition - pymdownx.details - pymdownx.superfences - - md_in_html \ No newline at end of file + - md_in_html + +nav: + - Главная: index.md + - Сборка и запуск локального сервера: localhost.md + - Диздоки: + - Исследователи с Сиерры(Infinity): + - disdocs/sierra/index.md + - disdocs/sierra/backstory-gen.md + - disdocs/sierra/planet-gen.md + - Маппинг: + - mapping/mapping.md + - Разработка: + - development/dev-introduction.md + - development/ecs.md + - development/creating-simple-system.md \ No newline at end of file From fed27d6463fd8d1dd11521be39046b909e1e54ac Mon Sep 17 00:00:00 2001 From: Dexler <69513582+DexlerXD@users.noreply.github.com> Date: Wed, 21 Aug 2024 23:00:14 +0300 Subject: [PATCH 3/5] minor linking fixes --- docs/development/dev-introduction.md | 2 +- docs/disdocs/sierra/index.md | 4 ++-- docs/index.md | 2 +- docs/mapping/mapping.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/development/dev-introduction.md b/docs/development/dev-introduction.md index 331632d..de769ed 100644 --- a/docs/development/dev-introduction.md +++ b/docs/development/dev-introduction.md @@ -37,7 +37,7 @@ А удалённо репозитории хранятся, в основном (как, например, наш репозиторий SS220), на сервисе [**GitHub**](https://github.com/). ## Начало пути -Для работы с билдом вам нужна будет [**локальная версия нашего репозитория и локальный сервер при нем**](localhost.md]). +Для работы с билдом вам нужна будет [**локальная версия нашего репозитория и локальный сервер при нем**](../localhost.md). - [ECS](ecs.md) - [Создание простейшей системы с компонентом](creating-simple-system.md) \ No newline at end of file diff --git a/docs/disdocs/sierra/index.md b/docs/disdocs/sierra/index.md index f385bc1..399e484 100644 --- a/docs/disdocs/sierra/index.md +++ b/docs/disdocs/sierra/index.md @@ -29,10 +29,10 @@ Основным геймплеем отдела являются: - Исследовательская рутина - поэтапное исследование планеты с помощью аппаратуры разделённое на тиры (основываясь на первичном исследовании заказывается более сложная и дорогая аппаратура для дальшейшего исследования), строительство инфраструктуры (энергообеспечение исследовательской апаратуры, антенна связи и т.п.). Так же включает в себя исследование природных аномалий (подробнее в диздоке генератора планеты). -- Исследование процедурно генерируемого комплекса с [**процедурно генерируемой историей**](backstory-gen), исследуемой через документы комплекса. Отчасти копирует механику IO из CM-SS13 - для упрощения поиска одни документы будут указывать на местонахождение других. Часть документов будет представлена ввиде зашифрованных дискет, требующих расшифровки с помощью терминала на станции. +- Исследование процедурно генерируемого комплекса с [**процедурно генерируемой историей**](backstory-gen.md), исследуемой через документы комплекса. Отчасти копирует механику IO из CM-SS13 - для упрощения поиска одни документы будут указывать на местонахождение других. Часть документов будет представлена ввиде зашифрованных дискет, требующих расшифровки с помощью терминала на станции. - Исследование истории комплекса подоразумевает логический конец - это может быть как богатства, секретная документация об экспериментах, так и мидраундовй антаг. Исследование подаразумевает и мелкие награды, как пример - артефакт, находящийся в хранилище под паролем. - Интеграция с целями станции - захват живой фауны для зоопарка, сбор ДНК для хранилища и т.п. ## Прочие ссылки -[**Генерация бэкстори**](backstory-gen) +[**Генерация бэкстори**](backstory-gen.md) [**Генерация планеты**](planet-gen.md) \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 0661404..c809efb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,4 +11,4 @@ ## Для начинающих [**Сборка и запуск локального сервера**](localhost.md) -[**Введение в разработку**](dev-introduction.md) \ No newline at end of file +[**Введение в разработку**](development/dev-introduction.md) \ No newline at end of file diff --git a/docs/mapping/mapping.md b/docs/mapping/mapping.md index 10753dd..2014b8e 100644 --- a/docs/mapping/mapping.md +++ b/docs/mapping/mapping.md @@ -13,7 +13,7 @@ ## Подготовка Маппинг происходит на сервере, поэтому для маппинга необходимо поднять свой локальный сервер. Для этого будет необходимо сначала скачать актуальную версию кода проекта из репозитория используя Git, а затем собрать её в конфигурации *Release*. -О том как это сделать можно прочитать в нашем [**подробном гайде**](localhost.md). +О том как это сделать можно прочитать в нашем [**подробном гайде**](../localhost.md). ## Маппинг ### Запуск mapping-режима From 3d24bbf6220a2ea2a55114b189554a1e29b2828a Mon Sep 17 00:00:00 2001 From: Dexler <69513582+DexlerXD@users.noreply.github.com> Date: Wed, 21 Aug 2024 23:09:16 +0300 Subject: [PATCH 4/5] add .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ccbfadb --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +site/ \ No newline at end of file From b404b01b466c5c3ff1c44898cef450b921fa94c9 Mon Sep 17 00:00:00 2001 From: Dexler <69513582+DexlerXD@users.noreply.github.com> Date: Wed, 21 Aug 2024 23:24:54 +0300 Subject: [PATCH 5/5] updated .net version --- docs/localhost.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/localhost.md b/docs/localhost.md index 0f8265c..bf3cedd 100644 --- a/docs/localhost.md +++ b/docs/localhost.md @@ -11,7 +11,7 @@ * Git - [https://git-scm.com](https://git-scm.com) * Python 3.7 или новее - [https://www.python.org](https://www.python.org) - качать именно с оф. сайта а не с Windows Store иначе могут возникнуть проблемы со скриптом -* .NET 7 SDK x64 - [https://dotnet.microsoft.com/en-us/download](https://dotnet.microsoft.com/en-us/download) +* .NET 8 SDK x64 - [https://dotnet.microsoft.com/en-us/download](https://dotnet.microsoft.com/en-us/download) ## Клонирование кода После установки всего вышеперечисленного теперь нужно скачать код проекта через Git.