Difference between revisions of "Main Page"

From Ciliz|W4
(26 intermediate revisions by the same user not shown)
Line 1: Line 1:
Временная страница для тестов -- [[SettingsStuffPage]] | Залогиниться -- [[Special:UserLogin]]
+
Welcome to the W4 Engine wiki!
  
''Обсуждаемо! :) Названия и описания разделов рабочие, будут корректироваться по мере наполнения.''
+
We are working on filling the wiki with documentation. The following articles are available for the time being:
  
 
{{ContentGrid
 
{{ContentGrid
Line 7: Line 7:
  
 
{{InfoCard
 
{{InfoCard
|heading = [[File:G.png|40px|link=]] <!--T:1--> Getting Started
+
|heading = General Concepts
 
|content =
 
|content =
'''Вольный стиль. Схемы.''' О чем мы тут. Общая идея движка. Возможности. Системные требования и требования к пользователю (программисту). Совсем поверхностная структура. Установка и настройка. Описание интерфейса (GUI, CLI).
+
System architecture and main solutions:
* [[1 Временное название 1]]
+
* [[W4 Engine architecture]]
* [[1 Временное название 2]]
+
* [[W4 Coordinate system and Node structure]]
* [[1 Временное название 3]]
+
* [[W4 Main Game Loop]] Needs a description
* [[1 Временное название 4]]
+
}}
* [[1 Временное название 5]]
 
* [[1 Временное название 6]]
 
}} 
 
 
 
{{InfoCard
 
|heading = How does it work?
 
|content =
 
'''Вольный стиль. Схемы.''' Основные настраиваемые параметры. Общие принципы работы. Общее описание структуры (иерархия подсистем, их назначение, как они работают для программиста). Здесь же чуть глубже описание сложных подсистем - рендера, физики, UI, файловой системы и т.п. с разбором их структуры и возможностей управления.
 
* [[2 Временное название 1]]
 
* [[2 Временное название 2]]
 
* [[2 Временное название 3]]
 
* [[2 Временное название 4]]
 
* [[2 Временное название 5]]
 
* [[2 Временное название 6]]
 
}} 
 
 
 
{{InfoCard
 
|heading = Let's use it!
 
|content =
 
'''Смешанный стиль (вольная вводная часть, инструкции, код и т.п., как пойдет).''' Основной раздел (в этой части можно взять за основу структуру доки UNITY). Подробное описание для разработчика приложений. В отличие от How does it work? делается упор на практическую полезность для программиста и четкие инструкции, а не общую информацию об устройстве движка. Сгруппировано по общим направлениям работы (программирование UI, AI, анимация, аудио и т.п., отдельно можно рассказать про специфику (различия для платформ и назначения приложения в целом (игра, реклама и т.п.))).
 
* [[Input]]
 
* [[3 Временное название 2]]
 
* [[3 Временное название 3]]
 
* [[3 Временное название 4]]
 
* [[3 Временное название 5]]
 
* [[3 Временное название 6]]
 
}}
 
  
 
{{InfoCard
 
{{InfoCard
|heading = List of Objects
+
|heading = Parts
 
|content =
 
|content =
'''Справочник.''' Структурированный перечень элементов, которые можно использовать (ноды, свет и т.п.). Возможно вольное описание нестандартных объектов или нестандартного использования.
+
Complex subsystems:
}} 
+
* [[W4 Material System]]
 
+
** [[W4 Material File Format]]
{{InfoCard
+
** [[W4 Default Materials]]
|heading = Need some API?
+
* [[W4 Collision System]]
|content =
+
* [[W4 Component System]]
'''Только таблицы.''' Помодульное описание API (ссылки на эти статьи должны быть доступны из архитектурного описания модулей).
+
* [[W4 Hardware Abstraction Layer]]
}} 
+
* [[W4 Physics System]]
 
+
* [[W4 Graphical User Interface]]
{{InfoCard
 
|heading = Content Creation
 
|content =
 
'''Инструкции и/или требования.''' Описание процесса разработки ассетов (если это нам надо, или просто требования к создаваемым ассетам).
 
}} 
 
 
 
{{InfoCard
 
|heading = We have tools!
 
|content =
 
'''Технические описания.''' Инструменты (внешние относительно движка, но разработанные нами) доступные разработчику. Здесь же подразделом могут быть сторонние инструменты, которые удобно использовать с нашим движком. Но, возможно, крупные инструменты, такие как редакторы чего-то, придется вынести совсем наверх.
 
}} 
 
 
 
{{InfoCard
 
|heading = Sets of examples
 
|content =
 
'''Код и ссылки.''' Примеры сгруппированные по кейсам (и для каждого описанного модуля должна быть ссылка на такой пример).
 
}} 
 
 
 
{{InfoCard
 
|heading = Best practices
 
|content =
 
'''Свободный стиль.''' Гайды для продвинутых. В зависимости от содержания, можно объединить с Let's use it!
 
}} 
 
 
 
{{InfoCard
 
|heading = Just a few modules
 
|content =
 
'''Справочник.''' Структурированное описание всех программных модулей движка (в каждом ссылка на API и пример использования). В отличие от List of Objects здесь описываются программные модули, а не механики и объекты игрового мира (но если описания совпадают, будет редирект).
 
}} 
 
 
 
{{InfoCard
 
|heading = Videoguides
 
|content =
 
Если будут)
 
 
}}
 
}}
  
 
{{InfoCard
 
{{InfoCard
|heading = Games and Ads
+
|heading = Elements
|content =
+
|content = Special modules:
Портфолио работ на движке.
+
* [[W4 Math]] Needs a description
 +
* [[W4 Logger]] Needs a description
 +
* [[W4 Resources]] Needs a description
 +
* [[W4 Event System]] Needs a description
 +
* [[W4 Filesystem]] Needs a description
 
}}
 
}}
  
 
{{InfoCard
 
{{InfoCard
|heading = In development
+
|heading = Tools
 
|content =
 
|content =
'''Свободный стиль.''' Новые фичи в разработке (в отличие от новостей, здесь дается подробное описание того, что пока не доступно).
+
Tools for working with the W4 Engine:
 +
* [[W4 Mesh Converter]]
 
}}
 
}}
  
 
{{InfoCard
 
{{InfoCard
|heading = Terms and abbreviations
+
|heading = How-tos
 
|content =
 
|content =
Перечень терминов и определений. Пополняется при возникновении недопонимания.
+
How to work with the W4 Engine in simple words:
 +
* [[W4 Physics for Dummies]]
 +
* [[W4 Material Creation]]
 +
* [[W4 GUI Creation]]
 +
* [[W4 FSM]] Needs a description
 
}}
 
}}
 
}}
 
}}
  
 
__NOTOC__
 
__NOTOC__

Revision as of 13:13, 19 August 2020

Welcome to the W4 Engine wiki!

We are working on filling the wiki with documentation. The following articles are available for the time being:



General Concepts

System architecture and main solutions:

Elements

Special modules:

Tools

Tools for working with the W4 Engine:

How-tos

How to work with the W4 Engine in simple words: